User Interfaces Release 9.1 Subscriber Provisioning Reference Manual XML-REST operations The detailed descriptions of the XML-REST operations use Subscriber provisioning as an example. The same provisioning method applies to Pool provisioning and special operations. For a complete syntax of the XML-REST commands, refer to XML-REST commands syntax . The operation descriptions use the following conventions: Base URI: The base URI ({baseURI}) that is the prefix for the documented URIs uses the following syntax: https://{DNS Name or IP address}:8787/rs. The curly brackets denote replacement variables and are not part of the actual operation syntax.
Any replacement variable data that contains any special characters must be encoded. The value in the curly brackets can be determined by how the SPR is installed in the network. For example, if the SPR is installed with the DNS name spr.tekelec.com on a system with IP address 1.2.3.4 , the base URI could be either https://spr.tekelec.com:8787/rs or https://1.2.3.4:8787/rs . HTTP(S) response codes: The enumerated list of response status codes contained in the operation descriptions contain the most common codes that an operation may return under normal operating conditions. Other codes may be returned per the HTTP(S) status code standards or XML-REST conventions. Fields in URLs:
For field operations (Fetch Field, Fetch Field Value, Set Field Value, Add Field Value, Delete Field Value), references to a field in the URL can be any field, including key fields. For example, DELETE {baseURI}/msr/sub/IMSI/1234/field/IMSI is a valid request.
48 910-6701-001 Revision A, June 2013 Type Operation CMD Meaning Operation Syntax and Examples Delete Field Value DELETE Delete sub/MSISDN/123456789/multipleFields/Entitlement/ YearPass/Tier/1/BillingDay/15 Opaque data operations Fetch Opaque Data GET Display sub/{KeyName}/{KeyValue}/data/{opaqueDataType} sub/MSISDN/+33123654862/data/State Set Opaque Data PUT Modify Delete Opaque Data DELETE Delete * Up to three fields can be modified simultaneously with one PUT command.