| 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} |
"use strict";
export class ReportResponse {
/** @param {{ResponseStatus?:ResponseStatus,ReportData?:Object[],Filters?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {Object[]} */
ReportData = [];
/** @type {string[]} */
Filters = [];
}
export class ReportRequest {
/** @param {{ReportType?:string,Argument?:string,StartDate?:string,EndDate?:string,Filter?:string,AgentId?:number,ReportMonth?:number,ReportYear?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ReportType;
/** @type {string} */
Argument;
/** @type {string} */
StartDate;
/** @type {string} */
EndDate;
/** @type {string} */
Filter;
/** @type {number} */
AgentId;
/** @type {number} */
ReportMonth;
/** @type {number} */
ReportYear;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
]
}