- Previous: REST Get CSP Implementor V1
- Up: Private REST Services
- Next: REST Get Program Implementor V1
REST Get Local Church Partner V1
The REST 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.
The service returns JSON as default. The service will also return XML. This is controlled by the Accept parameter in the Message Header (i.e., for XML, it should be "Accept: application/xml" and for JSON, it should be "Accept: application/json").
Sample Request
Request Parameters
Response Parameters
XML Sample Successful Response
JSON Sample Successful Response
Sample Unsuccessful Responses
Error Response Codes
Sample Request
This is an example only.
IPTest: https://api2.compassion.com/iptest/ci/v1/localchurchpartners/{id}?ClientReferenceId=[string]&api_key=[string]
Production: https://api2.compassion.com/ci/v1/localchurchpartners/{id}?ClientReferenceId=[string]&api_key=[string]
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 | Data Type Returned |
---|---|---|
LocalChurchPartnerId | Same value as input | number |
PartyId | Uniquely identifies the Party who is playing the role of implementor | string |
OrganizationName |
Name of the local church partner |
string |
StartDate | Date the local church partner affiliation began or will begin | string |
StopDate | Date the local church partner affiliation ended or will end | string |
ChurchHasElectricity | Flag indicating if the local church partner has electiricty in the building | boolean |
ChurchHasPhone | Flag indicating if the local church partner has a phone | boolean |
ChurchOwnsBuilding | Flag indicating if the local church partner has a phone | boolean |
ChurchServiceLanguages | Text describing what language(s) are used during a church service | number |
CommunityId | Community ID where the local church partner is located | string |
ContactEmailAddress | Email address of the contact person | string |
ContactPersonName |
Name of person to contact at the local church partner | string |
ContactPhoneNumber | Phone number of the contact person | string |
ContactTitle | Title of the contact person | string |
CountryId | Country Id where the local church partner is located | string |
FaxNumber | Fax number of the local church partner | string |
FundPayableName | Name to use to designate the recipient of money for the local church partner | string |
GPSCoordinateLatitudeHighPrecision | GPS Latitude of the location of the local church partner – High Precision | string |
GPSCoordinateLatitudeLowPrecision | GPS Latitude of the location of the local church partner – Low Precision | string |
GPSCoordinateLongitudeHighPrecision | GPS Longitude of the location of the local church partner – High Precision | string |
GPSCoordinateLongitudeLowPrecision | GPS Longitude of the location of the local church partner – Low Precision | string |
HIVCategory | Code indicating if the local church partner is in an HIV/Aids infected area | string |
LastReviewDate | Date of last review for the local church partner | string |
LastUpdateDate | Date the information was last updated | string |
MailingAddressLine1 | Mailing address of local church | string |
MailingAddressLine2 | string | |
MailingAddressLine3 | string | |
MailingAddressLine4 | string | |
MonthSchoolYearBegins | Month in which school begins | string |
MonthlyVolunteerHours | Number of hours volunteers work in a month | string |
PaidStaffCount | Number of employees paid by the local church partner | string |
PercentnotinSchool | The percentage of registered beneficiaries who are not in school | string |
PercentnotinSchoolReason | Reason more than 25% of the registered beneficiaries are not in school | string |
PercentCompletingElementarySchool | Percentage of registered beneficiaries who have completed elementary school | string |
PercentCompletingSecondarySchool | Percentage of registered beneficiaries who have completed secondary school | string |
ElementaryCompletionStatus | string | |
SecondaryCompletionStatus | string | |
PhysicalAddressLine1 | Address of the physical location of the local church | string |
PhysicalAddressLine2 | string | |
PhysicalAddressLine3 | string | |
PhysicalAddressLine4 | string | |
CountryDenomination | Denomination in the local country which the church is affiliated | string |
WesternDenomination | Western denomination which the church’s local denomination is affiliated | string |
XML Sample Successful Response
<LocalChurchPartner xmlns="http://schemas.ci.org/ci/common/eim/2014/10/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<LocalChurchPartnerID>[number]</LocalChurchPartnerID>
<PartyID>[string]</PartyID>
<OrganizationName>[string]</OrganizationName>
<StartDate>2006-11-01T00:00:00-07:00</StartDate>
<StopDate></StopDate>
<ChurchHasElectricity>true</ChurchHasElectricity>
<ChurchHasPhone>true</ChurchHasPhone>
<ChurchOwnsBuilding>true</ChurchOwnsBuilding>
<ChurchServiceLanguages>Bengali</ChurchServiceLanguages>
<CommunityID>[string]</CommunityID>
<ContactEmailAddress>[string]</ContactEmailAddress>
<ContactPersonName>[string]</ContactPersonName>
<ContactPhoneNumber>[string]</ContactPhoneNumber>
<ContactTitle>Manager</ContactTitle>
<CountryID>[number]</CountryID>
<FaxNumber></FaxNumber>
<FundPayableName>[string]</FundPayableName>
<GPSCoordinateLatitudeHighPrecision>[number]</GPSCoordinateLatitudeHighPrecision>
<GPSCoordinateLatitudeLowPrecision>[number]</GPSCoordinateLatitudeLowPrecision>
<GPSCoordinateLongitudeHighPrecision>[number]</GPSCoordinateLongitudeHighPrecision>
<GPSCoordinateLongitudeLowPrecision>[number]</GPSCoordinateLongitudeLowPrecision>
<HIVCategory>NOTAFF</HIVCategory>
<LastReviewDate>2013-07-04T00:00:00-06:00</LastReviewDate>
<LastUpdateDate>2006-10-20T00:00:00-06:00</LastUpdateDate>
<MailingAddressLine1>[string]</MailingAddressLine1>
<MailingAddressLine2>[string]</MailingAddressLine2>
<MailingAddressLine3>[string]</MailingAddressLine3>
<MailingAddressLine4></MailingAddressLine4>
<MonthSchoolYearBegins>1</MonthSchoolYearBegins>
<MonthlyVolunteerHours>12</MonthlyVolunteerHours>
<PaidStaffCount>22</PaidStaffCount>
<PercentNotInSchool>0.00</PercentNotInSchool>
<PercentNotInSchoolReason></PercentNotInSchoolReason>
<PercentCompletingElementarySchool></PercentCompletingElementarySchool>
<ElementaryCompletionStatus></ElementaryCompletionStatus>
<PercentCompletingSecondarySchool></PercentCompletingSecondarySchool>
<SecondaryCompletionStatus></SecondaryCompletionStatus>
<PhysicalAddressLine1>[string]</PhysicalAddressLine1>
<PhysicalAddressLine2>[string]</PhysicalAddressLine2>
<PhysicalAddressLine3>[string]</PhysicalAddressLine3>
<PhysicalAddressLine4>[string]</PhysicalAddressLine4>
<CountryDenomination>[string]</CountryDenomination>
<WesternDenomination>[string]</WesternDenomination>
</LocalChurchPartner>
JSON Sample Successful Response
{
"localChurchPartnerID":[number],
"partyID": "[string]",
"organizationName":"[string]",
"startDate":"2006-11-01T00:00:00",
"stopDate":"[string]",
"churchHasElectricity":true,
"churchHasPhone":true,
"churchOwnsBuilding":true,
"churchServiceLanguages":"Bengali",
"communityID":[number],
"contactEmailAddress":"[string]",
"contactPersonName":"[string]",
"contactPhoneNumber":"[string]",
"contactTitle":"Manager",
"countryID":"[number]",
"faxNumber":"[string]",
"fundPayableName":"[string]",
"gpsCoordinateLatitudeHighPrecision":"[number]",
"gpsCoordinateLatitudeLowPrecision":"[number]",
"gpsCoordinateLongitudeHighPrecision":"[number]",
"gpsCoordinateLongitudeLowPrecision":"[number]",
"hivCategory":"NOTAFF",
"lastReviewDate":"2013-07-04T00:00:00",
"lastUpdateDate":"2006-10-20T00:00:00",
"mailingAddressLine1":"[string]",
"mailingAddressLine2":"[string]",
"mailingAddressLine3":"[string]",
"mailingAddressLine4":"",
"monthSchoolYearBegins":"1",
"monthlyVolunteerHours":"12",
"paidStaffCount":"22",
"percentNotInSchool":"0.00",
"percentNotInSchoolReason":"[string]",
"percentCompletingElementarySchool":"[string]",
"elementaryCompletionStatus":"[string]",
"percentCompletingSecondarySchool":"[string]",
"secondaryCompletionStatus":"",
"physicalAddressLine1":"[string]",
"physicalAddressLine2":"[string]",
"physicalAddressLine3":"[string]",
"physicalAddressLine4":"[string]",
"countryDenomination":"[string]",
"westernDenomination":"[string]"
}
Sample Unsuccessful Responses
XML Unsuccessful Response
<Error>
<ID>[string]</ID>
<Message>Incorrect data type: ID can only be numeric digits (0-9).</Message>
</Error>
JSON Unsuccessful Response
{
"error": {
"id": "[string]"
"message": "Incorrect data type: ID can only be numeric digits (0-9)."
}
}
Error Response Codes
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 |
- Previous: REST Get CSP Implementor V1
- Up: Private REST Services
- Next: REST Get Program Implementor V1
Docs Navigation
- Compassion API Library
- Standards Documents
- Legacy APIs (Deprecating)
- Web Services Handshake (Legacy) - Notification and Command Messages
- Public API
- Private IPG APIs
- Private REST Services
- REST Get CDSP Implementor V1
- REST Get Child Case Study V1
- REST Get Child Exit Details V1
- REST Get Child Image V1
- REST Get Child Information V1
- REST Get Community V1
- REST Get Country V1
- REST Get CSP Implementor V1
- REST Get Local Church Partner V1
- REST Get Program Implementor V1
- REST Get Project Age Groups V1
- REST Get Child Image V1 - 2015/03
- Private Messaging APIs
- Quick Start Guide
- OffRamp Prerequisites and Setup
- IP OnRamp Service Configuration
- Available Message Types
- Message and Service Relationships
- Troubleshooting
- General Error Messages from Compass Party Host
- EsdMessageErrorMOE Sample
- Sample REST End-To-End Test Plan
- SOAP Wrapper Sample for Messages to GMC
- Allocate Child Message
- Cancel Commitment Message
- Commitment Canceled Message
- Commitment Created Message
- Constituent Created Message
- Constituent Updated Message
- Constituent Upserted Message
- Create Commitment Message
- Create Constituent Message
- Create Email Message
- Create Gift Message
- Deallocate Child Message
- Depart Child Message
- Email Created Message
- Email Updated Message
- Gift Created Message
- Update Child Message
- Update Constituent Message
- Update Email Message
- Upsert Constituent Message
- Update Project Message
- Private SOAP Services
- SOAP Get Child Exit Detail 201211
- SOAP Get Child Exit Detail 201310
- SOAP Get CDSP Implementor 201309
- SOAP Get Child Image 201211
- SOAP Get Child Case Study 201310
- SOAP Get Child Case Study 201412
- SOAP Get Child Information 201211
- SOAP Get Child Information 201310
- SOAP Get Community 201309
- SOAP Get Country Information 201104
- SOAP Get Local Church Partner 201309
- SOAP Get Program Implementor 201303
- SOAP Get Program Implementor 201309
- SOAP Get Project Age Group 201309
- Service Overview
- SOAP Get CSP Implementor 201309
- SOAP Get Child Image 201503
- Private USA APIs
- Private USA Web APIs
- private cornerstone connect messaging
- private cornerstone test
- public api
0 Comments
New comments are not being accepted at this time.