Gscorbin: 1 revision

2010-12-14T00:05:08Z

1 revision

← Older revision

Revision as of 00:05, 14 December 2010

Juliew at 22:51, 13 December 2010

2010-12-13T22:51:58Z

New page

'''Links to Other API pages:''' [[Cisco_Unity_Connection_APIs]]
{| align="right" border="1"
|align="center"|'''CUPI Guide Contents'''
|-
|[[Cisco Unity Connection Provisioning Interface (CUPI) API|API Overview ]]<br>[[Cisco Unity Connection Provisioning Interface (CUPI) API -- Index of All CUPI Documentation|Index of All CUPI Documentation]]
|}

__TOC__

== About LDAP Phone Number Transform ==

This page contains information on how to use the API to create, list, update, and delete LDAP phone number transforms.

Beginning with Cisco Unity Connection 8.5, we support up to one LDAP phone number transform, which consists of a regular expression and a replacement pattern.

== Listing and Viewing ==

The following is an example of a GET request that lists all LDAP phone number transforms:

<pre>
GET http://<connection-server>/vmrest/ldapphonenumbertransforms
</pre>

The following is the response from the above GET request:

<pre>
200
OK
<?xml version="1.0" encoding="UTF-8"?>
<LdapPhoneNumberTransforms total="1">
<LdapPhoneNumberTransform>
<URI>/vmrest/ldapphonenumbertransforms/0d49a281-cc35-4b8b-bccc-f94f8b8903bd</URI>
<ObjectId>0d49a281-cc35-4b8b-bccc-f94f8b8903bd</ObjectId>
<Regex>.*([0-9][0-9][0-9][0-9])</Regex>
<Replacement>9$1</Replacement>
</LdapPhoneNumberTransform>
</LdapPhoneNumberTransforms>
</pre>

== Creating ==

The required fields for creating an LDAP phone number transform are Regex and Replacement.

The following is an example of a POST request that creates an LDAP phone number transform with the Regex field set to ".*(\[0-9\]\[0-9\]\[0-9\]\[0-9\])", and the Replacement field set to "9$1":

<pre>
POST https://<connection-server>/vmrest/ldapphonenumbertransforms/

<LdapPhoneNumberTransform>
<Regex>.*([0-9][0-9][0-9][0-9])</Regex>
<Replacement>9$1</Replacement>
</LdapPhoneNumberTransform>
</pre>

The following is the response from the above POST request:

<pre>
201
Created
/vmrest/ldapphonenumbertransforms/0d49a281-cc35-4b8b-bccc-f94f8b8903bd
</pre>

== Updating ==

The Regex and Replacement fields of an LDAP Phone Number Transform can be updated via a PUT request.

The following is an example of a PUT request that modifies the Regex and Replacement fields of an existing LDAP phone number transform:

<pre>
https://<connection-server>/vmrest/ldapphonenumbertransforms/
0d49a281-cc35-4b8b-bccc-f94f8b8903bd
<LdapPhoneNumberTransform>
<Regex>.*([0-9][0-9][0-9][0-9][0-9])</Regex>
<Replacement>8$1</Replacement>
</LdapPhoneNumberTransform>
</pre>

The following is the response from the above PUT request:

<pre>
204
No Content
null
</pre>

== Deleting ==

The following is an example of a DELETE request that deletes an LDAP phone number transform:

<pre>
DELETE https://<connection-server>/vmrest/ldapphonenumbertransforms/
0d49a281-cc35-4b8b-bccc-f94f8b8903bd
</pre>

The following is the response from the above DELETE request:

<pre>
204
No Content
null
</pre>

== Possible Errors ==

As of Connection 8.5, we support one LDAP phone number transform only, so if you attempt to create a new LDAP phone number transform (via the POST request) when there is already an existing LDAP phone number transform, the following error will be returned:

<pre>
405
Method Not Allowed
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ErrorDetails>
<errors>
<code>METHOD_NOT_ALLOWED</code>
<message>Unable to perform requested method because an LDAP phone number transform already exists. (This version of Cisco Unity Connection supports up to one LDAP phone number transform only.)</message>
</errors>
</ErrorDetails>
</pre>

[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]

Cisco Unity Connection Provisioning Interface (CUPI) API -- LDAP Phone Number Transform - Revision history

Gscorbin: 1 revision

Juliew at 22:51, 13 December 2010