GET api/{context}/partner/PledgeHistory/{text}

parameters:   ?page={page}&pageSize={pageSize}

Retrieve a Partner's pledge history (using their ID).

Request Information

ParameterDescriptionAdditional information
text
The ID of the partner for look-up.

Define this parameter in the request URI.

page
Optional page number.  If not included, page 1 will be returned.

Define this parameter in the request URI.

pageSize
Optional page size, limit of 100.  If not included, the default page size will be 25.

Define this parameter in the request URI.

Special Field Notes

Field NameNotes
NextPageLink
Contains the full URL necessary to retrieve the next page of records.
PageCount
The number of pages contained in the result set, based on the PageSize passed in the API request.
PreviousPageLink
Contains the full URL necessary to retrieve the previous page of records.
TotalCount
The total number of records contained in the result set.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "NextPageLink": "sample string 1",
  "PreviousPageLink": "sample string 2",
  "PageCount": 3,
  "TotalCount": 4,
  "Pledges": [
    {
      "ID": "5736c406-ec98-4864-ba87-269b91738d4b",
      "PartnerID": "sample string 1",
      "PledgeAmount": 1.0,
      "DatePledged": "2020-08-04T10:30:37.1096653-06:00",
      "AppealCode": "sample string 2",
      "StartDate": "2020-08-04T10:30:37.1096653-06:00",
      "DayToCharge": 1,
      "PledgeType": "sample string 3",
      "Frequency": "sample string 4",
      "Installments": 1,
      "PledgeProgramName": "sample string 5",
      "Active": true,
      "AutoPayment": true,
      "PaymentType": "sample string 8",
      "PaymentSubType": "sample string 9",
      "PaymentBank": "sample string 10",
      "PaymentNumber": "sample string 12",
      "PaymentExtraID": "sample string 13",
      "PaymentExpDate": "2020-08-04T10:30:37.1096653-06:00",
      "PaymentFirstName": "sample string 14",
      "PaymentMiddleName": "sample string 15",
      "PaymentLastName": "sample string 16",
      "PaymentAddress1": "sample string 17",
      "PaymentAddress2": "sample string 18",
      "PaymentCity": "sample string 19",
      "PaymentStateProvince": "sample string 20",
      "PaymentPostalCode": "sample string 21",
      "PaymentCountry": "sample string 22",
      "PaymentTokenID": "sample string 23",
      "PendingProfileUpdate": true
    },
    {
      "ID": "5736c406-ec98-4864-ba87-269b91738d4b",
      "PartnerID": "sample string 1",
      "PledgeAmount": 1.0,
      "DatePledged": "2020-08-04T10:30:37.1096653-06:00",
      "AppealCode": "sample string 2",
      "StartDate": "2020-08-04T10:30:37.1096653-06:00",
      "DayToCharge": 1,
      "PledgeType": "sample string 3",
      "Frequency": "sample string 4",
      "Installments": 1,
      "PledgeProgramName": "sample string 5",
      "Active": true,
      "AutoPayment": true,
      "PaymentType": "sample string 8",
      "PaymentSubType": "sample string 9",
      "PaymentBank": "sample string 10",
      "PaymentNumber": "sample string 12",
      "PaymentExtraID": "sample string 13",
      "PaymentExpDate": "2020-08-04T10:30:37.1096653-06:00",
      "PaymentFirstName": "sample string 14",
      "PaymentMiddleName": "sample string 15",
      "PaymentLastName": "sample string 16",
      "PaymentAddress1": "sample string 17",
      "PaymentAddress2": "sample string 18",
      "PaymentCity": "sample string 19",
      "PaymentStateProvince": "sample string 20",
      "PaymentPostalCode": "sample string 21",
      "PaymentCountry": "sample string 22",
      "PaymentTokenID": "sample string 23",
      "PendingProfileUpdate": true
    },
    {
      "ID": "5736c406-ec98-4864-ba87-269b91738d4b",
      "PartnerID": "sample string 1",
      "PledgeAmount": 1.0,
      "DatePledged": "2020-08-04T10:30:37.1096653-06:00",
      "AppealCode": "sample string 2",
      "StartDate": "2020-08-04T10:30:37.1096653-06:00",
      "DayToCharge": 1,
      "PledgeType": "sample string 3",
      "Frequency": "sample string 4",
      "Installments": 1,
      "PledgeProgramName": "sample string 5",
      "Active": true,
      "AutoPayment": true,
      "PaymentType": "sample string 8",
      "PaymentSubType": "sample string 9",
      "PaymentBank": "sample string 10",
      "PaymentNumber": "sample string 12",
      "PaymentExtraID": "sample string 13",
      "PaymentExpDate": "2020-08-04T10:30:37.1096653-06:00",
      "PaymentFirstName": "sample string 14",
      "PaymentMiddleName": "sample string 15",
      "PaymentLastName": "sample string 16",
      "PaymentAddress1": "sample string 17",
      "PaymentAddress2": "sample string 18",
      "PaymentCity": "sample string 19",
      "PaymentStateProvince": "sample string 20",
      "PaymentPostalCode": "sample string 21",
      "PaymentCountry": "sample string 22",
      "PaymentTokenID": "sample string 23",
      "PendingProfileUpdate": true
    }
  ]
}

application/xml, text/xml

Sample:
<PledgeHistoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDS.Web.WebApi.Models">
  <NextPageLink>sample string 1</NextPageLink>
  <PageCount>3</PageCount>
  <PreviousPageLink>sample string 2</PreviousPageLink>
  <TotalCount>4</TotalCount>
</PledgeHistoryModel>