Trendsic Platform Service

<back to all web services

AgentPromotionsHistoryRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AgentPromotionsHistory/{AgentId}
"use strict";
export class AgentPromotionsHistory {
    /** @param {{AgentLevel?:number,PromotionDate?:string,Description?:string,NextPromotionDescription?:string,NextPromotionGuideline?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentLevel;
    /** @type {string} */
    PromotionDate;
    /** @type {string} */
    Description;
    /** @type {string} */
    NextPromotionDescription;
    /** @type {string} */
    NextPromotionGuideline;
}
export class AgentPromotionsHistoryResponse {
    /** @param {{ResponseStatus?:ResponseStatus,result?:AgentPromotionsHistory[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgentPromotionsHistory[]} */
    result = [];
}
export class AgentPromotionsHistoryRequest {
    /** @param {{AgentId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
}

JavaScript AgentPromotionsHistoryRequest 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/AgentPromotionsHistory/{AgentId} 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
		}
	},
	result: 
	[
		{
			AgentLevel: 0,
			PromotionDate: 0001-01-01,
			Description: String,
			NextPromotionDescription: String,
			NextPromotionGuideline: String
		}
	]
}