Listing the Branches
The following is an example of the *GET* request that lists the branches associated with the Cisco Unity Connection server:
GET https://<connection-server>/vmrest/branches
The following is an example of response from the above *GET* request but the actual result depends on the information provided by you:
Response Code: 200
<Branches total="2">
<Branch>
<URI>/vmrest/branches/1e0ed69d-028d-4156-9d68-f14a90438448</URI>
<ObjectId>1e0ed69d-028d-4156-9d68-f14a90438448</ObjectId>
<IsAlive>true</IsAlive>
<IsDisabled>false</IsDisabled>
<OperatorObjectId>159bb671-cbba-4964-b06b-871f990e1de8</OperatorObjectId>
<Port>443</Port>
<ProvisionState>0</ProvisionState>
<ServerAddress>mysrsv.cisco.com</ServerAddress>
<SyncGreetings>false</SyncGreetings>
<SyncVoiceName>false</SyncVoiceName>
<UserName>admin</UserName>
<VmUploadState>0</VmUploadState>
<DisplayName>Branch1</DisplayName>
<PartitionObjectId>d6ac04c5-fb36-4e21-9e60-d15e0f9c6971</PartitionObjectId>
<PartitionURI>/vmrest/partitions/d6ac04c5-fb36-4e21-9e60-d15e0f9c6971</PartitionURI>
<SmtpDomain>mysrsv.cisco.com</SmtpDomain>
</Branch>
<Branch>
<URI>/vmrest/branches/c3816faf-8dc6-48f3-9c6a-b8e93bba1c42</URI>
<ObjectId>c3816faf-8dc6-48f3-9c6a-b8e93bba1c42</ObjectId>
<IsAlive>true</IsAlive>
<IsDisabled>false</IsDisabled>
<OperatorObjectId>159bb671-cbba-4964-b06b-871f990e1de8</OperatorObjectId>
<Port>443</Port>
<ProvisionState>0</ProvisionState>
<ServerAddress>mysrsv1.cisco.com</ServerAddress>
<SyncGreetings>false</SyncGreetings>
<SyncVoiceName>false</SyncVoiceName>
<UserName>admin</UserName>
<VmUploadState>0</VmUploadState>
<DisplayName>Branch2</DisplayName>
<PartitionObjectId>765cd618-0cff-43a4-b781-efdba282dba4</PartitionObjectId>
<PartitionURI>/vmrest/partitions/765cd618-0cff-43a4-b781-efdba282dba4</PartitionURI>
<SmtpDomain>mysrsv1.cisco.com</SmtpDomain>
</Branch>
</Branches>
The following chart lists the data fields:
Field Name |
Read/Write |
Possible Values |
Description |
---|---|---|---|
ObjectId |
Read/Write |
objectid |
The object id of the branch at central Unity Connection server. |
IsAlive |
Read |
true/false |
Connectivity status between the central Unity Connection server and the branch server. |
IsDisabled |
Read/Write |
true/false |
Disabled status of branch on the central Unity Connection server. |
OperatorObjectId |
Read/Write |
objectid |
The object id of the user who is assigned as the operator user for the branch on the central Unity Connection server. |
Port |
Read/Write |
Port number |
PAT port number for the branch server. |
ProvisionState |
Read/Write |
0 – Idle, 1 – Scheduled, 2 – In-progress |
Current provisioning status of branch on the central Unity Connection server. |
ServerAddress |
Read/Write |
FQDN, IP Address |
The address of the branch server. |
SyncGreetings |
Read/Write |
true/false |
Option to enable/disable syncing of greetings for users. |
SyncVoiceName |
Read/Write |
true/false |
Option to enable/disable syncing of voice names for users. |
UserName |
Read/Write |
String |
Username to be used for REST communication between the central Unity Connection and the branch server. |
VmUploadState |
Read/Write |
0 – Idle, 1 – Scheduled, 2 – In-progress |
Displays the status of the current voicemail upload status from branch to the central Unity Connection server. |
DisplayName |
Read/Write |
String |
Display name of the branch Unity Connection SRSV server on the central Unity Connection server. |
PartitionObjectId |
Read/Write |
ObjectId |
Partition object ID associated with the branch on the central Unity Connection server. |
SmtpDomain |
Read/Write |
Domain name |
SMTP domain of the branch server. |