GET api/{context}/pledge/GetByPartner/{text}

Retrieve all pledges for a particular partner by using their ID as the look-up value.

Request Information

ParameterDescriptionAdditional information
text 

                
                            
Define this parameter in the request URI.

                		
            

    


        
Response Information
 
        
Response body formats




        
application/json, text/json

        

            Sample:

[
  {
    "ID": "f35dab60-52b1-4c47-8836-88db888b9011",
    "PartnerID": "sample string 1",
    "PledgeAmount": 1.0,
    "DatePledged": "2024-04-24T03:28:36.5911451-06:00",
    "AppealCode": "sample string 2",
    "StartDate": "2024-04-24T03:28:36.5911451-06:00",
    "DayToCharge": 1,
    "PledgeType": "sample string 3",
    "Frequency": "sample string 4",
    "Installments": 1,
    "PledgeProgramName": "sample string 5",
    "BatchType": "sample string 6",
    "Active": true,
    "AutoPayment": true,
    "PaymentType": "sample string 9",
    "PaymentSubType": "sample string 10",
    "PaymentBank": "sample string 11",
    "PaymentNumber": "sample string 13",
    "PaymentExtraID": "sample string 14",
    "PaymentExpDate": "2024-04-24T03:28:36.5911451-06:00",
    "PaymentFirstName": "sample string 15",
    "PaymentMiddleName": "sample string 16",
    "PaymentLastName": "sample string 17",
    "PaymentAddress1": "sample string 18",
    "PaymentAddress2": "sample string 19",
    "PaymentCity": "sample string 20",
    "PaymentStateProvince": "sample string 21",
    "PaymentPostalCode": "sample string 22",
    "PaymentCountry": "sample string 23",
    "PaymentTokenID": "sample string 24",
    "PendingProfileUpdate": true,
    "Note": "sample string 26",
    "Channel": "sample string 27"
  },
  {
    "ID": "f35dab60-52b1-4c47-8836-88db888b9011",
    "PartnerID": "sample string 1",
    "PledgeAmount": 1.0,
    "DatePledged": "2024-04-24T03:28:36.5911451-06:00",
    "AppealCode": "sample string 2",
    "StartDate": "2024-04-24T03:28:36.5911451-06:00",
    "DayToCharge": 1,
    "PledgeType": "sample string 3",
    "Frequency": "sample string 4",
    "Installments": 1,
    "PledgeProgramName": "sample string 5",
    "BatchType": "sample string 6",
    "Active": true,
    "AutoPayment": true,
    "PaymentType": "sample string 9",
    "PaymentSubType": "sample string 10",
    "PaymentBank": "sample string 11",
    "PaymentNumber": "sample string 13",
    "PaymentExtraID": "sample string 14",
    "PaymentExpDate": "2024-04-24T03:28:36.5911451-06:00",
    "PaymentFirstName": "sample string 15",
    "PaymentMiddleName": "sample string 16",
    "PaymentLastName": "sample string 17",
    "PaymentAddress1": "sample string 18",
    "PaymentAddress2": "sample string 19",
    "PaymentCity": "sample string 20",
    "PaymentStateProvince": "sample string 21",
    "PaymentPostalCode": "sample string 22",
    "PaymentCountry": "sample string 23",
    "PaymentTokenID": "sample string 24",
    "PendingProfileUpdate": true,
    "Note": "sample string 26",
    "Channel": "sample string 27"
  },
  {
    "ID": "f35dab60-52b1-4c47-8836-88db888b9011",
    "PartnerID": "sample string 1",
    "PledgeAmount": 1.0,
    "DatePledged": "2024-04-24T03:28:36.5911451-06:00",
    "AppealCode": "sample string 2",
    "StartDate": "2024-04-24T03:28:36.5911451-06:00",
    "DayToCharge": 1,
    "PledgeType": "sample string 3",
    "Frequency": "sample string 4",
    "Installments": 1,
    "PledgeProgramName": "sample string 5",
    "BatchType": "sample string 6",
    "Active": true,
    "AutoPayment": true,
    "PaymentType": "sample string 9",
    "PaymentSubType": "sample string 10",
    "PaymentBank": "sample string 11",
    "PaymentNumber": "sample string 13",
    "PaymentExtraID": "sample string 14",
    "PaymentExpDate": "2024-04-24T03:28:36.5911451-06:00",
    "PaymentFirstName": "sample string 15",
    "PaymentMiddleName": "sample string 16",
    "PaymentLastName": "sample string 17",
    "PaymentAddress1": "sample string 18",
    "PaymentAddress2": "sample string 19",
    "PaymentCity": "sample string 20",
    "PaymentStateProvince": "sample string 21",
    "PaymentPostalCode": "sample string 22",
    "PaymentCountry": "sample string 23",
    "PaymentTokenID": "sample string 24",
    "PendingProfileUpdate": true,
    "Note": "sample string 26",
    "Channel": "sample string 27"
  }
]


        

        
application/xml, text/xml

        

            Sample:

<ArrayOfPledgeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDS.Web.WebApi.Models">
  <PledgeModel>
    <Active>true</Active>
    <AppealCode>sample string 2</AppealCode>
    <AutoPayment>true</AutoPayment>
    <BatchType>sample string 6</BatchType>
    <Channel>sample string 27</Channel>
    <DatePledged>2024-04-24T03:28:36.5911451-06:00</DatePledged>
    <DayToCharge>1</DayToCharge>
    <Frequency>sample string 4</Frequency>
    <ID>f35dab60-52b1-4c47-8836-88db888b9011</ID>
    <Installments>1</Installments>
    <Note>sample string 26</Note>
    <PartnerID>sample string 1</PartnerID>
    <PaymentAddress1>sample string 18</PaymentAddress1>
    <PaymentAddress2>sample string 19</PaymentAddress2>
    <PaymentBank>sample string 11</PaymentBank>
    <PaymentCity>sample string 20</PaymentCity>
    <PaymentCountry>sample string 23</PaymentCountry>
    <PaymentExpDate>2024-04-24T03:28:36.5911451-06:00</PaymentExpDate>
    <PaymentExtraID>sample string 14</PaymentExtraID>
    <PaymentFirstName>sample string 15</PaymentFirstName>
    <PaymentLastName>sample string 17</PaymentLastName>
    <PaymentMiddleName>sample string 16</PaymentMiddleName>
    <PaymentNumber>sample string 13</PaymentNumber>
    <PaymentPostalCode>sample string 22</PaymentPostalCode>
    <PaymentStateProvince>sample string 21</PaymentStateProvince>
    <PaymentSubType>sample string 10</PaymentSubType>
    <PaymentTokenID>sample string 24</PaymentTokenID>
    <PaymentType>sample string 9</PaymentType>
    <PendingProfileUpdate>true</PendingProfileUpdate>
    <PledgeAmount>1</PledgeAmount>
    <PledgeProgramName>sample string 5</PledgeProgramName>
    <PledgeType>sample string 3</PledgeType>
    <StartDate>2024-04-24T03:28:36.5911451-06:00</StartDate>
    <UnmaskedPaymentNumber>sample string 13</UnmaskedPaymentNumber>
  </PledgeModel>
  <PledgeModel>
    <Active>true</Active>
    <AppealCode>sample string 2</AppealCode>
    <AutoPayment>true</AutoPayment>
    <BatchType>sample string 6</BatchType>
    <Channel>sample string 27</Channel>
    <DatePledged>2024-04-24T03:28:36.5911451-06:00</DatePledged>
    <DayToCharge>1</DayToCharge>
    <Frequency>sample string 4</Frequency>
    <ID>f35dab60-52b1-4c47-8836-88db888b9011</ID>
    <Installments>1</Installments>
    <Note>sample string 26</Note>
    <PartnerID>sample string 1</PartnerID>
    <PaymentAddress1>sample string 18</PaymentAddress1>
    <PaymentAddress2>sample string 19</PaymentAddress2>
    <PaymentBank>sample string 11</PaymentBank>
    <PaymentCity>sample string 20</PaymentCity>
    <PaymentCountry>sample string 23</PaymentCountry>
    <PaymentExpDate>2024-04-24T03:28:36.5911451-06:00</PaymentExpDate>
    <PaymentExtraID>sample string 14</PaymentExtraID>
    <PaymentFirstName>sample string 15</PaymentFirstName>
    <PaymentLastName>sample string 17</PaymentLastName>
    <PaymentMiddleName>sample string 16</PaymentMiddleName>
    <PaymentNumber>sample string 13</PaymentNumber>
    <PaymentPostalCode>sample string 22</PaymentPostalCode>
    <PaymentStateProvince>sample string 21</PaymentStateProvince>
    <PaymentSubType>sample string 10</PaymentSubType>
    <PaymentTokenID>sample string 24</PaymentTokenID>
    <PaymentType>sample string 9</PaymentType>
    <PendingProfileUpdate>true</PendingProfileUpdate>
    <PledgeAmount>1</PledgeAmount>
    <PledgeProgramName>sample string 5</PledgeProgramName>
    <PledgeType>sample string 3</PledgeType>
    <StartDate>2024-04-24T03:28:36.5911451-06:00</StartDate>
    <UnmaskedPaymentNumber>sample string 13</UnmaskedPaymentNumber>
  </PledgeModel>
  <PledgeModel>
    <Active>true</Active>
    <AppealCode>sample string 2</AppealCode>
    <AutoPayment>true</AutoPayment>
    <BatchType>sample string 6</BatchType>
    <Channel>sample string 27</Channel>
    <DatePledged>2024-04-24T03:28:36.5911451-06:00</DatePledged>
    <DayToCharge>1</DayToCharge>
    <Frequency>sample string 4</Frequency>
    <ID>f35dab60-52b1-4c47-8836-88db888b9011</ID>
    <Installments>1</Installments>
    <Note>sample string 26</Note>
    <PartnerID>sample string 1</PartnerID>
    <PaymentAddress1>sample string 18</PaymentAddress1>
    <PaymentAddress2>sample string 19</PaymentAddress2>
    <PaymentBank>sample string 11</PaymentBank>
    <PaymentCity>sample string 20</PaymentCity>
    <PaymentCountry>sample string 23</PaymentCountry>
    <PaymentExpDate>2024-04-24T03:28:36.5911451-06:00</PaymentExpDate>
    <PaymentExtraID>sample string 14</PaymentExtraID>
    <PaymentFirstName>sample string 15</PaymentFirstName>
    <PaymentLastName>sample string 17</PaymentLastName>
    <PaymentMiddleName>sample string 16</PaymentMiddleName>
    <PaymentNumber>sample string 13</PaymentNumber>
    <PaymentPostalCode>sample string 22</PaymentPostalCode>
    <PaymentStateProvince>sample string 21</PaymentStateProvince>
    <PaymentSubType>sample string 10</PaymentSubType>
    <PaymentTokenID>sample string 24</PaymentTokenID>
    <PaymentType>sample string 9</PaymentType>
    <PendingProfileUpdate>true</PendingProfileUpdate>
    <PledgeAmount>1</PledgeAmount>
    <PledgeProgramName>sample string 5</PledgeProgramName>
    <PledgeType>sample string 3</PledgeType>
    <StartDate>2024-04-24T03:28:36.5911451-06:00</StartDate>
    <UnmaskedPaymentNumber>sample string 13</UnmaskedPaymentNumber>
  </PledgeModel>
</ArrayOfPledgeModel>