BAIC — XML-REST operations overview

User Interfaces Release 9.1 Subscriber Provisioning Reference Manual Fetch - retrieves all subscriber field data Add - creates new subscriber profile Update - replaces existing subscriber Delete - deletes all profile data (field-value pairs) and opaque data Field operations manipulate field-value pairs within a profile. Two or three fields can be modified with one command. Field operations include:

Fetch Field - retrieves all values for specified field Fetch Field Value - retrieves single value for specified field Set Field Value - sets field to specified value Add Field Value - adds value to specified field Delete Field - deletes all values for specified field Delete Field Value - deletes single value for specified field Opaque data operations manipulate opaque data associated with a subscriber or a pool, for example, State and DynamicQuota, or PoolState and PoolDynamicQuota. Opaque data is not the same as field-value pairs and is not considered part of the entity data. Opaque data is managed separately and is typically stored in a well-defined format (such as XML).

Opaque data operations include: Fetch Opaque Data - retrieves opaque data of specified type Set Opaque Data - updates opaque data of specified type Delete Opaque Data - deletes opaque data of specified type Table 5: XML-REST operation syntax shows the operation types applicable for subscriber or pool provisioning with the associated XML-REST command and its meaning. The table also shows per operation type the subscriber operation syntax followed by a subscriber example. The same operation syntax applies to the pool entity by replacing sub/ with pool/. Table 5:

XML-REST operation syntax 47 910-6701-001 Revision A, June 2013 Type Operation CMD Meaning Operation Syntax and Examples Profile operations Fetch GET Display sub/{KeyName}/{KeyValue} sub/MSISDN/+33123654862 Add POST Add Update PUT Modify Delete DELETE Delete Field operations Fetch Field GET Display sub/{KeyName}/{KeyValue}/field/{FieldName}/{FieldValue} sub/MSISDN/+33123654862/field/BillingDay/1 sub/{KeyName}/{KeyValue}/field/{FieldName}/ {FieldValue1}/{FieldValue2} sub/MSISDN/+33123654862/field/Entitlement/ DayPass;HighSpeedData sub/{KeyName}/{KeyValue}/multipleFields/ {FieldName1}/{FieldValue1}/{FieldName2}/ {FieldValue2}/{FieldName3}/{FieldValue3} Fetch Field Value GET Display Set Field* PUT Modify Add Field Value POST Add Delete Field DELETE Delete