| POST,OPTIONS | /v1/dashboard/agreements |
|---|
"use strict";
export class DashboardStatTile {
/** @param {{Key?:string,Label?:string,Value?:number,PreviousValue?:number,Unit?:string,DeltaPct?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Key;
/** @type {string} */
Label;
/** @type {number} */
Value;
/** @type {?number} */
PreviousValue;
/** @type {string} */
Unit;
/** @type {?number} */
DeltaPct;
}
export class AgreementKpiBranchRow {
/** @param {{BranchName?:string,ActiveCount?:number,Mrr?:number,ExpiringCount?:number,ChurnCount?:number,SkippedRate?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
BranchName;
/** @type {number} */
ActiveCount;
/** @type {number} */
Mrr;
/** @type {number} */
ExpiringCount;
/** @type {number} */
ChurnCount;
/** @type {number} */
SkippedRate;
}
export class AgreementKpiResponse {
/** @param {{ResponseStatus?:ResponseStatus,Stats?:DashboardStatTile[],ByBranch?:AgreementKpiBranchRow[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {DashboardStatTile[]} */
Stats = [];
/** @type {AgreementKpiBranchRow[]} */
ByBranch = [];
}
export class AgreementKpiRequest {
/** @param {{FromDate?:string,ToDate?:string,LocationIds?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
FromDate;
/** @type {string} */
ToDate;
/** @type {string[]} */
LocationIds = [];
}
JavaScript AgreementKpiRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<AgreementKpiRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<FromDate>0001-01-01T00:00:00</FromDate>
<LocationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</LocationIds>
<ToDate>0001-01-01T00:00:00</ToDate>
</AgreementKpiRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgreementKpiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ByBranch>
<AgreementKpiBranchRow>
<ActiveCount>0</ActiveCount>
<BranchName>String</BranchName>
<ChurnCount>0</ChurnCount>
<ExpiringCount>0</ExpiringCount>
<Mrr>0</Mrr>
<SkippedRate>0</SkippedRate>
</AgreementKpiBranchRow>
</ByBranch>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Stats>
<DashboardStatTile>
<Key>String</Key>
<Label>String</Label>
<PreviousValue>0</PreviousValue>
<Unit>String</Unit>
<Value>0</Value>
</DashboardStatTile>
</Stats>
</AgreementKpiResponse>