POST api/programAgreement/flush

Request Information

URI Parameters

None.

Body Parameters

Name	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": "a2f1caeb-0e9c-43b7-acdc-bb54be599d47",
  "key": "sample string 2",
  "divisionTypeKey": "20",
  "programAgreementStateKey": "D0",
  "startDate": "2021-05-13T00:00:00",
  "signDate": "2021-05-13T00:00:00",
  "cancellationDate": "2021-05-13T00:00:00",
  "estimatedGroupSize": 6,
  "estimatedWholesale": 7.0,
  "estimatedNumberOfClassrooms": 8,
  "purchaseOrderTypeKey": "PN",
  "purchaseOrderNumber": "sample string 10",
  "accountTaxClassificationKey": "0",
  "accountTaxClassificationExpirationDate": "2021-05-13T00:00:00",
  "defaultStorefrontTypeKey": "G",
  "hasSupplyOrder": true,
  "collationFeeAmount": 1.0,
  "prizeCostAmount": 1.0,
  "prizeCostPercentage": 1.0,
  "sponsorSignature": "sample string 14",
  "sponsorApproved": "2021-05-13T00:25:21.957693-05:00",
  "salesRepSignature": "sample string 15",
  "salesRepApproved": "2021-05-13T00:25:21.957693-05:00",
  "submissionPending": "2021-05-13T00:25:21.957693-05:00",
  "hasRuleViolations": true,
  "created": "2021-05-13T00:25:21.957693-05:00",
  "createdBy": 17,
  "modified": "2021-05-13T00:25:21.957693-05:00",
  "modifiedBy": 1,
  "version": "QEA=",
  "minimumDonationAmount": 1,
  "isDonationsEnabled": true,
  "isFullServiceEnabled": true,
  "is59MinuteEnabled": true,
  "isTuitionRewardsEnabled": true,
  "isPaymentAppEnabled": true,
  "isShippingToAccountAllowed": true,
  "prizeCostPercentageStartDate": "2021-05-13T00:25:21.957693-05:00",
  "prizeCostPercentageEndDate": "2021-05-13T00:25:21.957693-05:00",
  "fullServiceGiftFeeChargeTypeKey": "sample string 24",
  "isContinuousServiceAllowed": true,
  "programAgreementNotes": [
    {
      "$id": "2",
      "id": "0f56fa3a-93a9-4c89-b335-d411f11e5b77",
      "programAgreementID": "a2f1caeb-0e9c-43b7-acdc-bb54be599d47",
      "programAgreementNoteTypeKey": "sample string 3",
      "content": "sample string 4",
      "created": "2021-05-13T00:25:21.957693-05:00",
      "createdBy": 6,
      "modified": "2021-05-13T00:25:21.957693-05:00",
      "modifiedBy": 1,
      "version": "QEA=",
      "programAgreement": {
        "$ref": "1"
      }
    }
  ],
  "programAgreementPartners": [
    {
      "$id": "3",
      "id": "16ea96b2-a9b5-464b-9b9b-9246ab2f3717",
      "programAgreementID": "a2f1caeb-0e9c-43b7-acdc-bb54be599d47",
      "partnerContactID": "042d55a0-90d5-4a79-a12e-5ccc695f5dad",
      "partnerFunctionKey": "AG",
      "created": "2021-05-13T00:25:21.957693-05:00",
      "createdBy": 6,
      "modified": "2021-05-13T00:25:21.957693-05:00",
      "modifiedBy": 1,
      "version": "QEA=",
      "partnerContact": {
        "$id": "4",
        "id": "042d55a0-90d5-4a79-a12e-5ccc695f5dad",
        "addressKey": "sample string 2",
        "isMasterData": true,
        "name": "sample string 4",
        "emailAddress": "sample string 5",
        "created": "2021-05-13T00:25:21.957693-05:00",
        "createdBy": 7,
        "modified": "2021-05-13T00:25:21.957693-05:00",
        "modifiedBy": 1,
        "version": "QEA=",
        "partnerContactAddresses": [
          {
            "$id": "5",
            "id": "36edac76-5948-4fff-92f7-6083cbe70031",
            "partnerContactID": "042d55a0-90d5-4a79-a12e-5ccc695f5dad",
            "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-05-13T00:25:21.957693-05:00",
            "createdBy": 10,
            "modified": "2021-05-13T00:25:21.957693-05:00",
            "modifiedBy": 1,
            "version": "QEA=",
            "partnerContact": {
              "$ref": "4"
            }
          }
        ],
        "partnerContactPhones": [
          {
            "$id": "6",
            "id": "4aea9a8c-c60d-4f25-b60e-79dc98bdbe86",
            "partnerContactID": "042d55a0-90d5-4a79-a12e-5ccc695f5dad",
            "phoneTypeKey": "sample string 3",
            "number": "sample string 4",
            "extension": "sample string 5",
            "created": "2021-05-13T00:25:21.957693-05:00",
            "createdBy": 7,
            "modified": "2021-05-13T00:25:21.957693-05:00",
            "modifiedBy": 1,
            "version": "QEA=",
            "partnerContact": {
              "$ref": "4"
            }
          }
        ],
        "programAgreementPartners": [
          {
            "$ref": "3"
          }
        ],
        "partners": [
          {
            "$id": "7",
            "id": "cfc64339-dd3e-4533-8a10-dd70ce3c77a8",
            "accountKey": "sample string 2",
            "partnerTypeCode": 3,
            "partnerContactID": "042d55a0-90d5-4a79-a12e-5ccc695f5dad",
            "created": "2021-05-13T00:25:21.957693-05:00",
            "createdBy": 6,
            "modified": "2021-05-13T00:25:21.957693-05:00",
            "modifiedBy": 1,
            "version": "QEA=",
            "partnerContact": {
              "$ref": "4"
            },
            "partnerAttributes": [
              {
                "$id": "8",
                "id": "bde417fa-38b3-4edf-ae38-00baaf89c912",
                "partnerID": "cfc64339-dd3e-4533-8a10-dd70ce3c77a8",
                "partnerAttributeTypeCode": 3,
                "value": "sample string 4",
                "created": "2021-05-13T00:25:21.957693-05:00",
                "createdBy": 6,
                "modified": "2021-05-13T00:25:21.957693-05:00",
                "modifiedBy": 1,
                "version": "QEA=",
                "partner": {
                  "$ref": "7"
                }
              }
            ],
            "partnerRelationsAsChild": [
              {
                "$id": "9",
                "id": "09303fa2-629b-400b-b617-f4e5de18e45a",
                "parentPartnerID": "cfc64339-dd3e-4533-8a10-dd70ce3c77a8",
                "childPartnerID": "cfc64339-dd3e-4533-8a10-dd70ce3c77a8",
                "created": "2021-05-13T00:25:21.957693-05:00",
                "createdBy": 5,
                "childPartner": {
                  "$ref": "7"
                },
                "parentPartner": {
                  "$ref": "7"
                },
                "modified": "2021-05-13T00:25:21.957693-05:00"
              }
            ],
            "partnerRelationsAsParent": [
              {
                "$ref": "9"
              }
            ]
          }
        ]
      },
      "programAgreement": {
        "$ref": "1"
      }
    }
  ],
  "programAgreementProductLines": [
    {
      "$id": "10",
      "id": "233691f5-e8b9-402f-a005-2f8d71efcfa2",
      "programAgreementID": "a2f1caeb-0e9c-43b7-acdc-bb54be599d47",
      "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-05-13T00:25:21.957693-05:00",
      "createdBy": 16,
      "modified": "2021-05-13T00:25:21.957693-05:00",
      "modifiedBy": 1,
      "version": "QEA=",
      "programAgreement": {
        "$ref": "1"
      }
    }
  ],
  "productServicesSelections": [
    null,
    {
      "$id": "11",
      "id": "fc67ce8b-7863-42dc-9a8e-1dc35b01a194",
      "programAgreementID": "b797dd2e-a007-4870-bcf4-a7bc826e9e74",
      "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

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.