Trendsic Platform Service

<back to all web services

ReportRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
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}

export class ReportResponse
{
    public ResponseStatus: ResponseStatus;
    public ReportData: Object[] = [];
    public Filters: string[] = [];

    public constructor(init?: Partial<ReportResponse>) { (Object as any).assign(this, init); }
}

export class ReportRequest
{
    public ReportType: string;
    public Argument: string;
    public StartDate: string;
    public EndDate: string;
    public Filter: string;
    public AgentId: number;
    public ReportMonth: number;
    public ReportYear: number;

    public constructor(init?: Partial<ReportRequest>) { (Object as any).assign(this, init); }
}

TypeScript ReportRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
	]
}