Get

Errors

Gets details of a vxmlapp object.

Parameters of VXML Application - Get

URL

https://<ipaddress>:8111/cvp-config/vxmlapp/{appname}

HTTP Method

GET.

API Type

Synchronous.

Input/Output Format

JSON, XML.

Parameters

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.

Code Snippets

Sample Java code


/**
 * Gets the vxml app details based on the app name.
 * Query Parameters that can be passes is summary.
 */

private static void getVxmlAppRequest() {
	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/<appname>").
accept(MediaType.APPLICATION_XML_TYPE).get(ClientResponse.class);
}

Sample XML Response


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vxmlapp>
    <appname>HelloWorld_10</appname>
    <errorflag>false</errorflag>
    <lastaccesstime>2013-04-01T15:20:50-07:00</lastaccesstime>
    <refURL>https://10.78.26.124:8111/cvp-config/vxmlapp/HelloWorld_10</refURL>
    <servers>
        <server>
            <cdate>2013-04-01T03:25:25-07:00</cdate>
            <lastopdate>2013-04-01T15:20:06-07:00</lastopdate>
            <mdate>2013-04-01T03:25:25-07:00</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>

Sample JSON Response


{
   "vxmlapp" :{
        "appname": "HelloWorld_10",
        "errorflag": "false",
        "lastaccesstime": "2013-04-01T15:20:50-07:00",
        "refURL": "https://10.78.26.124:8111/cvp-config/vxmlapp/HelloWorld_10",
        "servers": {
            "server" : {
                "cdate": "2013-04-01T03:25:25-07:00",
                "lastopdate": "2013-04-01T15:20:06-07:00",
                "mdate": "2013-04-01T03:25:25-07:00",
                "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 - Get

Category

HTTP Status

Error Code

Error Description

Authentication

401

authorization.unauthorized

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. Access to a resource is based on the role of a user.

Generic

406

invalid.acceptHeader

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

Get Properties Validation

400

invalid.argument

Invalid query parameter.