POST api/programAgreement/cancel

Request Information

URI Parameters

None.

Body Parameters

ProgramAgreementModel
NameDescriptionTypeAdditional 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": "ecc69e55-d319-4367-b3f9-98c22955e241",
  "key": "sample string 2",
  "divisionTypeKey": "20",
  "programAgreementStateKey": "D0",
  "startDate": "2019-12-09T00:00:00",
  "signDate": "2019-12-09T00:00:00",
  "cancellationDate": "2019-12-09T00:00:00",
  "estimatedGroupSize": 6,
  "estimatedWholesale": 7.0,
  "estimatedNumberOfClassrooms": 8,
  "purchaseOrderTypeKey": "PN",
  "purchaseOrderNumber": "sample string 10",
  "accountTaxClassificationKey": "0",
  "accountTaxClassificationExpirationDate": "2019-12-09T00:00:00",
  "defaultStorefrontTypeKey": "G",
  "hasSupplyOrder": true,
  "collationFeeAmount": 1.0,
  "prizeCostAmount": 1.0,
  "prizeCostPercentage": 1.0,
  "sponsorSignature": "sample string 14",
  "sponsorApproved": "2019-12-09T09:00:08.3878119-06:00",
  "salesRepSignature": "sample string 15",
  "salesRepApproved": "2019-12-09T09:00:08.3878119-06:00",
  "submissionPending": "2019-12-09T09:00:08.3878119-06:00",
  "hasRuleViolations": true,
  "created": "2019-12-09T09:00:08.3878119-06:00",
  "createdBy": 17,
  "modified": "2019-12-09T09:00:08.3878119-06:00",
  "modifiedBy": 1,
  "version": "QEA=",
  "minimumDonationAmount": 1,
  "isDonationsEnabled": true,
  "isFullServiceEnabled": true,
  "is59MinuteEnabled": true,
  "isTuitionRewardsEnabled": true,
  "isPaymentAppEnabled": true,
  "isShippingToAccountAllowed": true,
  "prizeCostPercentageStartDate": "2019-12-09T09:00:08.3878119-06:00",
  "prizeCostPercentageEndDate": "2019-12-09T09:00:08.3878119-06:00",
  "fullServiceGiftFeeChargeTypeKey": "sample string 24",
  "isContinuousServiceAllowed": true,
  "programAgreementNotes": [
    {
      "$id": "2",
      "id": "24bc3744-98e7-47ac-bed7-8634a504b783",
      "programAgreementID": "ecc69e55-d319-4367-b3f9-98c22955e241",
      "programAgreementNoteTypeKey": "sample string 3",
      "content": "sample string 4",
      "created": "2019-12-09T09:00:08.3878119-06:00",
      "createdBy": 6,
      "modified": "2019-12-09T09:00:08.3878119-06:00",
      "modifiedBy": 1,
      "version": "QEA=",
      "programAgreement": {
        "$ref": "1"
      }
    }
  ],
  "programAgreementPartners": [
    {
      "$id": "3",
      "id": "acee6c67-e4d4-41cb-8e2b-8a5cbe2e319a",
      "programAgreementID": "ecc69e55-d319-4367-b3f9-98c22955e241",
      "partnerContactID": "30d94e2a-933d-4c27-a719-fe37cbeac92e",
      "partnerFunctionKey": "AG",
      "created": "2019-12-09T09:00:08.3878119-06:00",
      "createdBy": 6,
      "modified": "2019-12-09T09:00:08.3878119-06:00",
      "modifiedBy": 1,
      "version": "QEA=",
      "partnerContact": {
        "$id": "4",
        "id": "30d94e2a-933d-4c27-a719-fe37cbeac92e",
        "addressKey": "sample string 2",
        "isMasterData": true,
        "name": "sample string 4",
        "emailAddress": "sample string 5",
        "created": "2019-12-09T09:00:08.3878119-06:00",
        "createdBy": 7,
        "modified": "2019-12-09T09:00:08.3878119-06:00",
        "modifiedBy": 1,
        "version": "QEA=",
        "partnerContactAddresses": [
          {
            "$id": "5",
            "id": "17ca90d8-f9b6-498b-b067-11aa2fe6cb60",
            "partnerContactID": "30d94e2a-933d-4c27-a719-fe37cbeac92e",
            "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": "2019-12-09T09:00:08.3878119-06:00",
            "createdBy": 10,
            "modified": "2019-12-09T09:00:08.3878119-06:00",
            "modifiedBy": 1,
            "version": "QEA=",
            "partnerContact": {
              "$ref": "4"
            }
          }
        ],
        "partnerContactPhones": [
          {
            "$id": "6",
            "id": "042c3443-673a-491f-97e9-016b0cac964e",
            "partnerContactID": "30d94e2a-933d-4c27-a719-fe37cbeac92e",
            "phoneTypeKey": "sample string 3",
            "number": "sample string 4",
            "extension": "sample string 5",
            "created": "2019-12-09T09:00:08.3878119-06:00",
            "createdBy": 7,
            "modified": "2019-12-09T09:00:08.3878119-06:00",
            "modifiedBy": 1,
            "version": "QEA=",
            "partnerContact": {
              "$ref": "4"
            }
          }
        ],
        "programAgreementPartners": [
          {
            "$ref": "3"
          }
        ],
        "partners": [
          {
            "$id": "7",
            "id": "f2825554-1a4e-4de3-a78e-9fbb1610b5b5",
            "accountKey": "sample string 2",
            "partnerTypeCode": 3,
            "partnerContactID": "30d94e2a-933d-4c27-a719-fe37cbeac92e",
            "created": "2019-12-09T09:00:08.3878119-06:00",
            "createdBy": 6,
            "modified": "2019-12-09T09:00:08.3878119-06:00",
            "modifiedBy": 1,
            "version": "QEA=",
            "partnerContact": {
              "$ref": "4"
            },
            "partnerAttributes": [
              {
                "$id": "8",
                "id": "c12a6226-327c-4c58-8432-690bbf970c07",
                "partnerID": "f2825554-1a4e-4de3-a78e-9fbb1610b5b5",
                "partnerAttributeTypeCode": 3,
                "value": "sample string 4",
                "created": "2019-12-09T09:00:08.3878119-06:00",
                "createdBy": 6,
                "modified": "2019-12-09T09:00:08.3878119-06:00",
                "modifiedBy": 1,
                "version": "QEA=",
                "partner": {
                  "$ref": "7"
                }
              }
            ],
            "partnerRelationsAsChild": [
              {
                "$id": "9",
                "id": "d05b9d6b-f729-4361-9140-66aee7da5c60",
                "parentPartnerID": "f2825554-1a4e-4de3-a78e-9fbb1610b5b5",
                "childPartnerID": "f2825554-1a4e-4de3-a78e-9fbb1610b5b5",
                "created": "2019-12-09T09:00:08.3878119-06:00",
                "createdBy": 5,
                "childPartner": {
                  "$ref": "7"
                },
                "parentPartner": {
                  "$ref": "7"
                },
                "modified": "2019-12-09T09:00:08.3878119-06:00"
              }
            ],
            "partnerRelationsAsParent": [
              {
                "$ref": "9"
              }
            ]
          }
        ]
      },
      "programAgreement": {
        "$ref": "1"
      }
    }
  ],
  "programAgreementProductLines": [
    {
      "$id": "10",
      "id": "ff4388ba-02f6-4acd-b9f0-b2ed2731a667",
      "programAgreementID": "ecc69e55-d319-4367-b3f9-98c22955e241",
      "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": "2019-12-09T09:00:08.3878119-06:00",
      "createdBy": 16,
      "modified": "2019-12-09T09:00:08.3878119-06:00",
      "modifiedBy": 1,
      "version": "QEA=",
      "programAgreement": {
        "$ref": "1"
      }
    }
  ],
  "productServicesSelections": [
    null,
    {
      "$id": "11",
      "id": "67302590-98ff-47c0-9642-73a0d1bab654",
      "programAgreementID": "7ab3bb3a-192e-4da9-843e-09c9489c6d92",
      "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.