GET api/Groups/{id}

Lists the members that belong to a particular group.

Request

Parameters

Name Description Default
id Unique group ID or group name.

Response

Body

Content Type: application/xml or application/json
Basic details of the group members or an error message.

XML JSON 
<Response>                                         
  <Result>                                         <!--Array of 'Item'--> 
    <Item>                                         
      <ID>long</ID>                                <!--Unique member ID--> 
      <Code>string</Code>                          <!--Member code--> 
      <Username>string</Username>                  
      <ShortName>string</ShortName>                <!--First and last names--> 
      <Category>string</Category>                  <!--Category code--> 
      <IsServiceAccount>bool</IsServiceAccount>    
      <Contact>                                    
        <ID>long</ID>                              <!--Contact number (unique ID)--> 
        <FileAs>string</FileAs>                    <!--File-as name--> 
      </Contact>                                   
    </Item>                                        
  </Result>                                        
  <Message>string</Message>                        <!--Error message--> 
</Response>                                        
{                                    
   "Result": [{                      
      "ID": "long",                  // Unique member ID
      "Code": "string",              // Member code
      "Username": "string",          
      "ShortName": "string",         // First and last names
      "Category": "string",          // Category code
      "IsServiceAccount": "bool",    
      "Contact": {                   
         "ID": "long",               // Contact number (unique ID)
         "FileAs": "string"          // File-as name
      }                              
   }],                               
   "Message": "string"               // Error message
}

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid group name or ID.
401 Unauthorized Access token is invalid, expired or not specified.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.