Configuration API
Get Instance details
OVERVIEW
This is the latest version of this API endpoint valid from Collaborate 4.1.4 and above, for older versions please see the child pages of this page
Purpose
This api method can be used to get basic details of a Collaborate Instance
Request URL
GET /configuration/basicdetails
Sample request URL : https://domain.com/instancename/api/1/configuration/basicdetails
Assumptions :
- No credentials required to call this api method (Change introduced in 3.4.5)
Response XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configuration>
<basicdetails>
<clientname>HighQ</clientname>
<productname>Collaborate</productname>
<clientandproductname>HighQ Collaborate</clientandproductname>
<clientsupportemail>POC@highq.com</clientsupportemail>
<version>3.4.5</version> (Change introduced in 3.4.5)
<timezone> (Added in 4.1.4 )
<id>GMT</id>
<displayname>(GMT) GMT/UTC</displayname>
<difference>GMT</difference>
</timezone>
<configuration>
<basicdetails>
<clientname>HighQ</clientname>
<productname>Collaborate</productname>
<clientandproductname>HighQ Collaborate</clientandproductname>
<clientsupportemail>POC@highq.com</clientsupportemail>
<version>3.4.5</version> (Change introduced in 3.4.5)
<timezone> (Added in 4.1.4 )
<id>GMT</id>
<displayname>(GMT) GMT/UTC</displayname>
<difference>GMT</difference>
</timezone>
<instanceid>sitepoint.1520322118450</instanceid> (Change introduced in branch 5.0)
</basicdetails>
</configuration>
</configuration>
Response Code
Code | Meaning |
---|---|
200 | Response successfully |
401 | Unauthorised |
403 | Validation failed/ Forbidden |
405 | Method not allowed (calling API with the wrong method) |
500 | Internal error occurred |
Last Updated: Jun 09,2023
Comments
0 Comments