Trendsic Platform Service

AgreementKpiRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dashboard/agreements


export class DashboardStatTile
{
    public Key: string;
    public Label: string;
    public Value: number;
    public PreviousValue?: number;
    public Unit: string;
    public DeltaPct?: number;

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

export class AgreementKpiBranchRow
{
    public BranchName: string;
    public ActiveCount: number;
    public Mrr: number;
    public ExpiringCount: number;
    public ChurnCount: number;
    public SkippedRate: number;

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

export class AgreementKpiResponse
{
    public ResponseStatus: ResponseStatus;
    public Stats: DashboardStatTile[] = [];
    public ByBranch: AgreementKpiBranchRow[] = [];

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

export class AgreementKpiRequest
{
    public FromDate: string;
    public ToDate: string;
    public LocationIds: string[] = [];

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

TypeScript AgreementKpiRequest 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.

POST /v1/dashboard/agreements HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FromDate: 0001-01-01,
	ToDate: 0001-01-01,
	LocationIds: 
	[
		00000000000000000000000000000000
	]
}

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
		}
	},
	Stats: 
	[
		{
			Key: String,
			Label: String,
			Value: 0,
			PreviousValue: 0,
			Unit: String
		}
	],
	ByBranch: 
	[
		{
			BranchName: String,
			ActiveCount: 0,
			Mrr: 0,
			ExpiringCount: 0,
			ChurnCount: 0,
			SkippedRate: 0
		}
	]
}