Overview 
OVERVIEW
Below is a quick overview of the Organisation APIs, more details can be found in the child pages.
| API Functionality | HTTP Request Type | HTTP Request URL | URL Parameters | HTTP Request content | HTTP Response |
| Get Organisation | GET | /api/2/organisations/:org |
:org = Organisation ID |
Organisation Object of requested organisation | |
| Get Organisation list | GET | /api/2/organisations?{params} | {params} = filters, sort, search, fields to return | List of Organisation summary Objects | |
| Add Organisation | POST | /api/2/organisations | Organisation object for new organisation |
Organisation summary Object |
|
| Update Organisation | PUT | /api/2/organisations/:org | :org = Organisation ID | Organisation object |
Organisation summary Object |
| Archive Organisation | POST |
/api/2/organisations/:org/archive |
:org = Organisation ID |
Organisation summary Object |
|
| Activate Organisaiton | POST |
/api/2/organisations/:org/activate |
:org = Organisation ID |
Organisation summary Object |
|
|
Disable Organisation |
POST |
/api/2/organisations/:org/disable |
:org = Organisation ID |
Organisation summary Object |
|
| Get Organisation Email Preferences | GET | /api/2/organisations/:org/emailpreferences |
:org = Organisation ID |
Email preferences Object for requested organisation | |
| Update Organisation Email Preferences | PUT | /api/2/organisations/:org/emailpreferences | :org = Organisation ID | Email preferences object |
Organisation summary Object |
|
Add Organisation Domain |
POST | /api/2/organisations/:org/domains | :org = Organisation ID | Domain object |
Domain object |
| Update Organisation Domain | PUT | /api/2/organisations/:org/domains/:domain |
:org = Organisation ID :domain = Domain name or ID |
Domain object |
Domain object |
| Move Organisation Domain | POST | /api/2/organisations/:org/domains/:domain?newOrganisation=:newOrg |
:org = Organisation ID to move from :domain = Domain name or ID :newOrg = Organisation ID to move to |
Domain object |
|
| Get Organisation Domain | GET | /api/2/organisations/:org/domains/:domain |
:org = Organisation ID :domain = Domain name or ID |
Domain object | |
| Get Organisation Domain list | GET | /api/2/organisations/:org/domains?{params} |
:org = Organisation ID {params} = filters, sort & paging options |
Domain object list | |
| Bulk Activate Organisation | POST | /api/2/organisations/activate | List of organisation names or IDs | Organisation summary list object | |
| Bulk Archive Organisation | POST | /api/2/organisations/archive | List of organisation names or IDs |
Organisation summary list object |
|
| Bulk Disable Organisation | POST | /api/2/organisations/disable | List of organisation names or IDs |
Organisation summary list object |
Get Organisation Email Preferences
Comments
0 Comments