Cisco Unity Connection Provisioning Interface (CUPI) API -- Default User Template

From DocWiki

Latest revision as of 09:37, 3 October 2012

Links to Other API pages: Cisco_Unity_Connection_APIs

About Default Templates

This section contains information on how to list and modify default User Templates. Cisco Unity Connection comes with the following predefined user templates, which you can modify but not delete:

• Voice Mail User Template
• Administrator Template

For information on minimum software required with this API, see Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API_--_Basic_User_Template_Information#Minimum_Software_Version

Listing Default Templates

Example 1

The following is an example of the GET request that lists the default User Templates:

 https://<connection_server>/vmrest/userdefaulttemplates 

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

<DefaultUserTemplates total="2">
<DefaultUserTemplate>
 <URI>
  /vmrest/defaultusertemplates/48caecef-6f7a-47aa-91cb-019b761fce69
 </URI>
 <ObjectId>48caecef-6f7a-47aa-91cb-019b761fce69</ObjectId>
 <UseDefaultLanguage>true</UseDefaultLanguage>
 <UseDefaultTimeZone>true</UseDefaultTimeZone>
 <Alias>administratortemplate1</Alias>
 <City/>
 <State/>
 <Country>US</Country>
 <PostalCode/>
 <Department/>
 <Building/>
 <Address/>
 <DisplayName>Administrator Template</DisplayName>
 <BillingId/>
 <TimeZone>190</TimeZone>
 <CreationTime>2012-07-09T07:27:43Z</CreationTime>
 <Language>1033</Language>
 <LocationObjectId>be27976c-6e6e-419f-853d-b3764881dfb0</LocationObjectId>
 <LocationURI>
  /vmrest/locations/connectionlocations/be27976c-6e6e-419f-853d-b3764881dfb0
 </LocationURI>
 <DisplayNameRule>1</DisplayNameRule>
 <DoesntExpire>false</DoesntExpire>
 <CantChange>false</CantChange>
 <RouteNDRToSender>true</RouteNDRToSender>
 <Undeletable>true</Undeletable>
 <ReadOnly>false</ReadOnly>
 <PartitionObjectId>c2ecf6c5-b3c2-45f4-99fc-e065056501d5</PartitionObjectId>
 <PartitionURI>
  /vmrest/partitions/c2ecf6c5-b3c2-45f4-99fc-e065056501d5
 </PartitionURI>
 <LdapType>0</LdapType>
 <CreateSmtpProxyFromCorp>false</CreateSmtpProxyFromCorp>
 <DefaultUserTemplateWebPasswordURI>
 /vmrest/usertemplates/48caecef-6f7a-47aa-91cb-019b761fce69/credential/password
 </DefaultUserTemplateWebPasswordURI>
 <DefaultUserTemplateVoicePinURI>
 /vmrest/usertemplates/48caecef-6f7a-47aa-91cb-019b761fce69/credential/pin
 </DefaultUserTemplateVoicePinURI>
