Add Organisation Group
Add Organisation Group
OVERVIEW
Overview
Add a new organisation group to Publisher
This API call is used to add a new organisation group object to the system.
Since v4.6
HTTP Request
POST /api/2/organisationgroups
HTTP Request Object
Organisation Group Object, 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 Organisation group summary Object
(Example below)
Error
Example HTTP Request & Response
POST http://example.com/context/api/2/organisationgroups
JSON Request
{
"organisationgroup": {
"name": "Education organisations",
"organisations": [
45,
92,
96
]
}
}
JSON Response
{
"organisationgroup": {
"id": 3,
"name": "Education organisations",
"link": "http://example.com/context/api/2/organisationgroups/3"
}
}
Thank you
Your review has been submitted.
Comments
0 Comments