Example of how we handle API responses

api_response_example.php

<?php

/*

Example of a json response object:

{
"response": { //Whatever is expected to be returned
 "id": 11,
 "firstName": "Woody",
 "lastName": "Allen",
 "email" : "wa@example.org"
},
"status": {
  "code": 0,
  "messagge": "some message, or empty if not needed"
}

*/

// Our PHP code handle standard API response as such:
protected static function _get_api_response( $response ) {
  //No response and no status code
	if ( !$response || !isset( $response->status->code ) ) {
		throw new TranslationProxy_Api_Error( "Cannot communicate with the remote service" );
	}
	//Status code is not 0 (0 = OK): throw an error and provide among with the status code
	if ( $response->status->code != 0 ) {
		throw new TranslationProxy_Api_Error( $response->status->message, $response->status->code );
	}

  //Everything is fine, return just the response part
	return $response->response;
}