GET api/Activities

Retrieves a list of activities defined for the firm.

Request

Parameters

Name	Description	Default
`company`	Unique company ID. Omit to include results for all companies.
`includeDisabled`	Whether to include activities which have been disabled.	`False`

Response

Body

Content Type: application/xml or application/json
List of activities or an error message.

XML JSON
<Response> <Result> <!--Array of 'Item'--> <Item> <ID>long</ID> <!--Unique activity ID--> <Name>string</Name> <!--Activity name--> <Group>string</Group> <!--Group display name--> <Type>string</Type> <!--Name or GUID of the type of activity--> <Enabled>bool</Enabled> <!--Whether the activity is enabled--> <HasPermission>bool</HasPermission> <!--Whether the current user has permission--> </Item> </Result> <Message>string</Message> <!--Error message--> </Response>
{ "Result": [{ "ID": "long", // Unique activity ID "Name": "string", // Activity name "Group": "string", // Group display name "Type": "string", // Name or GUID of the type of activity "Enabled": "bool", // Whether the activity is enabled "HasPermission": "bool" // Whether the current user has permission }], "Message": "string" // Error message }

XML JSON

<Response>                                   
  <Result>                                   <!--Array of 'Item'--> 
    <Item>                                   
      <ID>long</ID>                          <!--Unique activity ID--> 
      <Name>string</Name>                    <!--Activity name--> 
      <Group>string</Group>                  <!--Group display name--> 
      <Type>string</Type>                    <!--Name or GUID of the type of activity--> 
      <Enabled>bool</Enabled>                <!--Whether the activity is enabled--> 
      <HasPermission>bool</HasPermission>    <!--Whether the current user has permission--> 
    </Item>                                  
  </Result>                                  
  <Message>string</Message>                  <!--Error message--> 
</Response>

{                               
   "Result": [{                 
      "ID": "long",             // Unique activity ID
      "Name": "string",         // Activity name
      "Group": "string",        // Group display name
      "Type": "string",         // Name or GUID of the type of activity
      "Enabled": "bool",        // Whether the activity is enabled
      "HasPermission": "bool"   // Whether the current user has permission
   }],                          
   "Message": "string"          // Error message
}

Status Codes

Code	Condition
200 OK	The operation completed successfully.
400 Bad Request	Invalid company.
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.