| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/ReportFilters/{ReportType} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/Report/{ReportType} | ||
| GET,OPTIONS | /v1/Report/{ReportType}/{Argument} | ||
| GET,OPTIONS | /v1/Report/{ReportType}/{StartDate}/{EndDate}/{AgentID} | ||
| GET,OPTIONS | /v1/Report/{ReportType}/{StartDate}/{EndDate} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ReportType | path | string | No | |
| Argument | path | string | No | |
| StartDate | path | DateTime | No | |
| EndDate | path | DateTime | No | |
| Filter | query | string | No | |
| AgentId | path | int | No | |
| ReportMonth | query | int | No | |
| ReportYear | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| ReportData | form | List<Object> | No | |
| Filters | form | List<string> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/ReportFilters/{ReportType} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ReportData":[{}],"Filters":["String"]}