SOAP Get CDSP Implementor 201309

Note: This service is not available in our interactive API option.

The SOAP service, CDSP Implementor, provides information on a CDSP implementor based on the CDSP Implementor Key.

CDSP connects one child with one sponsor to help that child develop into the extraordinary individual which God ordained.

A CDSP Implementor administers a Compassion Child Development Sponsorship program.

Sample Request
Request Parameters
Response Parameters
Sample Successful Response
Sample Unsuccessful Response
Error Response Codes

Sample Request

This is an example only.

Action
http://services.ci.org/ci/CDSPImplementor/2013/09/GetCDSPImplementor
URL
Prod:    https://api2.compassion.com/ci.services/cdspimplementor/2013/09/getcdspimplementor?api_key=[string]
IPTest: https://api2.compassion.com/iptest/ci.services/cdspimplementor/2013/09/getcdspimplementor?api_key=[string]

XML
<s:Envelope xmlns:s='http://schemas.xmlsoap.org/soap/envelope/'>
  <s:Header>
    <ClientReferenceId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</ClientReferenceId>
  </s:Header>
  <s:Body>
    <GetCDSPImplementorRequest SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/CDSPImplementor/2013/09/">
      <RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="CDSPImplementorKeyLegacy" value="[string]" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
    </GetCDSPImplementorRequest>
  </s:Body>
</s:Envelope>

Request Parameters

Name Description Required Data Type Constraints
CDSPImplementorKeyLegacy Code assigned by Compassion International when the child is registered in the Child Sponsorship Program. Yes String Fixed 5
ClientReferenceId Uniquely represents the transaction in the client's system. Optional String Max 100
api_key Your Mashery supplied key for an application running Compassion International services. Yes String  

Response Parameters

Name Description
CDSPImplementorId Value of the CDSP Implementor Id associated with the input parameter
PartyId Value of the Party Id associated with the input parameter
CDSPImplementorKey Does not return a value
CDSPImplementorKeyLegacy Same value as input
Name

Name of the CDSP Implementor

StartDate Date the partnership began
StopDate Date the partnership ended
FirstEnteredDate Date the implementor information was first entered in Compassion system>
LastUpdateDate Date the implementor information was first received or an update was received>
LastReviewDate Date the annual information update was received>
Status One character status field indicating if the project is Active (A), on Phase-out(P), or Terminated(T). There is not a suspended status. One of the letters are returned in the response.
ExternalStatus Status exposed to the external clients
StatusDate Date the program status became effective
StatusComment Description of why a program status date was changed.e.g. mm-dd-yy SUSPENSION: LINKED CSP EC-Cxx ALSO SUSPENDED.
DateStatusDateEntered Date status was recorded in Compassion system
Descripton Description of the project
ActivitiesforNonSchoolChildren Project activities specifically for CDSP children who do not attend school
CognitiveorVocationalActivities Project activities targeted to CDSP child cognitive and/or vocational development
OtherActivities Project activities not targeted to a particular development activity
ParentorFamilyActivities Project activities targeted to parent and family development
PhysicalorHealthActivities Project activities targeted to CDSP child physical development
SocialorEmotionalActivites Project activities targeted to CDSP child social/emotional development
SpiritualActivities Project activities targeted to CDSP child spiritual development
AnnualSchoolCostinDollars Annual cost for a child to attend school in the community where the CDSP Implementor is located
DisburseGifts Flag indicating if gifts may be disbursed to the CDSP Implementor or to the CDSP child
DisburseFunds Flag indicating if funds, not including gifts can be disbursed to the CDSP Implementor or CDSP children
DisburseUnsponsoredFunds Flag indicating if unsponsored funds can be disbursed to the CDSP Implementor or CDSP child
NewSponsorshipsAllowed Flag indicating if commitmentscan be created
AdditionalQuotaAllowed Flag indicating if the quota may be continued
ContactEmailAddress Email address of the contact person

ContactPersonName

Name of person to contact
ContactPhoneNumber Phone number of the contact person
ContactTitle Job title of the contact person
FaxNumber >Fax number
GPSCoordinateLatitudeHighPrecision GPS Latitude of the location of the CDSP Implementor – High Precision
GPSCoordinateLatitudeLowPrecision GPS Latitude of the location of the CDSP Implementor – Low Precision
GPSCoordinateLongitudeHighPrecision GPS Longitude of the location of the CDSP Implementor – High Precision
GPSCoordinateLongitudeLowPrecision GPS Longitude of the location of the CDSP Implementor – Low Precision
MailingAddressLine1 Mailing address
MailingAddressLine2
MailingAddressLine3
MailingAddressLine4
PhysicalAddressLine1 Address of the physical location
PhysicalAddressLine2
PhysicalAddressLine3
PhysicalAddressLine4
LinkedProjectKey
LinkedProjectName
ActivityHoursPerWeek
DescriptionModificationDate
LastModifiedDate Date record was created or modified

