Cisco Unity Connection Provisioning Interface (CUPI) API -- Voice Network Map

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


Voice Network Map API

Administrator can use this API to fetch details of all the Unity Connection locations connected in HTTP(S) network. This API helps in creating the topology of HTTP(S) network, where the neighbor location information can be used to retrieve the directly connected Unity Connection location(s) associated with a particular location..


Listing of Voice Network Map Locations

The following is an example of the GET request that lists the details of location(s) joined in HTTP(S) network.

GET: https://<connectionserver>/vmrest/vnmaplocationhttpses 

The following is an example of the response from the above *GET* request:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<VnmapLocationHttpses total="3">
  <VnmapLocationHttps>
    <URI>/vmrest/vnmaplocationhttpses/1dc58282-0f24-4a60-b285-fec9c938e306</URI>
    <ObjectId>1dc58282-0f24-4a60-b285-fec9c938e306</ObjectId>
    <DisplayName> qa-ks-vm-482 </DisplayName>
    <HostAddress>10.78.171.140</HostAddress>
    <DestinationType>1</DestinationType>
    <LocationObjectId>1dc58282-0f24-4a60-b285-fec9c938e306</LocationObjectId>
    <LocationURI>/vmrest/locations/connectionlocations/1dc58282-0f24-4a60-b285-
  fec9c938e306</LocationURI>
    <MaxUsn>1488</MaxUsn>
    <LastUsn>1488</LastUsn>
    <ReplicationSetId>02fd1f6e-edcd-4023-9ddb-60b95bc4d3e9</ReplicationSetId>
    <Status>0</Status>
    <VoiceNameSyncStatus>0</VoiceNameSyncStatus>
    <TimeOfLastSync>2013-06-24T12:45:23Z</TimeOfLastSync>
    <NeighbourLocationObjectId>a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231</NeighbourLocationObjectId>
    <NeighbourLocationURI>/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-82ef-
  d82a1dc7f231</NeighbourLocationURI>
    <MediatorLocationObjectId>a5265a5e-1bc0-4ff4-82ef-
  d82a1dc7f231</MediatorLocationObjectId>
    <MediatorLocationURI>/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-82ef-
  d82a1dc7f231</MediatorLocationURI>
    <RetryQueueSizeCount>0</RetryQueueSizeCount>
    <IsPrimary>false</IsPrimary>
    <IsVpimBridgehead>false</IsVpimBridgehead>
    <DirectorySynchronizationRole>0</DirectorySynchronizationRole>
  </VnmapLocationHttps>
  <VnmapLocationHttps>
    <URI>/vmrest/vnmaplocationhttpses/a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231</URI>
    <ObjectId>a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231</ObjectId>
    <DisplayName> qa-ks-vm-483</DisplayName>
    <HostAddress>10.78.171.70</HostAddress>
    <DestinationType>1</DestinationType>
    <MaxUsn>0</MaxUsn>
    <LastUsn>0</LastUsn>
    <Status>0</Status>
    <VoiceNameSyncStatus>0</VoiceNameSyncStatus>
    <NeighbourLocationObjectId>a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231</NeighbourLocationObjectId>
    <NeighbourLocationURI>/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-82ef-
  d82a1dc7f231</NeighbourLocationURI>
    <MediatorLocationObjectId>a5265a5e-1bc0-4ff4-82ef-
  d82a1dc7f231</MediatorLocationObjectId>
    <MediatorLocationURI>/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-82ef-
  d82a1dc7f231</MediatorLocationURI>
    <RetryQueueSizeCount>0</RetryQueueSizeCount>
    <IsPrimary>true</IsPrimary>
    <IsVpimBridgehead>false</IsVpimBridgehead>
    <DirectorySynchronizationRole>0</DirectorySynchronizationRole>
  </VnmapLocationHttps>
  <VnmapLocationHttps>
    <URI>/vmrest/vnmaplocationhttpses/5e17e059-38c9-4801-ab9e-39008cd46c4e</URI>
    <ObjectId>5e17e059-38c9-4801-ab9e-39008cd46c4e</ObjectId>
    <DisplayName> qa-ks-vm-493 </DisplayName>
    <HostAddress>10.76.214.63</HostAddress>
    <DestinationType>1</DestinationType>
    <MaxUsn>14421</MaxUsn>
    <LastUsn>14421</LastUsn>
    <ReplicationSetId>34fd1f6e-63cd-4023-9ddb-60b95bc4d3e9</ReplicationSetId>
    <Status>0</Status>
    <VoiceNameSyncStatus>0</VoiceNameSyncStatus>
    <TimeOfLastSync>2013-06-24T12:47:23Z</TimeOfLastSync>
    <NeighbourLocationObjectId>1dc58282-0f24-4a60-b285-
  fec9c938e306</NeighbourLocationObjectId>
    <NeighbourLocationURI>/vmrest/locations/connectionlocations/1dc58282-0f24-4a60-b285-
  fec9c938e306</NeighbourLocationURI>
    <MediatorLocationObjectId>1dc58282-0f24-4a60-b285-fec9c938e306</MediatorLocationObjectId>
    <MediatorLocationURI>/vmrest/locations/connectionlocations/1dc58282-0f24-4a60-
  b285-fec9c938e306</MediatorLocationURI>
    <RetryQueueSizeCount>0</RetryQueueSizeCount>
    <IsPrimary>false</IsPrimary>
    <IsVpimBridgehead>false</IsVpimBridgehead>
    <DirectorySynchronizationRole>0</DirectorySynchronizationRole>
  </VnmapLocationHttps>
