Disable Organisation
OVERVIEW
Overview
Disable an organisation within Publisher
This API call is used to disable an organisation within the system. The organisation identifier is the organisation id.
Since v4.6
HTTP Request
POST /api/2/organisations/<ID>/disable
URL Parameters
Parameter | Description |
---|---|
ID | The ID of the organisation to disable |
HTTP Request Object
No data is passed in the HTTP Request
HTTP Headers
HTTP Request Header | Description | Example |
---|---|---|
Authorization | The API Authorisation token | "Bearer XXXXXXXXXXXXX" |
Accept |
The format of the expected response.
If no parameter is set, JSON is the default response given. |
"application/xml" |
|
HTTP Response
Success
HTTP response 200 with Organisation summary Object
(Example below)
Error
Example HTTP Request & Response
POST http://example.com/context/api/2/organisations/3/disable
JSON Response
{
"organisation": {
"id": 3,
"name": "HighQ",
"link": "http://example.com/context/api/2/organisations/3"
}
}
XML Response
<organisation>
<id>3</id>
<name>HighQ</name>
<atom:link rel="self" href="http://example.com/context/api/2/organisations/3" />
</organisation>
Comments
0 Comments