</DefaultUserTemplate>
<DefaultUserTemplate>
 <URI>
 /vmrest/defaultusertemplates/bc0eedd5-0483-4362-a091-5f89d27b7b3c
 </URI>
 <ObjectId>bc0eedd5-0483-4362-a091-5f89d27b7b3c</ObjectId>
 <UseDefaultLanguage>true</UseDefaultLanguage>
 <UseDefaultTimeZone>true</UseDefaultTimeZone>
 <Alias>voicemailusertemplate</Alias>
 <DisplayName>Voice Mail User Template</DisplayName>
 <TimeZone>190</TimeZone>
 <CreationTime>2012-07-09T07:27:44Z</CreationTime>
 <CosObjectId>305a9699-03a8-41d0-9215-0fcd32d600b0</CosObjectId>
 <CosURI>/vmrest/coses/305a9699-03a8-41d0-9215-0fcd32d600b0</CosURI>
 <Language>1033</Language>
 <LocationObjectId>be27976c-6e6e-419f-853d-b3764881dfb0</LocationObjectId>
 <LocationURI>
 /vmrest/locations/connectionlocations/be27976c-6e6e-419f-853d-b3764881dfb0
 </LocationURI>
 <DisplayNameRule>1</DisplayNameRule>
 <DoesntExpire>false</DoesntExpire>
 <CantChange>false</CantChange>
 <MailboxStoreObjectId>15dd71c8-2ba1-4efa-a34e-01613a0d2ef7</MailboxStoreObjectId>
 <RouteNDRToSender>true</RouteNDRToSender>
 <Undeletable>true</Undeletable>
 <ReadOnly>false</ReadOnly>
 <PartitionObjectId>c2ecf6c5-b3c2-45f4-99fc-e065056501d5</PartitionObjectId>
 <PartitionURI>
  /vmrest/partitions/c2ecf6c5-b3c2-45f4-99fc-e065056501d5
 </PartitionURI>
 <LdapType>0</LdapType>
 <CreateSmtpProxyFromCorp>false</CreateSmtpProxyFromCorp>
 <DefaultUserTemplateWebPasswordURI>
  /vmrest/usertemplates/bc0eedd5-0483-4362-a091-5f89d27b7b3c/credential/password
 </DefaultUserTemplateWebPasswordURI>
 <DefaultUserTemplateVoicePinURI>
 /vmrest/usertemplates/bc0eedd5-0483-4362-a091-5f89d27b7b3c/credential/pin
 </DefaultUserTemplateVoicePinURI>
</DefaultUserTemplate>
</DefaultUserTemplates>

 Response code: 200 

Example 2

The following is an example of the GET request that lists a specified default User Templates:

 https://<connection_server>/vmrest/userdefaulttemplates/<objectId> 

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

<DefaultUserTemplate>
 <URI>
  /vmrest/defaultusertemplates/48caecef-6f7a-47aa-91cb-019b761fce69
 </URI>
 <ObjectId>48caecef-6f7a-47aa-91cb-019b761fce69</ObjectId>
 <UseDefaultLanguage>true</UseDefaultLanguage>
 <UseDefaultTimeZone>true</UseDefaultTimeZone>
 <Alias>administratortemplate1</Alias>
 <City/>
 <State/>
 <Country>US</Country>
 <PostalCode/>
 <Department/>
 <Building/>
 <Address/>
 <DisplayName>Administrator Template</DisplayName>
 <BillingId/>
 <TimeZone>190</TimeZone>
 <CreationTime>2012-07-09T07:27:43Z</CreationTime>
 <Language>1033</Language>
 <LocationObjectId>be27976c-6e6e-419f-853d-b3764881dfb0</LocationObjectId>
 <LocationURI>
  /vmrest/locations/connectionlocations/be27976c-6e6e-419f-853d-b3764881dfb0
 </LocationURI>
 <DisplayNameRule>1</DisplayNameRule>
 <DoesntExpire>false</DoesntExpire>
 <CantChange>false</CantChange>
 <RouteNDRToSender>true</RouteNDRToSender>
 <Undeletable>true</Undeletable>
 <ReadOnly>false</ReadOnly>
 <PartitionObjectId>c2ecf6c5-b3c2-45f4-99fc-e065056501d5</PartitionObjectId>
 <PartitionURI>
  /vmrest/partitions/c2ecf6c5-b3c2-45f4-99fc-e065056501d5
 </PartitionURI>
 <LdapType>0</LdapType>
 <CreateSmtpProxyFromCorp>false</CreateSmtpProxyFromCorp>
 <DefaultUserTemplateWebPasswordURI>
  /vmrest/usertemplates/48caecef-6f7a-47aa-91cb-019b761fce69/credential/password
 </DefaultUserTemplateWebPasswordURI>
 <DefaultUserTemplateVoicePinURI>
  /vmrest/usertemplates/48caecef-6f7a-47aa-91cb-019b761fce69/credential/pin
 </DefaultUserTemplateVoicePinURI>
 </DefaultUserTemplate>

 
Response code: 200 

Modifying Default Templates

The following is an example of the PUT request that modifies the Default User Templates:

 https://<connection_server>/vmrest/userdefaulttemplates/<objectId> 

The actual response will depend upon the information given by you.

<DefaultUserTemplate>
 <City>San Jose</City>
 <State>CA</State>
 <Country>US</Country>
</DefaultUserTemplate>

 
Response code: 204