Organisation Group APIs

Add Organisations to Organisation Group

OVERVIEW

Overview

Add multiple active organisations to an existing Organisation Group in Publisher

Since v5.0

HTTP Request

PUT  /api/2/organisationgroups/<ID>/organisations

HTTP Request Object

List of organisation names or IDs, 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 Response

Success

HTTP response 200 with Organisation Group object

(Example below)

 

Error

See API Error messages 

 

Example HTTP Request & Response

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

 

JSON Request

{  

    "organisationgroup":{  

        "organisations":[  

            "20",

            "21",

            "HighQ"        

      ]

   }

}

 

 

JSON Response

{

    "organisationgroup": {

        "id": 44,

        "name": "New Organisation group 44",

        "organisations": [

            20,

            21,

            4

        ],

        "shared": 1,

        "createddate": "28-03-2018 12:58:00:000"

    }

}

 

 

Comments


0 Comments

Last Updated: Nov 08,2024