Sample Successful Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <ClientReferenceId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PubChldInfo_TC-002</ClientReferenceId>
    <SendingNode xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendingNode>
    <MessageStreamId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageStreamId>
    <EventSequenceNumber xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[number]</EventSequenceNumber>
    <MessageId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageId>
    <RelatesTo xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</RelatesTo>
    <SendersName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">CI\esbservice</SendersName>
    <SendersAppName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendersAppName>

    <SendersTrackingId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersTrackingId>
  </s:Header>
  <s:Body>
    <GetCDSPImplementorResponse ResponseCode="0" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/cdspimplementor/2013/09/">
      <RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="CDSPImplementorKeyLegacy" value="[String]" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
      <CDSPImplementorCollection rowcount="1">
        <CDSPImplementor xmlns="http://schemas.ci.org/ci/common/eim/2013/09/">
          <CDSPImplementorID>[string]</CDSPImplementorID>
          <PartyID>[string]</PartyID>
          <CDSPImplementorKey/>
          <CDSPImplementorKeyLegacy>[string]</CDSPImplementorKeyLegacy>
          <Name>[string]</Name>
          <StartDate>1984-07-18T00:00:00</StartDate>
          <StopDate>2002-06-30T00:00:00</StopDate>
          <FirstEnteredDate>1900-01-01T00:00:00</FirstEnteredDate>
          <LastUpdateDate>1900-01-01T00:00:00</LastUpdateDate>
          <LastReviewDate>1900-01-01T00:00:00</LastReviewDate>
          <Status>T</Status>
          <ExternalStatus>T</ExternalStatus>
          <StatusDate>2002-09-06T00:00:00</StatusDate>
          <StatusComment>[text]</StatusComment>
          <DateStatusDateEntered />
          <Description>[text] </Description>
          <ActivitiesForNonSchoolChildren/>
          <CognitiveOrVocationalActivities/>
          <OtherActivities/>
          <ParentOrFamilyActivities/>
          <PhysicalOrHealthActivities/>
          <SocialOrEmotionalActivities/>
          <SpiritualActivities/>
          <AnnualSchoolCostInDollars>0.0000</AnnualSchoolCostInDollars>
          <DisburseGifts>T</DisburseGifts>
          <DisburseFunds>F</DisburseFunds>
          <DisburseUnsponsoredFunds>F</DisburseUnsponsoredFunds>
          <NewSponsorshipsAllowed>F</NewSponsorshipsAllowed>
          <AdditionalQuotaAllowed>F</AdditionalQuotaAllowed>
          <ContactEmailAddress/>
          <ContactPersonName/>
          <ContactPhoneNumber/>
          <ContactTitle/>
          <FaxNumber/>
          <GPSCoordinateLatitudeHighPrecision/>
          <GPSCoordinateLatitudeLowPrecision/>
          <GPSCoordinateLongitudeHighPrecision/>
          <GPSCoordinateLongitudeLowPrecision/>
          <MailingAddressLine1>NOT AVAILABLE AT THIS TIME</MailingAddressLine1>
          <MailingAddressLine2>NOT AVAILABLE AT THIS TIME</MailingAddressLine2>
          <MailingAddressLine3/>
          <MailingAddressLine4/>
          <PhysicalAddressLine1/>
          <PhysicalAddressLine2/>
          <PhysicalAddressLine3/>
          <PhysicalAddressLine4/>
          <LinkedProjectKey/>
          <LinkedProjectName/>
          <ActivityHoursPerWeek>0</ActivityHoursPerWeek>
          <DescriptionModificationDate>2000-03-24T16:20:17.7-07:00</DescriptionModificationDate>
          <LastModifiedDate>2002-09-06T10:19:01.8-06:00</LastModifiedDate>
        </CDSPImplementor>
      </CDSPImplementorCollection>
    </GetCDSPImplementorResponse>
  </s:Body>
</s:Envelope>

Sample Unsuccessful Response

The service operation will provide the following response when there are missing required parameters.
Exception Returned: (ResponseCode = "1", HTTP Status Code ="404")

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <ClientReferenceId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PubChldInfo_TC-002</ClientReferenceId>
    <SendingNode xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendingNode>
    <MessageStreamId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageStreamId>
    <EventSequenceNumber xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[number]</EventSequenceNumber>
    <MessageId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageId>
    <RelatesTo xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</RelatesTo>
    <SendersName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">CI\esbservice</SendersName>
    <SendersAppName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendersAppName>

    <SendersTrackingId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersTrackingId>
  </s:Header>
  <s:Body>

    <GetCDSPImplementorResponse ResponseCode="1" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/cdspimplementor/2013/09/">
      <RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="CDSPImplementorKeyLegacy" value="[string]" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
      <ErrorResponse SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <ErrorName>Validation Error</ErrorName>
        <DateTimestamp>2015-01-26T11:51:35.0409203-07:00</DateTimestamp>
        <SendersAppName>PublicSimpleRequestReplySoapService</SendersAppName>
        <ServiceName>PublicSimpleRequestReplySoapService</ServiceName>
        <ErrorId>[string]</ErrorId>
        <ErrorCode>[number]</ErrorCode>
        <ErrorMessage>'CDSPImplementorKeyLegacy' must be 2 alpha characters followed by 3 numeric characters.</ErrorMessage>
      </ErrorResponse>
    </GetCDSPImplementorResponse>
  </s:Body>
</s:Envelope>

Error Response Codes

For ResponseCode = 1, the table below indicates the HTTP error response and HTTP Error message.

HTTP Error Response HTTP Error Message
HTTP 400 Service Parameter Failure
HTTP 401 Not Authenticated / Authorized for Service Data
HTTP 403 Not Authorized
HTTP 403 Account Inactive
HTTP 403 Over Queries Per Second Limit
HTTP 403 Over Rate Limit
HTTP 403 Unknown Referrer
HTTP 404 Requested Resource Not Found
HTTP 408 Request Timeout
HTTP 414 Request URI Too Long
HTTP 500 Internal Server Error
HTTP 502 Bad Gateway
HTTP 503 API Maintenance / Service Unavailable
HTTP 504 Gateway Timeout

Docs Navigation