REST API - DELETE Organization

This operation deletes an organization.

Request

Syntax

DELETE webservice/Organization/organizationId HTTP/1.1
Host: host name
Accept: application/xml | application/json
Authtoken: authentication token
Content-type: application/xml

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name	Description
organizationId	The organization ID for the organization. If the organization ID is not known, use the GET Organization API to retrieve it. The organization ID is the ID in the shortName element.

Request Headers

Name	Description
Host	The host name of the Web Server or the Command Center used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter	Description	Element
errorMessage	The description of the error code. Not all error codes have an error message.	CVGui_GenericResp
errorCode	The possible error codes. Valid values are: 0, successful completion. 2, a failure. a specific error code.	CVGui_GenericResp

Parameter

Description

Element

errorMessage

The description of the error code. Not all error codes have an error message.

CVGui_GenericResp

errorCode

The possible error codes.

Valid values are:

0, successful completion.
2, a failure.
a specific error code.

CVGui_GenericResp

Examples

Sample Request

DELETE webservice/Organization/15 HTTP/1.1
Host: client.mydomain.com
Accept: application/json
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc60f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef768fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f3233d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

{ "errorMessage": "", "errorCode": 0
}