Organisation APIs
Get Organisation
OVERVIEW
Get an organisation from Collaborate
This API call is used to retrieve an organisation from the system. The organisation identifier is the organisation id.
HTTP Request
GET /api/4/organisations/<ID>
URL Parameters
Parameter | Description |
---|---|
ID | The ID of the organisation to retrieve |
Example
GET http://example.com/context/api/4/organisations/1
HTTP Response
Success
HTTP response 200 with Organisation object
Error
XML format response
<organisation>
<orgid>1</orgid>
<name>HighQ</name>
<orgindustryid>359</orgindustryid>
<internal></internal>
<status>Active</status>
<strategic></strategic> <!-- PUB - not in use -->
<externalid></externalid> <!-- PUB - not in use -->
<companyswitchboard></companyswitchboard> <!-- PUB - not in use -->
<onlineserviceslink></onlineserviceslink> <!-- PUB - not in use -->
<activateautologin>true</activateautologin> <!-- Publisher only -->
<guid>23</guid> <!-- Publisher only -->
<category>145</category> <!-- Publisher only -->
<excludesynchronization></excludesynchronization> <!-- Publisher only -->
<url>http://highq.com</url> <!-- Publisher only -->
<logoid></logoid> <!-- Publisher only -->
<logowidth></logowidth> <!-- Publisher only -->
<logoheight></logoheight> <!-- Publisher only -->
<homepage>451</homepage> <!-- Publisher only -->
<disableeditprofile></disableeditprofile> <!-- Collaborate only -->
<restrictdirectlogin></restrictdirectlogin> <!-- Collaborate only -->
<!-- Publisher does not have contact, whereas collaborate does have -->
<contact>
<orgcontactid></orgcontactid>
<name></name> <!-- PUB - not in use -->
<email></email> <!-- PUB - not in use -->
<typeid></typeid> <!-- PUB - not in use -->
<contacttier></contacttier> <!-- PUB - not in use -->
</contact>
<!-- Publisher has key contacts, whereas collaborate hasnt -->
<keycontacts>
<keycontact>
<orgpartnerid></orgpartnerid>
<userid></userid>
<status></status>
<orderid></orderid>
</keycontact>
<keycontact>
<orgpartnerid></orgpartnerid>
<userid></userid>
<status></status>
<orderid></orderid>
</keycontact>
<!-- upto maximum 10 will be handled -->
</keycontacts>
</organisation>
JSON format response
{
"orgid": "1",
"name": "HighQ",
"orgindustryid": "359",
"internal": "1",
"status": "Active",
"strategic": "1",
"externalid": "ext_123",
"companyswitchboard": "abc",
"onlineserviceslink": "service link",
"activateautologin": "true",
"guid": "23",
"category": "145",
"excludesynchronization": "1",
"url": "http://highq.com",
"logoid": "123",
"logowidth": "123",
"logoheight": "123",
"homepage": "451",
"disableeditprofile": "1",
"restrictdirectlogin": "1",
"contact": {
"orgcontactid": "101",
"name": "Saviz Izadpanah",
"email": "saviz.izadpanah@highq.com",
"typeid": "13",
"contacttier": "1"
},
"keycontacts": {
"keycontact": [
{
"orgpartnerid": "123",
"userid": "23",
"status": "1",
"orderid": "1"
},
{
"orgpartnerid": "124",
"userid": "24",
"status": "1",
"orderid": "2"
}
]
}
}
Error messages
Summary | Ref Code (V4) | Ref Code (before V4) |
The Organisation id is invalid | 260 | N/A |
Last Updated: Nov 08,2024
Comments
0 Comments