PUT

This is a generic REST API that can be used on a CVP device to perform graceful shutdown of the CVP Call Server and its associated Reporting Server.

Input/Output Format

JSON

XML

URL

/cvp-orm/rest/gracefulShutdown

HTTP Method

PUT

API Type

Synchronous

Sample Request Body

For Call Server:
{
    "type": "'callserver'
}

For Reporting Server:
{
    "type": "reportingserver",
    "ip": "<IP Address of the Reporting Server>"
}

Note	Only supported device types are reportingserver and callserver. The "ip" field is only applicable for graceful shutdown of the Reporting Server. REST API must be invoked on Call Server for shutting down Reporting Server.


For Call Server:
<device>
    <type>callserver</type>
</device>

For Reporting Server:
<device>
    <type>reportingserver</type>
    <ip><IP Address of the Reporting Server></ip>
</device>

Note	Only supported device types are reportingserver and callserver. The "ip" field is only applicable for graceful shutdown of the Reporting Server. REST API must be invoked on Call Server for shutting down Reporting Server.

Sample Request Header

Content-Type: application/json

Accept: application/json

Content-Type: application/xml

Accept: application/xml

Response Status

200 OK

Sample Response Body


{
    "status": 200,
    "description": "Graceful ShutDown on Device Successfully Invoked"
}


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<restResponse>
    <status>200</status>
    <description>Graceful ShutDown on Device Successfully Invoked</description>
</restResponse>

Sample Response Header

Content-Type: application/json

Content-Type: application/xml

Sample Error Responses

500 Internal Server Error, if something goes wrong while performing graceful shutdown.

400 for bad input request data for IPAddress and DeviceType.

(More details about the error will be in the response body)

500 Internal Server Error, if something goes wrong while creating the report .

400 for bad input request data

(More details about the error will be in the response body)