Cisco Unity Connection Provisioning Interface (CUPI) API -- Call Handler Owner APIs

From DocWiki

Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation


Contents


Call Handler Owner APIs

Add a Call Handler Owner

The following is an example of the *POST* request that can be used to create a new call handler owner. The RoleObjectId should be a Greeting Administrator role's ID.

POST https://<connection-server>/vmrest/handlers/callhandlers/<callhandler-objectid>/callhandlerowners
Request Body:
<CallhandlerOwner>
    <UserObjectId>c0430be2-52b8-46d7-8fad-c6aa13781469</UserObjectId>
    <RoleObjectId>4f077e4e-61c7-4ce8-a58a-2c4bc6089319</RoleObjectId>
</CallhandlerOwner>

Note: Here, UserObjectId can be fetched from

GET https://<connection-server>/vmrest/users 

and RoleObjectId can be fetched from

GET https://<connection-server>/vmrest/roles.

The following is the response from the above *POST* request and the actual response will depend upon the information given by you:

Response Code: 201
/vmrest/handlers/callhandlers/c0430be2-52b8-46d7-8fad-c6aa13781469

JSON Example

To create a call handler owner, do the following:

POST https://<connection-server>/vmrest/handlers/callhandlers/<callhandler-objectid>/callhandlerowners
Accept: application/json
Content_type: application/json
Connection: keep_alive

The following is the response from the above *POST* request and the actual response will depend upon the information given by you:

{
    "UserObjectId": "5aeb75a4-14c2-474d-bec9-90aa731ee4cc",
    "RoleObjectId": "a3a0ef4d-f788-4dc8-b3be-4442316342a6"
}
Response Code: 201
/vmrest/handlers/callhandlers/c0430be2-52b8-46d7-8fad-c6aa13781469

View the Call Handler Owners

The following is an example of the Get request that can be used to fetch the call handler owners:

GET https://<connection-server>/vmrest/handlers/callhandlers/<callhandler-objectid>/callhandlerowners

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

<CallhandlerOwners total="1">
  <CallhandlerOwner>
    <URI>/vmrest/handlers/callhandlers/4afc0de6-c52c-42e4-99bb-
  6359bd518f11/callhandlerowners/a6731eca-ba31-4cee-a367-0bd6f45c633f</URI>
    <ObjectId>a6731eca-ba31-4cee-a367-0bd6f45c633f</ObjectId>
    <UserObjectId>eaacd744-6fe1-4085-8b25-10c702fdfd20</UserObjectId>
    <UserURI>/vmrest/users/eaacd744-6fe1-4085-8b25-10c702fdfd20</UserURI>
    <RoleObjectId>4f077e4e-61c7-4ce8-a58a-2c4bc6089319</RoleObjectId>
    <RoleURI>/vmrest/roles/4f077e4e-61c7-4ce8-a58a-2c4bc6089319</RoleURI>
    <DateCreated>2012-12-30T06:46:51Z</DateCreated>
    <TargetHandlerObjectId>4afc0de6-c52c-42e4-99bb-
  6359bd518f11</TargetHandlerObjectId>
  </CallhandlerOwner>
</CallhandlerOwners>
Response Code: 200

JSON Example

To view the list of call handler owners, do the following:

GET https://<connection-server>/vmrest/handlers/callhandlers/<callhandler-objectid>/callhandlerowners
Accept: application/json
Connection: keep_alive

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

{
    "@total": "1",
    "CallhandlerOwner": {
    "URI": "/vmrest/handlers/callhandlers/b2d3d56a-f0c2-4839-98c5-
    48770690244a/callhandlerowners/ac6dda36-798d-4eea-9055-db5a31eb5599",
    "ObjectId": "ac6dda36-798d-4eea-9055-db5a31eb5599",
    "UserObjectId": "5aeb75a4-14c2-474d-bec9-90aa731ee4cc",
    "UserURI": "/vmrest/users/5aeb75a4-14c2-474d-bec9-90aa731ee4cc",
    "RoleObjectId": "a3a0ef4d-f788-4dc8-b3be-4442316342a6",
    "RoleURI": "/vmrest/roles/a3a0ef4d-f788-4dc8-b3be-4442316342a6",
    "DateCreated": "2013-02-18T07:58:55Z",
    "TargetHandlerObjectId": "b2d3d56a-f0c2-4839-98c5-48770690244a"
    }
}
Response Code: 200

