Organisation Group APIs

Get Organisation Group

OVERVIEW

Overview

Get an organisation group from Publisher

This API call is used to retrieve an organisation group from the system. The group identifier is the group id.

Since v4.6

HTTP Request

GET  /api/2/organisationgroups/<ID>

 

URL Parameters
Parameter Description
ID The ID of the organisation group to retrieve

 

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"
     

 

 

HTTP Response

Success

HTTP response 200 with Organisation group object

(Example below)

 

Error

See API Error messages

Example HTTP Request & Response

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

 

JSON Response

{

    "organisationgroup": {

        "id": 3,

        "name": "Education organisations",

        "organisations": [

            45,

            92,

            96

        ]

    }

}

 

 

XML Response

<organisationgroup>

    <id>3</id>

    <name>Education organisations</name>

    <organisations>

        <organisation>45</organisation>

        <organisation>92</organisation>

        <organisation>96</organisation>   
           
    </organisations>

</organisationgroup>

 

Comments


0 Comments

Last Updated: Jun 11,2023