Api Web Service

Api

Click here for a complete list of operations.

GetPledges

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v/2/Api.asmx HTTP/1.1
Host: api.charityengine.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.bisglobal.net/GetPledges"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPledges xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <ContactType_Id>int</ContactType_Id>
        <OrganizationType_Id>int</OrganizationType_Id>
        <Pledge_Id>long</Pledge_Id>
        <IsActive>boolean</IsActive>
        <Type_Id>int</Type_Id>
        <Category_Id>int</Category_Id>
        <PaymentMethod_Id>int</PaymentMethod_Id>
        <PledgeStatus_Id>int</PledgeStatus_Id>
        <Contact_Id>long</Contact_Id>
        <Amount_From>double</Amount_From>
        <Amount_To>double</Amount_To>
        <AmountPaid_From>double</AmountPaid_From>
        <AmountPaid_To>double</AmountPaid_To>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <EmailAddress>string</EmailAddress>
        <AddressCity>string</AddressCity>
        <AddressStateProvince_Id>int</AddressStateProvince_Id>
        <AddressPostalCode>string</AddressPostalCode>
        <AddressCountry_Id>int</AddressCountry_Id>
        <GeneralLedgerCode_Id>long</GeneralLedgerCode_Id>
        <Fund_Id>long</Fund_Id>
        <CampaignInitiative_Id>long</CampaignInitiative_Id>
        <ResponseChannel_Id>long</ResponseChannel_Id>
        <Tribute_Id>long</Tribute_Id>
        <Event_Id>long</Event_Id>
        <GrassrootsEvent_Id>long</GrassrootsEvent_Id>
        <DateCreated_From>dateTime</DateCreated_From>
        <DateCreated_To>dateTime</DateCreated_To>
        <DateModified_From>dateTime</DateModified_From>
        <DateModified_To>dateTime</DateModified_To>
      </queryParameters>
    </GetPledges>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetPledgesResponse xmlns="https://api.bisglobal.net/">
      <GetPledgesResult>
        <AuthenticationContext_Id>long</AuthenticationContext_Id>
        <Pledges>
          <PledgeRecord>
            <Pledge_Id>long</Pledge_Id>
            <IsActive>boolean</IsActive>
            <Type_Id>int</Type_Id>
            <Category_Id>int</Category_Id>
            <PaymentMethod_Id>int</PaymentMethod_Id>
            <PledgeStatus_Id>int</PledgeStatus_Id>
            <PledgeCancelUser_Id>int</PledgeCancelUser_Id>
            <Contact_Id>long</Contact_Id>
            <Amount>double</Amount>
            <AmountPaid>double</AmountPaid>
            <CurrencySymbol>string</CurrencySymbol>
            <EmailAddress>string</EmailAddress>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <AddressStreet1>string</AddressStreet1>
            <AddressStreet2>string</AddressStreet2>
            <AddressCity>string</AddressCity>
            <AddressStateProvice_Id>int</AddressStateProvice_Id>
            <AddressPostalCode>string</AddressPostalCode>
            <AddressCountry_Id>int</AddressCountry_Id>
            <CreditCardNumberLastFour>string</CreditCardNumberLastFour>
            <AchAccountNumberLastFour>string</AchAccountNumberLastFour>
            <Solicitor_Contact_Id>long</Solicitor_Contact_Id>
            <GeneralLedgerCode_Id>long</GeneralLedgerCode_Id>
            <Fund_Id>long</Fund_Id>
            <Campaign_Id>long</Campaign_Id>
            <ResponseChannel_Id>long</ResponseChannel_Id>
            <Tribute_Id>long</Tribute_Id>
            <Event_Id>long</Event_Id>
            <GrassrootsEvent_Id>long</GrassrootsEvent_Id>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
          </PledgeRecord>
          <PledgeRecord>
            <Pledge_Id>long</Pledge_Id>
            <IsActive>boolean</IsActive>
            <Type_Id>int</Type_Id>
            <Category_Id>int</Category_Id>
            <PaymentMethod_Id>int</PaymentMethod_Id>
            <PledgeStatus_Id>int</PledgeStatus_Id>
            <PledgeCancelUser_Id>int</PledgeCancelUser_Id>
            <Contact_Id>long</Contact_Id>
            <Amount>double</Amount>
            <AmountPaid>double</AmountPaid>
            <CurrencySymbol>string</CurrencySymbol>
            <EmailAddress>string</EmailAddress>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <AddressStreet1>string</AddressStreet1>
            <AddressStreet2>string</AddressStreet2>
            <AddressCity>string</AddressCity>
            <AddressStateProvice_Id>int</AddressStateProvice_Id>
            <AddressPostalCode>string</AddressPostalCode>
            <AddressCountry_Id>int</AddressCountry_Id>
            <CreditCardNumberLastFour>string</CreditCardNumberLastFour>
            <AchAccountNumberLastFour>string</AchAccountNumberLastFour>
            <Solicitor_Contact_Id>long</Solicitor_Contact_Id>
            <GeneralLedgerCode_Id>long</GeneralLedgerCode_Id>
            <Fund_Id>long</Fund_Id>
            <Campaign_Id>long</Campaign_Id>
            <ResponseChannel_Id>long</ResponseChannel_Id>
            <Tribute_Id>long</Tribute_Id>
            <Event_Id>long</Event_Id>
            <GrassrootsEvent_Id>long</GrassrootsEvent_Id>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
          </PledgeRecord>
        </Pledges>
      </GetPledgesResult>
    </GetPledgesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v/2/Api.asmx HTTP/1.1
