Bulk Disable Organisation
Bulk Disable Organisation
OVERVIEW
Overview
Bulk Disable a list of organisations within Publisher. This API call is used to disable multiple organisations within the system.
Since v5.0
HTTP Request
POST /api/2/organisations/disable
HTTP Request Object
List of organisation names or IDs, either in JSON or XML format.
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" |
| Content-Type |
The format of the provided content
If no parameter is set, JSON is the expected content by default. |
"application/json" |
HTTP Response
Success
HTTP response 200 with list of Organisation Summary Objects
(Example below)
Error
Example HTTP Request & Response
POST http://example.com/context/api/2/organisations/disable
JSON Request
{
"organisations":{
"organisation":[
"20",
"21",
"HighQ"
]
}
}
JSON Response
{
"organisations": {
"totalcount": 3,
"total": 3,
"currentpage": 0,
"organisations": [
{
"id": 20,
"name": "Apple",
"link": "https://example.com/context/api/2/organisations/20"
},
{
"id": 21,
"name": "Google",
"link": "https://example.com/context/api/2/organisations/21"
},
{
"id": 4,
"name": "HighQ",
"link": "https://example.com/context/api/2/organisations/4"
}
]
}
}
Thank you
Your review has been submitted.
Comments
0 Comments