Trendsic Platform Service

<back to all web services

AgentPromotionRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AgentPromotion/{StartDate}
GET,OPTIONS/v1/AgentPromotion/{StartDate}/{EndDate}
"use strict";
export class AgentPromotion {
    /** @param {{AgentPromotionId?:number,AgentId?:number,FirstName?:string,LastName?:string,FullName?:string,PreviousLevel?:number,PreviousRank?:string,NewLevel?:number,NewRank?:string,CashFlow?:number,AppCount?:number,DateCreated?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentPromotionId;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    FullName;
    /** @type {number} */
    PreviousLevel;
    /** @type {string} */
    PreviousRank;
    /** @type {number} */
    NewLevel;
    /** @type {string} */
    NewRank;
    /** @type {number} */
    CashFlow;
    /** @type {number} */
    AppCount;
    /** @type {string} */
    DateCreated;
}
export class AgentPromotionResponse {
    /** @param {{ResponseStatus?:ResponseStatus,AgentPromotion?:AgentPromotion[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgentPromotion[]} */
    AgentPromotion = [];
}
export class AgentPromotionRequest {
    /** @param {{StartDate?:string,EndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
}

JavaScript AgentPromotionRequest 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/AgentPromotion/{StartDate} 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
		}
	},
	AgentPromotion: 
	[
		{
			AgentPromotionId: 0,
			AgentId: 0,
			FirstName: String,
			LastName: String,
			FullName: String String,
			PreviousLevel: 0,
			PreviousRank: String,
			NewLevel: 0,
			NewRank: String,
			CashFlow: 0,
			AppCount: 0,
			DateCreated: 0001-01-01
		}
	]
}