• Register

Private IPG Last Case Update

The Last Case Update API is a RESTful API.

The service returns children in a given project whose last case study was completed before or equal to a specified date. The requester enters a Project Key. An optional field (Number of Months) is available to compute the specified date. If the optional field is not populated, the default is eighteen months from the day the request is run. The requester receives the project key, child key, the child’s full name, the number of months since the last case study was completed, and the date the last case study was completed.

Sample Request

This is an example only.


Request Parameters

Name Description Required Data Type Constraints
ProjectKey Uniquely represents the project within a country. Yes String
NumberOfMonths Optional field used to compute which children should be returned based on the amount of time elapsed since the last case study was completed on each child. Optional Numeric

Default 18
Max 99

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 that was in the request.
ChildKey Uniquely identifies a child.
ChildName Full name of the child.
MonthsSinceLastCaseStudy Number of months computed from the date of the last case study was completed.
LastCaseStudyDate Date the child's last case study was completed.

Sample Successful Response

Sample Successful Response

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")

Sample Error Response

Error Response Codes

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

HTTP Error ResponseHTTP 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


New comments are not being accepted at this time.

Docs Navigation