</VnmapLocationHttpses>
Response Code: 200

JSON Example to GET list the details of locations joined in HTTP(S) network:

GET: https://<connectionserver>/vmrest/vnmaplocationhttpses 

Accept: application/json
Content-type: application/json
Connection: keep-alive

The following is the response from the above *GET* request:
(
  {
  "@total":"3",
  "VnmapLocationHttps":[
   {                    
    "URI":"/vmrest/vnmaplocationhttpses/1dc58282-0f24-4a60-b285-fec9c938e306",
    "ObjectId":"1dc58282-0f24-4a60-b285-fec9c938e306",
    "DisplayName":" qa-ks-vm-482",
    "HostAddress":"10.78.171.140",
    "DestinationType":"1",
    "LocationObjectId":"1dc58282-0f24-4a60-b285-fec9c938e306",
    "LocationURI":"/vmrest/locations/connectionlocations/1dc58282-0f24-4a60-b285-
  fec9c938e306",
    "MaxUsn":"1488",
    "LastUsn":"1488",
    "ReplicationSetId":"02fd1f6e-edcd-4023-9ddb-60b95bc4d3e9",
    "Status":"0",
    "VoiceNameSyncStatus":"0",
    "TimeOfLastSync":"2013-06-24T12:46:14Z",
    "NeighbourLocationObjectId":"a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231",
    "NeighbourLocationURI":"/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-
  82ef-d82a1dc7f231",
    "MediatorLocationObjectId":"a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231",
    "MediatorLocationURI":"/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-
  82ef-d82a1dc7f231",
    "RetryQueueSizeCount":"0",
    "IsPrimary":"false",
    "IsVpimBridgehead":"false",
    "DirectorySynchronizationRole":"0"
   },
   {
    "URI":"/vmrest/vnmaplocationhttpses/a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231",
    "ObjectId":"a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231",
    "DisplayName":" qa-ks-vm-483",
    "HostAddress":"10.78.171.70",
    "DestinationType":"1",
    "MaxUsn":"0",
    "LastUsn":"0",
    "Status":"0",
    "VoiceNameSyncStatus":"0",
    "NeighbourLocationObjectId":"a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231",
    "NeighbourLocationURI":"/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-
  82ef-d82a1dc7f231",
    "MediatorLocationObjectId":"a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231",
    "MediatorLocationURI":"/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-
  82ef-d82a1dc7f231",
    "RetryQueueSizeCount":"0",
    "IsPrimary":"true",
    "IsVpimBridgehead":"false",
    "DirectorySynchronizationRole":"0"
  },
  {
    "URI":"/vmrest/vnmaplocationhttpses/5e17e059-38c9-4801-ab9e-39008cd46c4e",
    "ObjectId":"5e17e059-38c9-4801-ab9e-39008cd46c4e",
    "DisplayName":" qa-ks-vm-493",
    "HostAddress":"10.76.214.63",
    "DestinationType":"1",
    "MaxUsn":"0",
    "LastUsn":"0",
    “ReplicationSetId”:“34fd1f6e-63cd-4023-9ddb-60b95bc4d3e9”
    "Status":"0",
    "VoiceNameSyncStatus":"0",
    “TimeOfLastSync”: “2013-06-24T12:47:23Z”
    "NeighbourLocationObjectId":"1dc58282-0f24-4a60-b285-fec9c938e306",
    "NeighbourLocationURI":"/vmrest/locations/connectionlocations/1dc58282-0f24-4a60-
  b285-fec9c938e306",
    "MediatorLocationObjectId":"1dc58282-0f24-4a60-b285-fec9c938e306",
    "MediatorLocationURI":"/vmrest/locations/connectionlocations/1dc58282-0f24-4a60-
  b285-fec9c938e306",
    "RetryQueueSizeCount":"0",
    "IsPrimary":"true",
    "IsVpimBridgehead":"false",
    "DirectorySynchronizationRole":"0"
  }
  ]
  }
}
Response Code: 200