View the Details of Specific Call Handler Owner

The following is an example of the Get request that can be used to fetch the specific call handler owner details:

GET https://<connection-server>/vmrest/handlers/callhandlers/<callhandler-objectid>/callhandlerowners/<callHandlerowner-objectid>

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

<CallhandlerOwner>
    <URI>/vmrest/handlers/callhandlers/4afc0de6-c52c-42e4-99bb-
  6359bd518f11/callhandlerowners/a6731eca-ba31-4cee-a367-0bd6f45c633f</URI>
    <ObjectId>a6731eca-ba31-4cee-a367-0bd6f45c633f</ObjectId>
    <UserObjectId>eaacd744-6fe1-4085-8b25-10c702fdfd20</UserObjectId>
    <UserURI>/vmrest/users/eaacd744-6fe1-4085-8b25-10c702fdfd20</UserURI>
    <RoleObjectId>4f077e4e-61c7-4ce8-a58a-2c4bc6089319</RoleObjectId>
    <RoleURI>/vmrest/roles/4f077e4e-61c7-4ce8-a58a-2c4bc6089319</RoleURI>
    <DateCreated>2012-12-30T06:46:51Z</DateCreated>
    <TargetHandlerObjectId>4afc0de6-c52c-42e4-99bb-6359bd518f11</TargetHandlerObjectId>
  </CallhandlerOwner>
Response Code: 200

JSON Example

To view a specific call handler owner, do the following:

GET https://<connection-server>/vmrest/handlers/callhandlers/<callhandler-objectid>/callhandlerowners/<callhandlerowner-objectid>
Accept: application/json
Connection: keep_alive

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

{
    "URI": "/vmrest/handlers/callhandlers/b2d3d56a-f0c2-4839-98c5-
    48770690244a/callhandlerowners/ac6dda36-798d-4eea-9055-db5a31eb5599",
    "ObjectId": "ac6dda36-798d-4eea-9055-db5a31eb5599",
    "UserObjectId": "5aeb75a4-14c2-474d-bec9-90aa731ee4cc",
    "UserURI": "/vmrest/users/5aeb75a4-14c2-474d-bec9-90aa731ee4cc",
    "RoleObjectId": "a3a0ef4d-f788-4dc8-b3be-4442316342a6",
    "RoleURI": "/vmrest/roles/a3a0ef4d-f788-4dc8-b3be-4442316342a6",
    "DateCreated": "2013-02-18T07:58:55Z",
    "TargetHandlerObjectId": "b2d3d56a-f0c2-4839-98c5-48770690244a"
}
Response Code: 200

Delete a Call Handler Owner

The following is an example of the DELETE request that can be used to delete a call handler owner:

DELETE https://<connection-server>/vmrest/callhandlers/<callhandlerId>/callhandlerowners/<callhandlerowner-objectid>

The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:

Response Code: 204

JSON Example

To delete a call handler owner, do the following:

DELETE https://<connection-server>/vmrest/callhandlers/<callhandler-objectid>/callhandlerowners/<callhandlerowner-objectid>
Accept: application/json
Connection: keep_alive

The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:

Response Code: 204


Explanation of Data Fields

Parameter Operations Data Type Comments
ObjectID Read Only String(36) Specifies an object ID to uniquely identify a call handler owner.
UserObjectId Read/Write String(36) Specifies an object ID of the user who owns the call handler.
VmsObjectId Read Only String(36) Specifies an unique identifier of the LocationVMS object.
RoleObjectId Read Only String(36) Specifies an object ID of the role assigned to the call handler owner.
DateCreated Read Only DateTime Specifies the date on which the user was added as a call handler owner.
TargetHandlerObjectId Read Only String(36) Specifies an object ID of the call handler to which the call handler owner object belongs.
UserURI Read Only String Specifies URI to get details of the user who owns the Call Handler.
RoleURI Read Only String Specifies URI to get details of the role assigned to the Call Handler Owner

Rating: 0.0/5 (0 votes cast)

Personal tools