POST Dealer/getactivityhistory
Get a list of activities by FromDateUTC and optionally filtered by Activity Type.
Request Information
URI Parameters
None.
Body Parameters
GetActivityHistoryRequestName | Description | Type | Additional information |
---|---|---|---|
fromDateUTC |
UTC Date/time to filter requests. This date is compared with the InsertDate. |
date |
Required |
rowLimit |
Optional maximum number of rows to return. Returns first N rows since fromDateUTC. Set value to null or 0 to returrn all rows. |
integer |
None. |
activityType |
Activity Type |
string |
None. |
token |
API access token |
globally unique identifier |
Required |
Request Formats
application/json, text/json
Sample:
{ "fromDateUTC": "2024-11-20T12:22:29.8430514-08:00", "rowLimit": 1, "activityType": "sample string 2", "token": "5168b7fc-665e-4d01-bbcd-e2e1bd4baaf8" }
application/xml, text/xml
Sample:
<GetActivityHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Dealer"> <token xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">5168b7fc-665e-4d01-bbcd-e2e1bd4baaf8</token> <activityType>sample string 2</activityType> <fromDateUTC>2024-11-20T12:22:29.8430514-08:00</fromDateUTC> <rowLimit>1</rowLimit> </GetActivityHistoryRequest>
Response Information
Resource Description
GetActivityHistoryResponseName | Description | Type | Additional information |
---|---|---|---|
code |
API result code |
integer |
None. |
error |
API error message |
string |
None. |
ActivityHistoryList |
Activity History list |
Collection of ActivityHistoryItem |
None. |
APIVersion |
API Version |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "ActivityHistoryList": [ { "EntityID": "38946e20-cfbe-47e7-8d57-26e26011430f", "ActivityHistoryID": 2, "ActivityID": 3, "ActivityType": "sample string 4", "ActivityStatus": "sample string 5", "ActionName": "sample string 6", "InsertDate": "2024-11-20T12:22:29.8460902-08:00", "Notes": "sample string 8", "ActivityActionResult": "sample string 9", "PerformedByID": 10, "PerformedByFirst": "sample string 11", "PerformedByMiddle": "sample string 12", "PerformedByLast": "sample string 13", "DueDate": "2024-11-20T12:22:29.8470837-08:00" }, { "EntityID": "38946e20-cfbe-47e7-8d57-26e26011430f", "ActivityHistoryID": 2, "ActivityID": 3, "ActivityType": "sample string 4", "ActivityStatus": "sample string 5", "ActionName": "sample string 6", "InsertDate": "2024-11-20T12:22:29.8460902-08:00", "Notes": "sample string 8", "ActivityActionResult": "sample string 9", "PerformedByID": 10, "PerformedByFirst": "sample string 11", "PerformedByMiddle": "sample string 12", "PerformedByLast": "sample string 13", "DueDate": "2024-11-20T12:22:29.8470837-08:00" } ], "APIVersion": 1, "code": 200, "error": "sample string 1" }
application/xml, text/xml
Sample:
<GetActivityHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Dealer"> <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">1</APIVersion> <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error> <ActivityHistoryList> <ActivityHistoryItem> <ActionName>sample string 6</ActionName> <ActivityActionResult>sample string 9</ActivityActionResult> <ActivityHistoryID>2</ActivityHistoryID> <ActivityID>3</ActivityID> <ActivityStatus>sample string 5</ActivityStatus> <ActivityType>sample string 4</ActivityType> <DueDate>2024-11-20T12:22:29.8470837-08:00</DueDate> <EntityID>38946e20-cfbe-47e7-8d57-26e26011430f</EntityID> <InsertDate>2024-11-20T12:22:29.8460902-08:00</InsertDate> <Notes>sample string 8</Notes> <PerformedByFirst>sample string 11</PerformedByFirst> <PerformedByID>10</PerformedByID> <PerformedByLast>sample string 13</PerformedByLast> <PerformedByMiddle>sample string 12</PerformedByMiddle> </ActivityHistoryItem> <ActivityHistoryItem> <ActionName>sample string 6</ActionName> <ActivityActionResult>sample string 9</ActivityActionResult> <ActivityHistoryID>2</ActivityHistoryID> <ActivityID>3</ActivityID> <ActivityStatus>sample string 5</ActivityStatus> <ActivityType>sample string 4</ActivityType> <DueDate>2024-11-20T12:22:29.8470837-08:00</DueDate> <EntityID>38946e20-cfbe-47e7-8d57-26e26011430f</EntityID> <InsertDate>2024-11-20T12:22:29.8460902-08:00</InsertDate> <Notes>sample string 8</Notes> <PerformedByFirst>sample string 11</PerformedByFirst> <PerformedByID>10</PerformedByID> <PerformedByLast>sample string 13</PerformedByLast> <PerformedByMiddle>sample string 12</PerformedByMiddle> </ActivityHistoryItem> </ActivityHistoryList> </GetActivityHistoryResponse>