Host: api.charityengine.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetPledges xmlns="https://api.bisglobal.net/">
      <credentials>
        <Username>string</Username>
        <Password>string</Password>
        <AuthenticationToken>string</AuthenticationToken>
        <AuthenticationType>WebServiceUser or CharityEngineAdminUser or Contact</AuthenticationType>
      </credentials>
      <queryParameters>
        <ContactType_Id>int</ContactType_Id>
        <OrganizationType_Id>int</OrganizationType_Id>
        <Pledge_Id>long</Pledge_Id>
        <IsActive>boolean</IsActive>
        <Type_Id>int</Type_Id>
        <Category_Id>int</Category_Id>
        <PaymentMethod_Id>int</PaymentMethod_Id>
        <PledgeStatus_Id>int</PledgeStatus_Id>
        <Contact_Id>long</Contact_Id>
        <Amount_From>double</Amount_From>
        <Amount_To>double</Amount_To>
        <AmountPaid_From>double</AmountPaid_From>
        <AmountPaid_To>double</AmountPaid_To>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <EmailAddress>string</EmailAddress>
        <AddressCity>string</AddressCity>
        <AddressStateProvince_Id>int</AddressStateProvince_Id>
        <AddressPostalCode>string</AddressPostalCode>
        <AddressCountry_Id>int</AddressCountry_Id>
        <GeneralLedgerCode_Id>long</GeneralLedgerCode_Id>
        <Fund_Id>long</Fund_Id>
        <CampaignInitiative_Id>long</CampaignInitiative_Id>
        <ResponseChannel_Id>long</ResponseChannel_Id>
        <Tribute_Id>long</Tribute_Id>
        <Event_Id>long</Event_Id>
        <GrassrootsEvent_Id>long</GrassrootsEvent_Id>
        <DateCreated_From>dateTime</DateCreated_From>
        <DateCreated_To>dateTime</DateCreated_To>
        <DateModified_From>dateTime</DateModified_From>
        <DateModified_To>dateTime</DateModified_To>
      </queryParameters>
    </GetPledges>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetPledgesResponse xmlns="https://api.bisglobal.net/">
      <GetPledgesResult>
        <AuthenticationContext_Id>long</AuthenticationContext_Id>
        <Pledges>
          <PledgeRecord>
            <Pledge_Id>long</Pledge_Id>
            <IsActive>boolean</IsActive>
            <Type_Id>int</Type_Id>
            <Category_Id>int</Category_Id>
            <PaymentMethod_Id>int</PaymentMethod_Id>
            <PledgeStatus_Id>int</PledgeStatus_Id>
            <PledgeCancelUser_Id>int</PledgeCancelUser_Id>
            <Contact_Id>long</Contact_Id>
            <Amount>double</Amount>
            <AmountPaid>double</AmountPaid>
            <CurrencySymbol>string</CurrencySymbol>
            <EmailAddress>string</EmailAddress>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <AddressStreet1>string</AddressStreet1>
            <AddressStreet2>string</AddressStreet2>
            <AddressCity>string</AddressCity>
            <AddressStateProvice_Id>int</AddressStateProvice_Id>
            <AddressPostalCode>string</AddressPostalCode>
            <AddressCountry_Id>int</AddressCountry_Id>
            <CreditCardNumberLastFour>string</CreditCardNumberLastFour>
            <AchAccountNumberLastFour>string</AchAccountNumberLastFour>
            <Solicitor_Contact_Id>long</Solicitor_Contact_Id>
            <GeneralLedgerCode_Id>long</GeneralLedgerCode_Id>
            <Fund_Id>long</Fund_Id>
            <Campaign_Id>long</Campaign_Id>
            <ResponseChannel_Id>long</ResponseChannel_Id>
            <Tribute_Id>long</Tribute_Id>
            <Event_Id>long</Event_Id>
            <GrassrootsEvent_Id>long</GrassrootsEvent_Id>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
          </PledgeRecord>
          <PledgeRecord>
            <Pledge_Id>long</Pledge_Id>
            <IsActive>boolean</IsActive>
            <Type_Id>int</Type_Id>
            <Category_Id>int</Category_Id>
            <PaymentMethod_Id>int</PaymentMethod_Id>
            <PledgeStatus_Id>int</PledgeStatus_Id>
            <PledgeCancelUser_Id>int</PledgeCancelUser_Id>
            <Contact_Id>long</Contact_Id>
            <Amount>double</Amount>
            <AmountPaid>double</AmountPaid>
            <CurrencySymbol>string</CurrencySymbol>
            <EmailAddress>string</EmailAddress>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <AddressStreet1>string</AddressStreet1>
            <AddressStreet2>string</AddressStreet2>
            <AddressCity>string</AddressCity>
            <AddressStateProvice_Id>int</AddressStateProvice_Id>
            <AddressPostalCode>string</AddressPostalCode>
            <AddressCountry_Id>int</AddressCountry_Id>
            <CreditCardNumberLastFour>string</CreditCardNumberLastFour>
            <AchAccountNumberLastFour>string</AchAccountNumberLastFour>
            <Solicitor_Contact_Id>long</Solicitor_Contact_Id>
            <GeneralLedgerCode_Id>long</GeneralLedgerCode_Id>
            <Fund_Id>long</Fund_Id>
            <Campaign_Id>long</Campaign_Id>
            <ResponseChannel_Id>long</ResponseChannel_Id>
            <Tribute_Id>long</Tribute_Id>
            <Event_Id>long</Event_Id>
            <GrassrootsEvent_Id>long</GrassrootsEvent_Id>
            <DateCreated>dateTime</DateCreated>
            <DateModified>dateTime</DateModified>
          </PledgeRecord>
        </Pledges>
      </GetPledgesResult>
    </GetPledgesResponse>
  </soap12:Body>
</soap12:Envelope>