SOAP Get Program Implementor 201309

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

The SOAP call Get Program Implementor 201309 adds extra fields from the first version. The service provides information on specific CDSP and CSP organizations that partner with Compassion International to implement and administrate one or more ministry intervention programs designed to fulfill Compassion's mission of holistic child development and promote child advocacy.

CDSP is Compassion International's Child Development Sponsorship Program, which connects one child with one sponsor to help that child develop into the extraordinary individual which God ordained.

CSP is Compassion International's Child Survival Program, which equips the worldwide Church to respond to the cry of mothers on behalf of their babies by ensuring a healthy environment and a strong start in life for the poorest and most vulnerable. Using proven child survival strategies, caregivers and their families are equipped to nurture and disciple their children.

The programs provide the following through sponsorship:

• Educational opportunities
• Healthcare, supplemental nutrition, and health education
• Life-skills training
• A safe and loving environment in which to learn and play
• The opportunity to hear the gospel of Jesus Christ and be discipled

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/programimplementor/2013/09/GetProgramImplementor
URL
Prod: https://api2.compassion.com/ci.services/programimplementor/2013/09/getprogramimplementor?api_key=[string]
IPTest: https://api2.compassion.com/iptest/ci.services/programimplementor/2013/09/getprogramimplementor?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 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <GetProgramImplementorRequest xmlns="http://schemas.ci.org/ci/services/programimplementor/2013/09/">
      <RequestCriteria SchemaVersion='1.0' xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator='And'>
          <Field name="ImplementorKeyLegacy" value="[string]" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
    </GetProgramImplementorRequest>
  </s:Body>
</s:Envelope>

Request Parameters

Response Parameters

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/">8</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>
    <GetProgramImplementorResponse ResponseCode="0" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/programimplementor/2013/09/">
      <RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="ImplementorKeyLegacy" value="[string]" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
      <ProgramImplementorCollection rowcount="1">
        <ProgramImplementor xmlns="http://schemas.ci.org/ci/common/eim/2013/09/">
          <ProgramImplementorTypeCode>CDSP</ProgramImplementorTypeCode>
          <ImplementorKey/>
          <ImplementorKeyLegacy>BD510</ImplementorKeyLegacy>
          <Name>Malumghat Child Sponsorship Program</Name>
          <StartDate>2008-03-01T00:00:00-07:00</StartDate>
          <LastReviewDate>2013-06-26T00:00:00-06:00</LastReviewDate>
          <Status>A</Status>
          <ExternalStatus>A</ExternalStatus>
          <StatusDate>2014-06-09T00:00:00-06:00</StatusDate>
          <Description>[string]</Description>
          <LocalChurchPartnerID>[number]</LocalChurchPartnerID>
          <OrganizationName>[string]</OrganizationName>
          <ChurchServiceLanguages>[string]</ChurchServiceLanguages>
          <GPSCoordinateLatitudeHighPrecision>[number]</GPSCoordinateLatitudeHighPrecision>
          <GPSCoordinateLatitudeLowPrecision>[number]</GPSCoordinateLatitudeLowPrecision>
          <GPSCoordinateLongitudeHighPrecision>[number]</GPSCoordinateLongitudeHighPrecision>
          <GPSCoordinateLongitudeLowPrecision>[number]</GPSCoordinateLongitudeLowPrecision>
          <HIVCategory>NOTAFF</HIVCategory>
          <MonthSchoolYearBegins>1</MonthSchoolYearBegins>
          <CountryDenomination>Baptist</CountryDenomination>
          <WesternDenomination>Other</WesternDenomination>
          <CommunityName>[string]</CommunityName>
          <ISOCountryName>[string]</ISOCountryName>
          <ISOCountryCode>AA</ISOCountryCode>
          <CountryCommonName>[string]</CountryCommonName>
          <CommunityID>[number]</CommunityID>
          <StatusComment>[string]</StatusComment>
          <DescriptionModificationDate>2013-07-03T10:36:02.7-06:00</DescriptionModificationDate>
          <DisburseGifts>T</DisburseGifts>
          <DisburseFunds>T</DisburseFunds>
          <SpiritualActivities>[string]</SpiritualActivities>
          <ActivitiesForNonSchoolChildren>[string]</ActivitiesForNonSchoolChildren>
          <CognitiveOrVocationalActivities>[string]</CognitiveOrVocationalActivities>
          <OtherActivities>n/a</OtherActivities>
          <ParentOrFamilyActivities>[string]</ParentOrFamilyActivities>
          <PhysicalOrHealthActivities>[string]</PhysicalOrHealthActivities>
          <SocialOrEmotionalActivities>[string]</SocialOrEmotionalActivities>
          <ActivityHoursPerWeek>20</ActivityHoursPerWeek>
          <PercentNotInSchool>0.07</PercentNotInSchool>
          <PercentNotInSchoolReason>. </PercentNotInSchoolReason>
          <PercentCompletingElementarySchool/>
          <PercentCompletingSecondarySchool/>
          <ElementaryCompletionStatus>1</ElementaryCompletionStatus>
          <SecondaryCompletionStatus>1</SecondaryCompletionStatus>
          <ChurchHasElectricity>T</ChurchHasElectricity>
          <ChurchHasPhone>T</ChurchHasPhone>
          <ChurchOwnsBuilding>T</ChurchOwnsBuilding>
          <PaidStaffCount>20</PaidStaffCount>
          <MonthlyVolunteerHours>15</MonthlyVolunteerHours>
          <LinkedProjectKey/>
          <LinkedProjectName/>
          <LastModifiedDate>2014-06-09T13:06:51.523-06:00</LastModifiedDate>
        </ProgramImplementor>
      </ProgramImplementorCollection>
    </GetProgramImplementorResponse>
  </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/">3</EventSequenceNumber>
    <SendersAppName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">PublicSimpleRequestReplySoapService</SendersAppName>
    <RelatesTo xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</RelatesTo>
    <MessageId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</MessageId>
    <SendersName xmlns="http://schemas.ci.org/ci/services/common/2011/04/">NT AUTHORITY\SYSTEM</SendersName>
    <SendersTrackingId xmlns="http://schemas.ci.org/ci/services/common/2011/04/">[string]</SendersTrackingId>
  </s:Header>
  <s:Body>
    <GetProgramImplementorResponse ResponseCode="0" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/programimplementor/2013/09/">
      <RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="ImplementorKeyLegacy" 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-28T15:30:02.866895-07:00</DateTimestamp>
        <SendersAppName>PublicSimpleRequestReplySoapService</SendersAppName>
        <ServiceName>PublicSimpleRequestReplySoapService</ServiceName>
        <ErrorId>[guid]</ErrorId>
        <ErrorCode>4004</ErrorCode>
        <ErrorMessage>'ImplementorKeyLegacy' must be 5 alphanumeric characters matching one of the following forms 'AANNN', 'AAANN' or 'AAAAN.'</ErrorMessage>
      </ErrorResponse>
    </GetProgramImplementorResponse>
  </s:Body>
</s:Envelope>

Error Response Codes

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