Deeptija: 1 revision

2012-06-14T10:14:04Z

1 revision

← Older revision

Revision as of 10:14, 14 June 2012

Suniaror: Created page with "'''Links to Other API pages:''' Cisco Unity Connection APIs {| border="1" align="right" |- | align="center" | '''CUPI Guide Contents''' |- | [[Cisco Unity Connection Provis..."

2012-06-03T08:20:59Z

Created page with "'''Links to Other API pages:''' Cisco Unity Connection APIs {| border="1" align="right" |- | align="center" | '''CUPI Guide Contents''' |- | [[Cisco Unity Connection Provis..."

New page

'''Links to Other API pages:''' [[Cisco Unity Connection APIs]]

{| border="1" align="right"
|-
| align="center" | '''CUPI Guide Contents'''
|-
| [[Cisco Unity Connection Provisioning Interface (CUPI) API|API Overview ]] [[Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation|Index of All CUPI Documentation]]
|}

__TOC__

== About Administrative Replaceable Images ==

The administrator has rights to replace the default images for the following status items:

*Deleted_message
*MWI_OFF
*MWI_ON
*Read_message
*Read_urgent_message
*Unread_message
*Unread_urgent_message

These images can anytime reset to default through the '''Restore Default''' option given on the '''Search Replaceable Images''' page. The addition or deletion of any image is not allowed in the given default list.

 

== Listing of the Administrative Replaceable Images ==

The following is an example of the GET request that lists all the replaceable images:
<pre> GET https://<connection-server>/vmrest/replaceableimages
</pre>
The following is an example of the response from the above *GET* request and the actual respone will depend upon the information given by you.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ReplaceableImages>
<ReplaceableImage>
<URI>/vmrest/replaceableimages/9ab493f8-5e8e-4f0c-82a8-a43308d460d8</URI>
<DisplayName>deleted_message</DisplayName>
<ImageName>deleted_message.png</ImageName>
<ImageSize>128*128</ImageSize>
<ObjectId>9ab493f8-5e8e-4f0c-82a8-a43308d460d8</ObjectId>
<ImagePreviewURI>/vmrest/replaceableimages/deleted_message/image</ImagePreviewURI>
</ReplaceableImage>
<ReplaceableImage>
<URI>/vmrest/replaceableimages/c6d3173e-ce2b-406a-9d34-3b1c13093f0b</URI>
<DisplayName>mwi_off</DisplayName>
<ImageName>test1.GIF</ImageName>
<ImageSize>387*232</ImageSize>
<ObjectId>c6d3173e-ce2b-406a-9d34-3b1c13093f0b</ObjectId>
<ImagePreviewURI>/vmrest/replaceableimages/mwi_off/image</ImagePreviewURI>
</ReplaceableImage>
</ReplaceableImages>

 

== Viewing of the Administrative Replaceable Images ==

The following is an example of the GET request that lists the details of specific administrative replaceable images represented by the provided value of object id:
<pre>
GET https://<connection-server>/vmrest/replaceableimages/<objectid>
</pre>
The following is the response from the above *GET* request.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ReplaceableImage>
<URI>/vmrest/replaceableimages/9ab493f8-5e8e-4f0c-82a8-a43308d460d8</URI>
<DisplayName>deleted_message</DisplayName>
<ImageName>deleted_message.png</ImageName>
<ImageSize>128*128</ImageSize>
<ObjectId>9ab493f8-5e8e-4f0c-82a8-a43308d460d8</ObjectId>
<ImagePreviewURI>/vmrest/replaceableimages/deleted_message/image</ImagePreviewURI>
</ReplaceableImage>

== Modifying an existing Administrative Replaceable Image ==

The following is an example of the PUT request that modifies an existing administrative replaceable image as represented by object id. An image file attachment is required as a multipart PUT request.

 
<pre>
PUT https://<connection-server>/vmrest/replaceableimages/<objectid>
REQUEST: An image file attachment is required as a multipart PUT request.
RESPONSE Code: 204
RESPONSE Text: [[Image:Icon privacy.png]]
</pre>

== Viewing an existing Administrative Replace Image corresponding to a Display Name ==

The following is an example of the GET request that allows you to view an existing replaceable image corresponding to its display name:
<pre>
GET https://<connection-server>/vmrest/replaceableimages/<displayname>/image
</pre>
 

== Restoring the Default Images for Administrative Replaceable Images ==

The following is an example of the PUT request that restores the system default images for administrative replaceable images:
<pre>
PUT https://<connection-server>/vmrest/replaceable images/<displayname>/restore
</pre>
The output for this request returns the successful response code.
<pre>REQUEST: <No input is required>

RESPONSE Code: 204
</pre>
[[Category:Cisco_Unity_Connection_Provisioning_Interface_(CUPI)_API]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- HTML Notification Template Administrative Replaceable Images - Revision history

Deeptija: 1 revision

Suniaror: Created page with "'''Links to Other API pages:''' Cisco Unity Connection APIs {| border="1" align="right" |- | align="center" | '''CUPI Guide Contents''' |- | [[Cisco Unity Connection Provis..."