GET api/Groups

Lists the member groups defined within the practice.

Request

(empty)

Response

Body

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

XML JSON
<Response>                               
  <Result>                               <!--Array of 'Item'--> 
    <Item>                               
      <ID>long</ID>                      <!--Unique group ID--> 
      <Name>string</Name>                <!--Group name--> 
      <Permissions>bool</Permissions>    <!--Group grants permissions--> 
      <Delegation>bool</Delegation>      <!--Group is used for delegation--> 
      <Calendar>bool</Calendar>          <!--Group appears on calendar--> 
    </Item>                              
  </Result>                              
  <Message>string</Message>              <!--Error message--> 
</Response>                              
{                               
   "Result": [{                 
      "ID": "long",             // Unique group ID
      "Name": "string",         // Group name
      "Permissions": "bool",    // Group grants permissions
      "Delegation": "bool",     // Group is used for delegation
      "Calendar": "bool"        // Group appears on calendar
   }],                          
   "Message": "string"          // Error message
}                               
                                

Status Codes

Code Condition
200 OK The operation completed successfully.
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.