User Interfaces Release 9.1 Subscriber Provisioning Reference Manual XML-REST Interface The SPR provides an Application Programming Interface (API) for programmatic management of subscriber data. This interface supports querying, creation, modification, and deletion of subscriber and pool data. The API is an XML over HTTP(S) interface that is designed based upon RESTful concepts. This section defines the operations that can be performed using the XML-REST interface. For additional information on the REST architectural style, see the following references:
http://en.wikipedia.org/wiki/Representational_State_Transfer http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm https://jsr311.dev.java.net/ XML-REST conventions The XML-REST interface uses the following RESTful concepts: HTTP(S) header HTTP(S) status codes Error message representation in the response content for all 4xx and 5xx codes. HTTP(S) header The following HTTP(S) requirements must be followed: Request-header Set Accept header property to the correct MIME version using the following format: application/camiant-msr-v{version number}+xml , where version number is 1 or 2.0. If specified, it must match with application/camiant-msr-v2.0+xml .
The Accept header must match the version supported by the client. This is true even for requests that do not expect entity response data so that any error content is accepted. All operations prior to SDM Release 8.0 support both versions. Operations as of SDM Release 8.0 (Quota and Pool data) support only version 2.0. The SPR response to an incorrect MIME version is a Bad Request, for example, with error code="Invalid Accept: application/camiant-msr-v1+xml. Requests with body content Set request-header Content-Type property to application/camiant-msr-v2.0+xml .
HTTP version HTTP/1.1 HTTPS SSL v3/TLS v1 HTTP(S) status codes and error messages The XML-REST interface uses the following HTTP(S) status codes: 44 910-6701-001 Revision A, June 2013