Viewing of Voice Network Map Location

The following is an example of the GET request that fetches the details of a particular location joined in HTTP(S) network.

GET: https://<connectionserver>/vmrest/vnmaplocationhttpses/1dc58282-0f24-4a60-b285-
fec9c938e306

The following is an example of the response from the above *GET* request:

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<VnmapLocationHttps>
    <URI>/vmrest/vnmaplocationhttpses/1dc58282-0f24-4a60-b285-fec9c938e306</URI>
    <ObjectId>1dc58282-0f24-4a60-b285-fec9c938e306</ObjectId>
    <DisplayName> qa-ks-vm-482 </DisplayName>
    <HostAddress>10.78.171.140</HostAddress>
    <DestinationType>1</DestinationType>
    <LocationObjectId>1dc58282-0f24-4a60-b285-fec9c938e306</LocationObjectId>
    <LocationURI>/vmrest/locations/connectionlocations/1dc58282-0f24-4a60-b285-
  fec9c938e306</LocationURI>
    <MaxUsn>1488</MaxUsn>
    <LastUsn>1488</LastUsn>
    <ReplicationSetId>02fd1f6e-edcd-4023-9ddb-60b95bc4d3e9</ReplicationSetId>
    <Status>0</Status>
    <VoiceNameSyncStatus>0</VoiceNameSyncStatus>
    <TimeOfLastSync>2013-06-24T12:45:23Z</TimeOfLastSync>
    <NeighbourLocationObjectId>a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231</NeighbourLocationObjectId>
    <NeighbourLocationURI>/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-82ef-
  d82a1dc7f231</NeighbourLocationURI>
    <MediatorLocationObjectId>a5265a5e-1bc0-4ff4-82ef-
  d82a1dc7f231</MediatorLocationObjectId>
    <MediatorLocationURI>/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-82ef-
  d82a1dc7f231</MediatorLocationURI>
    <RetryQueueSizeCount>0</RetryQueueSizeCount>
    <IsPrimary>false</IsPrimary>
    <IsVpimBridgehead>false</IsVpimBridgehead>
    <DirectorySynchronizationRole>0</DirectorySynchronizationRole>
</VnmapLocationHttps>
Response Code: 200

JSON Example to GET the details of particular Voice network map location of HTTP(S) network:

GET: https://<connectionserver>/vmrest/vnmaplocationhttpses/1dc58282-0f24-4a60-b285-
fec9c938e306

