Groups resouce

Get group details

OVERVIEW

Purpose

This method is used to get the details of a group

Request

GET         /groups/{group_id}

Where group_id is the id of the required group

Response

This method returns the details of the group in XML format if the group_id matches a valid group id on the server. 

The response XML is of the following format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<group>
    <groupID>3</groupID>
    <guid>Highq-India</guid>
    <name>High-India3</name>
    <description>this is a test group</description>    
</group>

Response Codes

 

Code Meaning
200 Successfully
400 Problem with parsing XML or JSON object (Bad Request)
401 Unauthorized
403 Validation failed/ Forbidden
405 Method not allowed (calling api with wrong method)
500 Internal error occured while creating folder

Comments


5 Comments


Giuseppe Carafa I will chase the technical support team. The support is the right forum to get such technical issues resolved, if there are any improvement requests or suggestions please feel free to raise with me as I am the Product manager for Integrations.


Giuseppe Carafa did you raise this issue with the HighQ support team, please raise this with support so that the technical support team can guide you. This API call should work, and looking at the logs the tech support team will be able to guide you how to go about it.


I've tried this call in various forms:

/groups/N

/groups/{N}



I'm setting the Accept variable on the Request to either "application/json" (in which case I get a 416 response, so I guess this call cannot return JSON) or "application/xml" (and then I'm getting a 403 Forbidden). I do think I am using the correct Group ID; I'm using the number that is shown in the metaData.targetGroupID=.... value when you look at the group through the Browser front end of my site.

Any suggestions?

Last Updated: Nov 08,2024