SOAP Get Project Age Group 201309

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

The SOAP call Get Project Age Group provides a project's basic hourly, daily, and monthly information based on age groups. This service applies only to CDSP Implementors.

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.

The CDSP program 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/project/2013/09/GetProjectAgeGroup
URL
Prod:    https://api2.compassion.com/ci.services/project/2013/09/getprojectagegroup?api_key=[string]
IPTest: https://api2.compassion.com/iptest/ci.services/project/2013/09/getprojectagegroup?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">
    <GetProjectAgeGroupRequest SchemaVersion='1.0xmlns="http://schemas.ci.org/ci/services/project/2013/09/">
      <RequestCriteria SchemaVersion='1.0xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator='And'>
          <Field name="ProjectKey" value="[string]" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
    </GetProjectAgeGroupRequest>
  </s:Body>
</s:Envelope>

Request Parameters

Name Description Required Data Type Constraints
ProjectKey Key identifying a CDSP Implementor 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
ProjectKey Same value as input
LowAge Youngest age the below data applies to
HighAge Oldest age the below data applies to
SchoolMonths Months of the year the project is in session
SchoolDays Days of the week the project is in session
SchoolHours How many hours the related activity meets

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>
    <GetProjectAgeGroupResponse ResponseCode="0" SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/project/2013/09/">
      <RequestCriteria SchemaVersion="1.0" xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="ProjectKey" value="[string]" comparisonOperator="Equals"/>
        </Criteria>
      </RequestCriteria>
      <ProjectAgeGroupCollection rowcount="4">
        <eim:ProjectAgeGroup xmlns:eim="http://schemas.ci.org/ci/common/eim/2013/09/">
          <eim:ProjectKey>[string]</eim:ProjectKey>
          <eim:LowAge>5</eim:LowAge>
          <eim:HighAge>6</eim:HighAge>
          <eim:SchoolMonths>February,March,April,May,July,August,September,October,November</eim:SchoolMonths>
          <eim:SchoolDays>Monday,Tuesday,Wednesday,Thursday,Friday</eim:SchoolDays>
          <eim:SchoolHours>20</eim:SchoolHours>
        </eim:ProjectAgeGroup>
        <eim:ProjectAgeGroup xmlns:eim="http://schemas.ci.org/ci/common/eim/2013/09/">
          <eim:ProjectKey>[string]</eim:ProjectKey>
          <eim:LowAge>6</eim:LowAge>
          <eim:HighAge>11</eim:HighAge>
          <eim:SchoolMonths>February,March,April,May,July,August,September,October,November</eim:SchoolMonths>
          <eim:SchoolDays>Monday,Tuesday,Wednesday,Thursday,Friday</eim:SchoolDays>
          <eim:SchoolHours>20</eim:SchoolHours>
        </eim:ProjectAgeGroup>
        <eim:ProjectAgeGroup xmlns:eim="http://schemas.ci.org/ci/common/eim/2013/09/">
          <eim:ProjectKey>[string]</eim:ProjectKey>
          <eim:LowAge>11</eim:LowAge>
          <eim:HighAge>14</eim:HighAge>
          <eim:SchoolMonths>February,March,April,May,July,August,September,October,November</eim:SchoolMonths>
          <eim:SchoolDays>Monday,Tuesday,Wednesday,Thursday,Friday,Saturday</eim:SchoolDays>
          <eim:SchoolHours>24</eim:SchoolHours>
        </eim:ProjectAgeGroup>
        <eim:ProjectAgeGroup xmlns:eim="http://schemas.ci.org/ci/common/eim/2013/09/">
          <eim:ProjectKey>[string]</eim:ProjectKey>
          <eim:LowAge>14</eim:LowAge>
          <eim:HighAge>18</eim:HighAge>
          <eim:SchoolMonths>February,March,April,May,July,August,September,October,November</eim:SchoolMonths>
          <eim:SchoolDays>Monday,Tuesday,Wednesday,Thursday,Friday</eim:SchoolDays>
          <eim:SchoolHours>24</eim:SchoolHours>
        </eim:ProjectAgeGroup>
      </ProjectAgeGroupCollection>
    </GetProjectAgeGroupResponse>
  </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>
    <GetProjectAgeGroupResponse ResponseCode="0SchemaVersion="1.0xmlns="http://schemas.ci.org/ci/services/project/2013/09/">
      <RequestCriteria SchemaVersion="1.0xmlns="http://schemas.ci.org/ci/services/common/2011/04/">
        <Criteria operator="And">
          <Field name="ProjectKeyvalue="[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-30T16:39:31.0049556-07:00</DateTimestamp>
        <SendersAppName>PublicSimpleRequestReplySoapService</SendersAppName>
        <ServiceName>PublicSimpleRequestReplySoapService</ServiceName>
        <ErrorId>[guid]</ErrorId>
        <ErrorCode>4004</ErrorCode>
        <ErrorMessage>Invalid Project key. Project key must be 2 alpha characters followed by 3 numeric characters.</ErrorMessage>
      </ErrorResponse>
    </GetProjectAgeGroupResponse>
  </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 / Parameter Failure
HTTP 502 Bad Gateway
HTTP 503 API Maintenance / Service Unavailable
HTTP 504 Gateway Timeout

Docs Navigation