POST api/programAgreement/flush
Request Information
URI Parameters
None.
Body Parameters
ProgramAgreementModelName | Description | Type | Additional information |
---|---|---|---|
ID | globally unique identifier |
None. |
|
Key | string |
None. |
|
DivisionTypeKey | string |
None. |
|
ProgramAgreementStateKey | string |
None. |
|
StartDate | date |
None. |
|
SignDate | date |
None. |
|
CancellationDate | date |
None. |
|
EstimatedGroupSize | integer |
None. |
|
EstimatedWholesale | decimal number |
None. |
|
EstimatedNumberOfClassrooms | integer |
None. |
|
PurchaseOrderTypeKey | string |
None. |
|
PurchaseOrderNumber | string |
None. |
|
AccountTaxClassificationKey | string |
None. |
|
AccountTaxClassificationExpirationDate | date |
None. |
|
DefaultStorefrontTypeKey | string |
None. |
|
HasSupplyOrder | boolean |
None. |
|
CollationFeeAmount | decimal number |
None. |
|
PrizeCostAmount | decimal number |
None. |
|
PrizeCostPercentage | decimal number |
None. |
|
SponsorSignature | string |
None. |
|
SponsorApproved | date |
None. |
|
SalesRepSignature | string |
None. |
|
SalesRepApproved | date |
None. |
|
SubmissionPending | date |
None. |
|
HasRuleViolations | boolean |
None. |
|
Created | date |
None. |
|
CreatedBy | integer |
None. |
|
Modified | date |
None. |
|
ModifiedBy | integer |
None. |
|
Version | Collection of byte |
None. |
|
MinimumDonationAmount | integer |
None. |
|
IsDonationsEnabled | boolean |
None. |
|
IsFullServiceEnabled | boolean |
None. |
|
Is59MinuteEnabled | boolean |
None. |
|
IsTuitionRewardsEnabled | boolean |
None. |
|
IsPaymentAppEnabled | boolean |
None. |
|
IsShippingToAccountAllowed | boolean |
None. |
|
PrizeCostPercentageStartDate | date |
None. |
|
PrizeCostPercentageEndDate | date |
None. |
|
FullServiceGiftFeeChargeTypeKey | string |
None. |
|
IsContinuousServiceAllowed | boolean |
None. |
|
ProgramAgreementNotes | Collection of ProgramAgreementNoteModel |
None. |
|
ProgramAgreementPartners | Collection of ProgramAgreementPartnerModel |
None. |
|
ProgramAgreementProductLines | Collection of ProgramAgreementProductLineModel |
None. |
|
ProductServicesSelections | Collection of ProductServicesSelectionModel |
None. |
Request Formats
application/json, text/json
Sample:
{ "id": "2ba3d052-90ed-4a92-b805-65fe22a2cd45", "key": "sample string 2", "divisionTypeKey": "20", "programAgreementStateKey": "D0", "startDate": "2021-02-27T00:00:00", "signDate": "2021-02-27T00:00:00", "cancellationDate": "2021-02-27T00:00:00", "estimatedGroupSize": 6, "estimatedWholesale": 7.0, "estimatedNumberOfClassrooms": 8, "purchaseOrderTypeKey": "PN", "purchaseOrderNumber": "sample string 10", "accountTaxClassificationKey": "0", "accountTaxClassificationExpirationDate": "2021-02-27T00:00:00", "defaultStorefrontTypeKey": "G", "hasSupplyOrder": true, "collationFeeAmount": 1.0, "prizeCostAmount": 1.0, "prizeCostPercentage": 1.0, "sponsorSignature": "sample string 14", "sponsorApproved": "2021-02-27T00:06:39.1694233-06:00", "salesRepSignature": "sample string 15", "salesRepApproved": "2021-02-27T00:06:39.1703999-06:00", "submissionPending": "2021-02-27T00:06:39.1703999-06:00", "hasRuleViolations": true, "created": "2021-02-27T00:06:39.1713765-06:00", "createdBy": 17, "modified": "2021-02-27T00:06:39.1713765-06:00", "modifiedBy": 1, "version": "QEA=", "minimumDonationAmount": 1, "isDonationsEnabled": true, "isFullServiceEnabled": true, "is59MinuteEnabled": true, "isTuitionRewardsEnabled": true, "isPaymentAppEnabled": true, "isShippingToAccountAllowed": true, "prizeCostPercentageStartDate": "2021-02-27T00:06:39.1743063-06:00", "prizeCostPercentageEndDate": "2021-02-27T00:06:39.1752829-06:00", "fullServiceGiftFeeChargeTypeKey": "sample string 24", "isContinuousServiceAllowed": true, "programAgreementNotes": [ { "$id": "2", "id": "84fcafb9-79ba-4405-b93d-9535928c11b9", "programAgreementID": "2ba3d052-90ed-4a92-b805-65fe22a2cd45", "programAgreementNoteTypeKey": "sample string 3", "content": "sample string 4", "created": "2021-02-27T00:06:39.1791893-06:00", "createdBy": 6, "modified": "2021-02-27T00:06:39.1791893-06:00", "modifiedBy": 1, "version": "QEA=", "programAgreement": { "$ref": "1" } } ], "programAgreementPartners": [ { "$id": "3", "id": "3042128c-849d-47e8-9134-35eca1ccd0f6", "programAgreementID": "2ba3d052-90ed-4a92-b805-65fe22a2cd45", "partnerContactID": "37d7ad6d-1d04-4e34-98bd-96842c2d53a4", "partnerFunctionKey": "AG", "created": "2021-02-27T00:06:39.1860255-06:00", "createdBy": 6, "modified": "2021-02-27T00:06:39.1860255-06:00", "modifiedBy": 1, "version": "QEA=", "partnerContact": { "$id": "4", "id": "37d7ad6d-1d04-4e34-98bd-96842c2d53a4", "addressKey": "sample string 2", "isMasterData": true, "name": "sample string 4", "emailAddress": "sample string 5", "created": "2021-02-27T00:06:39.1889553-06:00", "createdBy": 7, "modified": "2021-02-27T00:06:39.1889553-06:00", "modifiedBy": 1, "version": "QEA=", "partnerContactAddresses": [ { "$id": "5", "id": "61032a02-52c2-4b34-8c9d-d64c1119e372", "partnerContactID": "37d7ad6d-1d04-4e34-98bd-96842c2d53a4", "addressTypeKey": "sample string 3", "street": "sample string 4", "city": "sample string 5", "county": "sample string 6", "stateProvinceKey": "sample string 7", "postalCode": "sample string 8", "created": "2021-02-27T00:06:39.1918851-06:00", "createdBy": 10, "modified": "2021-02-27T00:06:39.1928617-06:00", "modifiedBy": 1, "version": "QEA=", "partnerContact": { "$ref": "4" } } ], "partnerContactPhones": [ { "$id": "6", "id": "487d49f5-56b8-419c-a5e4-5f9c1b29f3e5", "partnerContactID": "37d7ad6d-1d04-4e34-98bd-96842c2d53a4", "phoneTypeKey": "sample string 3", "number": "sample string 4", "extension": "sample string 5", "created": "2021-02-27T00:06:39.1987213-06:00", "createdBy": 7, "modified": "2021-02-27T00:06:39.1987213-06:00", "modifiedBy": 1, "version": "QEA=", "partnerContact": { "$ref": "4" } } ], "programAgreementPartners": [ { "$ref": "3" } ], "partners": [ { "$id": "7", "id": "bbd12fed-fe2b-40f1-9c8f-02cba5732b6f", "accountKey": "sample string 2", "partnerTypeCode": 3, "partnerContactID": "37d7ad6d-1d04-4e34-98bd-96842c2d53a4", "created": "2021-02-27T00:06:39.2045809-06:00", "createdBy": 6, "modified": "2021-02-27T00:06:39.2055575-06:00", "modifiedBy": 1, "version": "QEA=", "partnerContact": { "$ref": "4" }, "partnerAttributes": [ { "$id": "8", "id": "cddba8f6-8918-4a01-aa58-09e552eb7686", "partnerID": "bbd12fed-fe2b-40f1-9c8f-02cba5732b6f", "partnerAttributeTypeCode": 3, "value": "sample string 4", "created": "2021-02-27T00:06:39.2104405-06:00", "createdBy": 6, "modified": "2021-02-27T00:06:39.2114171-06:00", "modifiedBy": 1, "version": "QEA=", "partner": { "$ref": "7" } } ], "partnerRelationsAsChild": [ { "$id": "9", "id": "afcdee53-b51c-4b3e-87c3-be9aaad0ff9c", "parentPartnerID": "bbd12fed-fe2b-40f1-9c8f-02cba5732b6f", "childPartnerID": "bbd12fed-fe2b-40f1-9c8f-02cba5732b6f", "created": "2021-02-27T00:06:39.2163001-06:00", "createdBy": 5, "childPartner": { "$ref": "7" }, "parentPartner": { "$ref": "7" }, "modified": "2021-02-27T00:06:39.2211831-06:00" } ], "partnerRelationsAsParent": [ { "$ref": "9" } ] } ] }, "programAgreement": { "$ref": "1" } } ], "programAgreementProductLines": [ { "$id": "10", "id": "392ebd8f-7003-4b89-937a-496c05030ac6", "programAgreementID": "2ba3d052-90ed-4a92-b805-65fe22a2cd45", "brochureTypeKey": "sample string 3", "brochureGroupKey": "sample string 4", "brochureCodeKey": "sample string 5", "brochureMaterialKey": "sample string 6", "productLineMasterMaterialKey": "sample string 7", "productLineMasterMaterialDescription": "sample string 8", "productLineMaterialKey": "sample string 9", "productLineMaterialDescription": "sample string 10", "shippingLevelKey": "sample string 11", "priceCodeKey": "sample string 12", "taxOnPaperworkIndicator": "sample string 13", "profitLevelKey": "sample string 14", "created": "2021-02-27T00:06:39.2309491-06:00", "createdBy": 16, "modified": "2021-02-27T00:06:39.2309491-06:00", "modifiedBy": 1, "version": "QEA=", "programAgreement": { "$ref": "1" } } ], "productServicesSelections": [ null, { "$id": "11", "id": "d58e8921-0ec8-4f37-b08b-f657568cb3ca", "programAgreementID": "f7aace91-51b7-4535-b8a9-d46771ac572f", "prizeProgramKey": "sample string 3", "goalPrizeLevel": null, "goalPrizeChargeTypeKey": null, "prizePrePackKey": null, "collectionMethodKey": null, "aplusServiceTypeKey": null, "requestedDeliveryTypeKey": null, "requestedDeliveryDate": null, "lastFullDayDate": null, "donationQty1": null, "created": "0001-01-01T00:00:00", "createdBy": 0, "modified": null, "modifiedBy": null, "version": null, "programAgreement": null } ] }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.