UdrDbResource
A REST Web Service for processing provisioning queries. This is a wrapper around the Firestorm RESTful API which is implemented in UdrDbResource The Firestorm API does not perform any validation of the incoming data. This wrapper will perform data validation on all the POST and PUT operations.
The following resources are applicable:
- /subscriber
- /subscriber/{guid}
- /subscriber/{guid}/alias
- /subscriber/{guid}/json/{schemaId}
- /subscriber/all
/subscriber
Mount Point: /subscriber
POST
Creates a subscriber.
Request Body
| element: | subscriberData |
| media types: | application/json |
Subscriber data, including aliases.
Response Body
| element: | (custom) |
| media types: | */* application/xml |
GUID for created subscriber.
GET
Gets the GUID for subscriber with given alias.
Parameters
| name | description | type | default |
|---|---|---|---|
| user_id | User Identifier, for example the phone number or SIP URI. | query | |
| type | Type of User Identifer. One of END_USER_E164, END_USER_IMSI, END_USER_SIP_URI, END_USER_NAI, END_USER_PRIVATE or END_USER_GLOBAL_UID. From RFC4006. | query |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
GUID for created alias.
/subscriber/{guid}
Mount Point: /subscriber/{guid}
The following operations are supported on this resource:
GET
Gets all information for the subscriber.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | The subscriber GUID | path |
Response Body
| element: | (custom) |
| media types: | application/json |
Subscriber details
PUT
Updates a subscriber (replaces all alias and data).
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | The subscriber GUID | path |
Request Body
| element: | subscriberData |
| media types: | application/json |
Subscriber data.
Response Body
| element: | (custom) |
| media types: | */* application/xml |
GUID for created alias.
DELETE
Deletes the subscriber.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | The subscriber GUID | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
HTTP Response.
/subscriber/{guid}/alias
Mount Point: /subscriber/{guid}/alias
GET
Gets all aliases for subscriber.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | The subscriber GUID | path |
Response Body
| element: | (custom) |
| media types: | application/json |
Subscriber details
PUT
Updates the list of user identifiers.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | The subscriber GUID | path |
Request Body
| element: | userIdAliases |
| media types: | application/json |
List of aliases to connect.
Response Body
| element: | (custom) |
| media types: | application/json |
HTTP Response.
/subscriber/{guid}/json/{schemaId}
Mount Point: /subscriber/{guid}/json/{schemaId}
The following operations are supported on this resource:
GET
Gets specific JSON data for subscriber.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | The subscriber GUID | path | |
| schemaId | Schema Id. | path |
Response Body
| element: | (custom) |
| media types: | application/json |
JSON data
PUT
Writes a JSON data field.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | The subscriber GUID | path | |
| schemaId | Schema id. | path |
Request Body
| element: | value |
| media types: | application/json |
Data value.
Response Body
| element: | (custom) |
| media types: | */* application/xml |
HTTP Response.
DELETE
Deletes a JSON data field.
Parameters
| name | description | type | default |
|---|---|---|---|
| guid | The subscriber GUID | path | |
| schemaId | Schema Id. | path |
Response Body
| element: | (custom) |
| media types: | */* application/xml |
HTTP Response.
/subscriber/all
Mount Point: /subscriber/all
GET
Gets all GUIDs in the database.
Response Body
| element: | (custom) |
| media types: | application/json |
list of GUIDs encoded as a JSON array
DELETE
PLEASE DO NOT document this API. Delete all subscribers from database. Should probably only be used during testing only.
Response Body
| element: | (custom) |
| media types: | */* application/xml |
No-Content response.