Update Organisation Group

Organisation Group APIs

OVERVIEW

Overview

Update an existing organisation group in Publisher

This API call is used to update an existing organisation group in the system, by replacing the organisation group with the provided organisation group object.

Since v4.6

HTTP Request

PUT /api/2/organisationgroups/<ID>

HTTP Request Object

Organisation Group Object, either in JSON or XML format.

URL Parameters

Parameter	Description
ID	The ID of the organisation group to update

HTTP Headers

HTTP Request Header	Description	Example
Authorization	The API Authorisation token	"Bearer XXXXXXXXXXXXX"
Accept	The format of the expected response. "application/json" "application/xml" If no parameter is set, JSON is the default response given.	"application/xml"
Content-Type	The format of the provided content. "application/json" "application/xml" If no parameter is set, JSON is the expected content by default.	"application/json"

HTTP Request Header

Description

Example

Authorization

The API Authorisation token

"Bearer XXXXXXXXXXXXX"

Accept

The format of the expected response.

"application/json"
"application/xml"

If no parameter is set, JSON is the default response given.

"application/xml"

Content-Type

The format of the provided content.

"application/json"
"application/xml"

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

See API Error messages

Example HTTP Request & Response

PUT http://example.com/context/api/2/organisationgroups/3

JSON Request

{

"organisationgroup": {

"id": 3,

"name": "Education organisations",

"organisations": [

45,

92,

]

}

JSON Response

{