Configuration API

Get Instance details - Get Instance details v1

OVERVIEW

Note: The latest specification for Collaborate 4.1.4 and above is here

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)
    </basicdetails>
</configuration>

Response Code

Code Meaning
200 Response successfully
401 Unauthorized
403 Validation failed/ Forbidden
405 Method not allowed (calling api with wrong method)
500 Internal error occured while uploading document

Comments


1 Comments


Please note that from Collaborate 3.4.5, a new version field has been added to the return XML of this method and the API method has been made open for access, which means no OAuth is required to call this method. 

Last Updated: Nov 08,2024