SOAP Get Local Church Partner 201309

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

The SOAP service Local Church Partner provides information on a church partner and the community they reside in based on the Local Church Partner Id.

A church partner is a church within a field country that implements and administers one or more Compassion ministry programs which are designed to fulfill Compassion International's mission of holistic child development and promote child advocacy.

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/localchurchpartner/2013/09/GetLocalChurchPartner
URL
Prod:    https://api2.compassion.com/ci.services/localchurchpartner/2013/09/getlocalchurchpartner?api_key=[string]
IPTest: https://api2.compassion.com/iptest/ci.services/localchurchpartner/2013/09/getlocalchurchpartner?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>
    <GetLocalChurchPartnerRequest SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/localchurchpartner/2013/09/">
      <RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="LocalChurchPartnerId" value="[string]" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
    </GetLocalChurchPartnerRequest>
  </s:Body>
</s:Envelope>

Request Parameters

Name Description Required Data Type Constraints
LocalChurchPartnerId Code assigned by Compassion International when the child is registered in the Child Sponsorship Program. Yes String Max 10
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
LocalChurchPartnerId Same value as input
PartyId Uniquely identifies the Party who is playing the role of implementor
OrganizationName

Name of the local church partner

StartDate Date the local church partner affiliation began or will begin
StopDate Date the local church partner affiliation ended or will end
ChurchHasElectricity Flag indicating if the local church partner has electricity in the building
ChurchHasPhone Flag indicating if the local church partner has a phone
ChurchOwnsBuilding Flag indicating if the local church partner has a phone
ChurchServiceLanguages Text describing what language(s) are used during a church service
CommunityId Community ID where the local church partner is located
ContactEmailAddress Email address of the contact person

ContactPersonName

Name of person to contact at the local church partner
ContactPhoneNumber Phone number of the contact person
ContactTitle Title of the contact person
CountryId
Country Id where the local church partner is located
FaxNumber Fax number of the local church partner
FundPayableName Name to use to designate the recipient of money for the local church partner
GPSCoordinateLatitudeHighPrecision GPS Latitude of the location of the local church partner – High Precision
GPSCoordinateLatitudeLowPrecision
GPS Latitude of the location of the local church partner – Low Precision
GPSCoordinateLongitudeHighPrecision
GPS Longitude of the location of the local church partner – High Precision
GPSCoordinateLongitudeLowPrecision
GPS Longitude of the location of the local church partner – Low Precision
HIVCategory Code indicating if the local church partner is in an HIV/Aids infected area
LastReviewDate Date of last review for the local church partner
LastUpdateDate Date the information was last updated
MailingAddressLine1 Mailing address of local church
MailingAddressLine2
MailingAddressLine3

