Exceptions RESTful WebServices exceptions RESTful services generate and send exceptions to clients in response to invocation errors. Exceptions send HTTP status codes (specified later in this document for each operation). HTTP status codes may be followed by an optional JSON exception structure ). Two types of exceptions may be defined: service exceptions and policy exceptions. Service exceptions When a service is not able to process a request, and retrying the request with the same information will also result in a failure, and the issue is not related to a service policy issue, then the service will issue a fault using the service exception fault message. Examples of service exceptions include invalid input, lack of availability of a required resource or a processing error. A service exception uses the letters 'SVC' at the beginning of the message identifier. service exceptions ‘SVC’ used by SHAKEN API are defined below: Exception Exception text HTTP Exception Error Description ID Status Variables Code SVC4000 Missing request 400 - MISSING_BODY body. The API failed due to missing body. SVC4001 Error: Missing mandatory 400 %1 parameter MISSING_INFORMATION – parameter name ‘%1’. The API failed due to missing mandatory parameter SVC4002 Error: Requested 406 %1 not NOT_ACCEPTABLE_RESPONSE_BODY_TYPE – response body type supported ‘%1’ A request was made of a resource for a is not supported. response body message body format type SVC4003 Error: Requested 404 - RESOURCE_NOT_FOUND resource was not found. The server has not found anything matching the Request-URI SVC4004 Error: Unsupported 415 %1 content type UNSUPPORTED_REQUEST_BODY_TYPE – request body type, (’application/json’) Received unsupported message body type expected ‘%1’. SVC4005 Invalid 400 %1 parameter INVALID_PARAMETER_VALUE ‘%1’ – parameter value: %2. name Parameter’s value is invalid %2– short error description
Exceptions RESTful WebServices exceptions RESTful services generate and send exceptions to clients in response to invocation errors. Exceptions send HTTP status codes (specified later in this document for each operation). HTTP status codes may be followed by an optional JSON exception structure ). Two types of exceptions may be defined: service exceptions and policy exceptions. Service exceptions When a service is not able to process a request, and retrying the request with the same information will also result in a failure, and the issue is not related to a service policy issue, then the service will issue a fault using the service exception fault message. Examples of service exceptions include invalid input, lack of availability of a required resource or a processing error. A service exception uses the letters 'SVC' at the beginning of the message identifier. ‘SVC’ service exceptions used by SHAKEN API are defined below: Exception ID Exception text HTTP Status Code Exception Variables Error Description SVC4000 Missing request body. 400 - MISSING_BODY The API failed due to missing body. SVC4001 Error: Missing mandatory parameter ‘%1’. 400 %1 – parameter name MISSING_INFORMATION The API failed due to missing mandatory parameter SVC4002 Error: Requested response body type ‘%1’ is not supported. 406 %1 – not supported response body type NOT_ACCEPTABLE_RESPONSE_BODY_TYPE A request was made of a resource for a message body format SVC4003 Error: Requested resource was not found. 404 - RESOURCE_NOT_FOUND The server has not found anything matching the Request-URI SVC4004 Error: Unsupported request body type, expected ‘%1’. 415 %1 – content type (’application/json’) UNSUPPORTED_REQUEST_BODY_TYPE Received unsupported message body type SVC4005 Invalid ‘%1’ parameter value: %2. 400 %1 – parameter name %2– short error description INVALID_PARAMETER_VALUE Parameter’s value is invalid
IPNNI-2017-00054R001.docx