Cisco Unity Connection Provisioning Interface (CUPI) API -- Examples of Basic Operations

From DocWiki

Revision as of 22:25, 13 December 2010 by Juliew (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation

Contents



Reading a User's Information

To read a user's information, do the following GET request:

GET http://<connection-server>/vmrest/users/{objectid}


Creating a User

To create a user account, do the following POST request:

POST http://<connection-server>/vmrest/users?templateAlias=voicemailusertemplate
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<User>
<Alias>jdoe</Alias>
<DtmfAccessId>7890</DtmfAccessId>
</User>

The following is the result of the above POST request:

201 Created

The HTTP response will include the full URI to the newly created user in the Location header.


Modifying a User

To modify a user account, do the following PUT request:

PUT http://<connection-server>/vmrest/users/{objectid}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<User>
<DisplayName>johnd</DisplayName>
</User>

The following is the result of the above PUT request:

204 Accepted


Deleting a User

To delete a user account, do the following DELETE request:

DELETE http://<connection-server>/vmrest/users/{objectid}

The following is the result of the above DELETE request:

200 OK


Searching for a User

To search for a user account, do the following GET request:

GET http://<connection-server>/vmrest/users?query=(alias%20startswith%20ab)

Rating: 0.0/5 (0 votes cast)

Personal tools