MailingAddressLine4
MonthSchoolYearBegins Month in which school begins
MonthlyVolunteerHours Number of hours volunteers work in a month
PaidStaffCount Number of employees paid by the local church partner
PercentnotinSchool The percentage of registered beneficiaries who are not in school
PercentnotinSchoolReason Reason more than 25% of the registered beneficiaries are not in school
PercentCompletingElementarySchool Percentage of registered beneficiaries who have completed elementary school
PercentCompletingSecondarySchool Percentage of registered beneficiaries who have completed secondary school
ElementaryCompletionStatus
SecondaryCompletionStatus
PhysicalAddressLine1 Address of the physical location of the local church
PhysicalAddressLine2
PhysicalAddressLine3
PhysicalAddressLine4
CountryDenomination Denomination in the local country which the church is affiliated
WesternDenomination Western denomination which the church’s local denomination is affiliated

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>
   <GetLocalChurchPartnerResponse ResponseCode="0" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/localchurchpartner/2013/09/">
     <RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
       <Criteria operator="And">
         <Field name="LocalChurchPartnerId" value="[string]" comparisonOperator="Equals"/>
       </Criteria>
     </RequestCriteria>
     <LocalChurchPartnerCollection rowcount="1">
       <LocalChurchPartner xmlns="http://schemas.ci.org/ci/common/eim/2013/09/">
         <LocalChurchPartnerID>[string]</LocalChurchPartnerID>
         <PartyID>[string]</PartyID>
         <OrganizationName>[string]</OrganizationName>
         <StartDate>2006-11-01T00:00:00</StartDate>
         <StopDate/>
         <ChurchHasElectricity>T</ChurchHasElectricity>
         <ChurchHasPhone>T</ChurchHasPhone>
         <ChurchOwnsBuilding>T</ChurchOwnsBuilding>
         <ChurchServiceLanguages>[string]</ChurchServiceLanguages>
         <CommunityID>[string]</CommunityID>
         <ContactEmailAddress>[string]</ContactEmailAddress>
         <ContactPersonName>[string]</ContactPersonName>
         <ContactPhoneNumber>[string]</ContactPhoneNumber>
         <ContactTitle>Manager</ContactTitle>
         <CountryID>[string]</CountryID>
         <FaxNumber/>
         <FundPayableName>[string]</FundPayableName>
         <GPSCoordinateLatitudeHighPrecision>[number]</GPSCoordinateLatitudeHighPrecision>
         <GPSCoordinateLatitudeLowPrecision>[number]</GPSCoordinateLatitudeLowPrecision>
         <GPSCoordinateLongitudeHighPrecision>[number]</GPSCoordinateLongitudeHighPrecision>
         <GPSCoordinateLongitudeLowPrecision>[number]</GPSCoordinateLongitudeLowPrecision>
         <HIVCategory>[string]</HIVCategory>
         <LastReviewDate>2013-07-04T00:00:00</LastReviewDate>
         <LastUpdateDate>2006-10-20T00:00:00</LastUpdateDate>
         <MailingAddressLine1>[string]</MailingAddressLine1>
         <MailingAddressLine2>[string]</MailingAddressLine2>
         <MailingAddressLine3>[string]</MailingAddressLine3>
         <MailingAddressLine4/>
         <MonthSchoolYearBegins>1</MonthSchoolYearBegins>
         <MonthlyVolunteerHours>12</MonthlyVolunteerHours>
         <PaidStaffCount>[number]</PaidStaffCount>
         <PercentNotInSchool>0.00</PercentNotInSchool>
         <PercentNotInSchoolReason/>
         <PercentCompletingElementarySchool/>
         <ElementaryCompletionStatus/>
         <PercentCompletingSecondarySchool/>
         <SecondaryCompletionStatus/>
         <PhysicalAddressLine1>[string]</PhysicalAddressLine1>
         <PhysicalAddressLine2>[string]</PhysicalAddressLine2>
         <PhysicalAddressLine3>[string]</PhysicalAddressLine3>
         <PhysicalAddressLine4>[string]</PhysicalAddressLine4>
         <CountryDenomination>[string]</CountryDenomination>
         <WesternDenomination>[string]</WesternDenomination>
       </LocalChurchPartner>
     </LocalChurchPartnerCollection>
   </GetLocalChurchPartnerResponse>
 </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>
    <GetLocalChurchPartnerResponse ResponseCode="0SchemaVersion="1.0xmlns="http://schemas.ci.org/ci/services/localchurchpartner/2013/09/">
      <RequestCriteria SchemaVersion="1.0xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="LocalChurchPartnerIdvalue="[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-28T14:09:50.7193236-07:00</DateTimestamp>
        <SendersAppName>PublicSimpleRequestReplySoapService</SendersAppName>
        <ServiceName>PublicSimpleRequestReplySoapService</ServiceName>
        <ErrorId>[guid]</ErrorId>
        <ErrorCode>4004</ErrorCode>
        <ErrorMessage>Incorrect data type: LocalChurchPartnerID can only be numeric digits (0-9).</ErrorMessage>
      </ErrorResponse>
    </GetLocalChurchPartnerResponse>
  </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