GET api/Workgroups

Retrieves a list of workgroups.

Request

(empty)

Response

Body

Content Type: application/xml or application/json
Data set containing the workgroups, or an error message.

XML JSON
<Response> <Result> <!--Array of 'Item'--> <Item> <WorkTypeID>long</WorkTypeID> <!--Unique workgroup ID--> <Text>string</Text> <!--Workgroup name--> <IsAdmin>bool</IsAdmin> <!--Whether the workgroup contains admin files--> <Group>string</Group> <!--Department name--> <DepartmentID>long</DepartmentID> <!--Department ID--> </Item> </Result> <Message>string</Message> <!--Error message--> </Response>
{ "Result": [{ "WorkTypeID": "long", // Unique workgroup ID "Text": "string", // Workgroup name "IsAdmin": "bool", // Whether the workgroup contains admin files "Group": "string", // Department name "DepartmentID": "long" // Department ID }], "Message": "string" // Error message }

XML JSON

<Response>                                 
  <Result>                                 <!--Array of 'Item'--> 
    <Item>                                 
      <WorkTypeID>long</WorkTypeID>        <!--Unique workgroup ID--> 
      <Text>string</Text>                  <!--Workgroup name--> 
      <IsAdmin>bool</IsAdmin>              <!--Whether the workgroup contains admin files--> 
      <Group>string</Group>                <!--Department name--> 
      <DepartmentID>long</DepartmentID>    <!--Department ID--> 
    </Item>                                
  </Result>                                
  <Message>string</Message>                <!--Error message--> 
</Response>

{                              
   "Result": [{                
      "WorkTypeID": "long",    // Unique workgroup ID
      "Text": "string",        // Workgroup name
      "IsAdmin": "bool",       // Whether the workgroup contains admin files
      "Group": "string",       // Department name
      "DepartmentID": "long"   // Department ID
   }],                         
   "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.

Remarks

Workgroups are not filtered by practice or subsidiary company.

The data set includes grouping rows for departments; these are denoted by a negative value in the WorkTypeID column.