List

Errors

Gets a list of vxmlapps in Unified CVP.

URL

https://<ipaddress>:8111/cvp-config/vxmlapp

HTTP Method

GET.

API Type

Synchronous.

Input/Output Format

JSON, XML.

Parameters

The following query parameters are specified using (q=) syntax.

Name : appname

Description: Text parameter with the application name. The value can be wildcarded.

Required : No.

Validations : Should not contain any starting wildcard characters.

Notes : The following parameters are specified as separate URL query parameters with "&" separators.

Name : summary

Description: Text parameter to indicate whether only application name is listed or full details to be listed.

Required : No.

Values : true

Validations : Only allowed values.

Notes : URL query parameter. Default is false.

Name : startIndex

Description: Starting index of the result list.

Required : No.

Values : Zero-based: 0 is the first element. DEFAULT = 0.

Validations : zero or more.

Notes : URL query parameter.

Name : resultsPerPage

Description: Specifies number of elements to retrieve.

Required : No.

Values : MIN=1, DEFAULT=25, MAX=50

Validations : One or more.

Notes: URL query parameter

Code Snippets

Sample JAVA code


/**
 * Lists all the vxml apps.
 * Query Parameters that can be passes are query string, summary, start index, 
results per page.
 */

private static void listVxmlAppRequest() {
	Client client = getSSLClient();
	ClientFilter authFilter = new HTTPBasicAuthFilter("wsmadmin",
 "<password set during installation>");
	client.addFilter(authFilter);

	WebResource webResource = null;
	webResource = client.resource("https://<OAMP IP Address>:8111/cvp-config");

        // GET the request
        ClientResponse clientResponse = webResource.path("/vxmlapp").
accept(MediaType.APPLICATION_XML_TYPE).get(ClientResponse.class);
}

Sample Response Header


Response HTTP Status : 200
Response Headers : {Transfer-Encoding=[chunked], 
Date=[Mon, 01 Apr 2013 22:20:50 GMT], Expires=[Wed, 31 Dec 1969 16:00:00 PST], 
Content-Type=[application/xml;charset=utf-8], Server=[Apache-Coyote/1.1], 
Pragma=[No-cache], Cache-Control=[no-cache]
}

Sample XML Response


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
    <pageInfo>
        <resultsPerPage>25</resultsPerPage>
        <startIndex>0</startIndex>
        <totalResults>1</totalResults>
    </pageInfo>
    <vxmlapps>
        <vxmlapp>
            <appname>HelloWorld_10</appname>
            <errorflag>false</errorflag>
            <refURL>https://10.78.26.124:8111/cvp-config/vxmlapp/
HelloWorld_10</refURL>
            <servers>
                <server>
                    <cdate>04-01-2013:03:25:25</cdate>
                    <mdate>04-01-2013:03:25:25</mdate>
                    <refURL>https://10.78.26.124:8111/cvp-config/
server/dae2b47e-7c03-46ea-b854-c12875443b15</refURL>
                    <status>CREATING</status>
                    <statusdesc>Success</statusdesc>
                </server>
            </servers>
            <status>CREATING</status>
        </vxmlapp>
    </vxmlapps>
</results>

Sample JSON Response


{
    "results": {
        "pageInfo": {
            "resultsPerPage": "25",
            "startIndex": "0",
            "totalResults": "1"
        },
        "vxmlapps": {
            "vxmlapp" : [
            {
                "appname": "HelloWorld_10",
                "errorflag": "false",
                "refURL": "https://10.78.26.124:8111/cvp-config/vxmlapp/HelloWorld_10",
                "servers": {
                    "server":{
                    "cdate": "04-01-2013:03:25:25",
                    "mdate": "04-01-2013:03:25:25",
                    "refURL": "https://10.78.26.124:8111/cvp-config/server/dae2b47e-7c03-46ea-b854-c12875443b15",
                    "status": "CREATING",
                    "statusdesc": "Success"
                    }
                },
                "status": "CREATING"
            }
        ]
        }
    }
}
List of Errors for VXML File - Delete

Category

HTTP Status

Error

Error Description

Authentication

401

authorization.unathorized

Unauthorized request.

401

authentication.notAuthorized

User is not authorized to access the requested resource.

401

authentication.noAccess

User is not allowed to access the resource. Check the user roles.

Generic

406

invalid.acceptHeader

Invalid accept header, it should contain either xml or json.

Get Properties Validation

400

invalid.argument

Invalid query parameter.