Accept: application/json
Content-type: application/json
Connection: keep-alive

The following is the response from the above *GET* request:
<pre>
  ({
    "URI":"/vmrest/vnmaplocationhttpses/1dc58282-0f24-4a60-b285-fec9c938e306",
    "ObjectId":"1dc58282-0f24-4a60-b285-fec9c938e306",
    "DisplayName":" qa-ks-vm-482",
    "HostAddress":"10.78.171.140",
    "DestinationType":"1",
    "LocationObjectId":"1dc58282-0f24-4a60-b285-fec9c938e306",
    "LocationURI":"/vmrest/locations/connectionlocations/1dc58282-0f24-4a60-b285-
  fec9c938e306",
    "MaxUsn":"1488",
    "LastUsn":"1488",
    "ReplicationSetId":"02fd1f6e-edcd-4023-9ddb-60b95bc4d3e9",
    "Status":"0",
    "VoiceNameSyncStatus":"0",
    "TimeOfLastSync":"2013-06-24T12:46:14Z",
    "NeighbourLocationObjectId":"a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231",
    "NeighbourLocationURI":"/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-
  82ef-d82a1dc7f231",
    "MediatorLocationObjectId":"a5265a5e-1bc0-4ff4-82ef-d82a1dc7f231",
    "MediatorLocationURI":"/vmrest/locations/connectionlocations/a5265a5e-1bc0-4ff4-
  82ef-d82a1dc7f231",
    "RetryQueueSizeCount":"0",
    "IsPrimary":"false",
    "IsVpimBridgehead":"false",
    "DirectorySynchronizationRole":"0"
  }
)
Response Code: 200


Explanation of Data Fields

Parameter Data Type Operations Description
URI String Read-Only Voice Network Map URI
ObjectId char(36) Read-Only Object ID of Voice Network Map Location
DisplayName nvarchar(64) Read-Only Specifies the display name of the location.
HostAddress varchar(40) Read-Only Specifies the IP address of the location
DestinationType int Read-Only Specifies the destination type for the location, e.g. Connection, Unity, VPIM, Bridge.

Values can be:

  • 1 – Connection
  • 2 – Unity
  • 8 – VPIM
LocationObjectId char(36) Read-Only Specifies the Object id of the location.
LocationURI String Read-Only Location URI
MaxUsn bigint Read-Only Specifies the maximum USN received in feed response.
LastUsn bigint Read-Only Specifies the last USN synched.
ReplicationSetId Specifies the Replication Set of the location.
Status smallint Read-Only Indicates the status of the directory synchronization with the location.

Values can be:

  • 0-Idle
  • 1-synching
VoiceNameSyncStatus smallint Read-Only Indicates the status of voice name synchronization with the location.

Values can be: 0- Idle 1- Synching

TimeOfLastSync datetime Read-Only Reflects the time at which the location was last synchronized.
NeighbourLocationObjectId char(36) Read-Only Specifies Object Id of neighbour location.

Note: Neighbour location of location A on B is the farthest location which is directly connected to location A while traversing from location B till A.

NeighbourLocationURI String Read-Only Neighbour Location URI
MediatorLocationObjectId char(36) Read-Only Specified the object id of Mediator location.

Note: Mediator location of a location A on B is the http(s) link(location) via which location A has been synchronized.

MediatorLocationURI String Read-Only Mediator Location URI
RetryQueueSizeCount bigint Read-Only Specifies the count of errors encountered during synchronization of the location.
IsPrimary Boolean Read-Only Specifies whether the location is primary location.

Values can be:

  • 0 – true
  • 1 – false
IsVpimBridgehead Boolean Read-Only Specifies whether the location is VPIM bridgehead.

Values can be:

  • 0 – true
  • 1 – false
DirectorySynchronizationRole smallint Read-Only Specifies the directory synchronization mode in the cluster.

Values can be:

  • 0-Standard
  • 1-Alert

Rating: 0.0/5 (0 votes cast)

Personal tools