View avatar information

Resource URI: /avatar/{user}
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: GET
Retrieves avatar content for the specified user.
Example: N/A
Unsupported HTTP Method: POST, PUT, DELETE

View or modify users

Resource URI: /user
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Filtering Parameters:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on all users. Parameters to specify sorting are optional, but you should use both if you want sorting. If you only use the "sortdir" parameter, it defaults to "name".
Example: XML format
<user>
<metadata>
<totalResults>2</totalResults>
<currentPage>1</currentPage>
<totalPages>1</totalPages>
<resultsPerPage>2</resultsPerPage>
</metadata>
 <id>21</id>
 <userName>208</userName>
 <lastName>Zor-El</lastName>
 <firstName>Kara</firstName>
 <pin></pin>
 <sipPassword>208</sipPassword>
 <groups>
   <group>
     <id>5</id>
     <name>JusticeLeague</name>
     <description>Superheroes of America</description>
   </group>
 </groups>
 <branch>
   <id>1</id>
   <name>HallOfJustice</name>
   <description>API Testing</description>
 </branch>
 <aliases>
   <alias>
     <alias>supergirl</alias>
   </alias>
   <alias>
     <alias>kara</alias>
   </alias>
 </aliases>
</user>
JSON format
{"user": {
"metadata": {
"totalResults": 2,
"currentPage": 1,
"totalPages": 1,
"resultsPerPage": 2
},

"users": [

{
"id": 10,
"userName": "205",
"pin": "",
"sipPassword": "",

"groups": [

{
"id": 9,
"name": "IMGroup"
}
],

"aliases": [

]
},
{
"id": 11,
"userName": "206",
"pin": "",
"sipPassword": "",

"groups": [

],

"aliases": [

]
}
]
}}
HTTP Method: PUT
Adds a new user. Notes:

• The ID is auto-generated and any value will be ignored.
• If the Pin is empty the current PIN value will be preserved.
• The Branch, Groups and Aliases elements are optional.

Unsupported HTTP Method: POST, DELETE

View or modify a user ID

Resource URI: /user/{id}
Default Resource Properties:
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on user with the specified ID
Example: XML format
<user>
<id>10</id>
<userName>205</userName>
<pin />
<sipPassword />
<groups>
<group>
<id>9</id>
<name>IMGroup</name> </group>
</groups>
<aliases /> </user>
JSON format
{"user": {
"id": 10,
"userName": "205",
"pin": "",
"sipPassword": "",

"groups": [

{
"id": 9,
"name": "IMGroup"
}
],

"aliases": [

]
}}
HTTP Method: PUT
Updates user with specified ID. Uses same XML as for creation. After an update the response data will contain an ID element with the "id" value of the item affected.
HTTP Method: DELETE
Removes user with the specified ID.
Unsupported HTTP Method: POST

View permissions for all users

Resource URI: /user-permission
Default Resource Properties: N/A
Filtering Parameters:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on all users and their permission settings.
Unsupported HTTP Method: POST, PUT, DELETE

View or modify permissions for a user ID

Resource URI: /user-permission/{id}
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:

Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on user with the specified id and its permissions.
Example: XML format
<user>
<id>30</id>
<lastName>Fury</lastName>
<firstName>Nick</firstName>
<permissions>
<setting>
<name>900Dialing</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>AutoAttendant</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>ExchangeUMVoicemailServer</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>FreeswitchVoicemailServer</name>
value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>InternationalDialing</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>LocalDialing</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>LongDistanceDialing</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>Mobile</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>RecordSystemPrompts</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>TollFree</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>Voicemail</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>music-on-hold</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>perm_3</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>perm_4</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>perm_7</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>personal-auto-attendant</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>subscribe-to-presence</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
<setting>
<name>superadmin</name>
<value>DISABLE</value>
<defaultValue>false</defaultValue>
</setting>
<setting>
<name>tui-change-pin</name>
<value>ENABLE</value>
<defaultValue>true</defaultValue>
</setting>
</permissions>
</user>
HTTP Method: PUT
Sets permission values for a user.
Unsupported HTTP Method: POST, DELETE