View or create permissions
Resource URI: /permission
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
totalResults | Total number of results |
currentPage | The page you are currently viewing. |
totalPages | Number of total pages. |
resultsPerPage | Number of permissions displayed on each page |
name | Name of the permission. |
label | Alternative name of the description. |
defaultValue | Default value. Displays True if it is enabled or False if it is disabled. |
type | |
builtIn |
Filtering Parameters:
Parameter | Description |
page | Required. The requested page size |
pagesize | Required. The number of results to be displayed per page. |
sortdir | Optional. Forward/reverse. |
sortby | Optional. Name/description. |
Specific Response Codes: N/A
HTTP Method: GET
Retrieves a list with all permissions and information on all permissions.
Example: XML format
<permissions>
<metadata>
<totalResults>18</totalResults>
<currentPage>1</currentPage>
<totalPages>18</totalPages>
<resultsPerPage>1</resultsPerPage>
</metadata>
<permissions>
<permission>
<name>900Dialing</name>
<label>900Dialing</label>
<defaultValue>false</defaultValue>
<type>CALL</type>
<builtIn>true</builtIn>
</permission>
</permissions>
</permissions>
HTTP Method: PUT
Adds a new permission. You must specify a body representing a new permission using the following template:
<permission>
<name>perm_7</name>
<label>API Create</label>
<description>Created through API 2</description>
<defaultValue>true</defaultValue>
<type>CALL</type>
<builtIn>false</builtIn>
</permission>
Where the name, type and builtIn elements are system generated.
Note that all new permissions are non-built-in Call permissions.
Unsupported HTTP Method: POST, DELETE
View or modify a permission ID
Resource URI: /permission/{name}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:
Property | Description |
permission | The permissions related information is similar to the one described under /permission. |
Specific Response Codes: Error 400 - when {name} not found or invalid
HTTP Method: GET
Retrieves information on the permission with the specified ID.
Example: XML format
<permission>
<name>900Dialing</name>
<label>900Dialing</label>
<defaultValue>false</defaultValue>
<type>CALL</type>
<builtIn>true</builtIn>
</permission>
JSON format
{"permission": {
"name": "900Dialing",
"label": "900Dialing",
"defaultValue": false,
"type": "CALL",
"builtIn": true
}}
HTTP Method: PUT
Updates permission with the specified ID. Uses same XML as for creation.
HTTP Method: DELETE
Removes permission with the specified ID.
Unsupported HTTP Method: POST