Trendsic Platform Service

<back to all web services

ComplianceSummaryRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/compliance/summary
"use strict";
export class ComplianceSummaryDto {
    /** @param {{Total?:number,Eligible?:number,Held?:number,Unscheduled?:number,PendingTrigger?:number,Running?:number,OverdueCheckouts?:number,OverdueRequests?:number,QaOpen?:number,RequestsOnTime90d?:number,Sessions90d?:number,Certs90d?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Total;
    /** @type {number} */
    Eligible;
    /** @type {number} */
    Held;
    /** @type {number} */
    Unscheduled;
    /** @type {number} */
    PendingTrigger;
    /** @type {number} */
    Running;
    /** @type {number} */
    OverdueCheckouts;
    /** @type {number} */
    OverdueRequests;
    /** @type {number} */
    QaOpen;
    /** @type {number} */
    RequestsOnTime90d;
    /** @type {number} */
    Sessions90d;
    /** @type {number} */
    Certs90d;
}
export class ComplianceExceptionDto {
    /** @param {{Kind?:string,Count?:number,RefRoute?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Kind;
    /** @type {number} */
    Count;
    /** @type {string} */
    RefRoute;
}
export class ComplianceSummaryResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Summary?:ComplianceSummaryDto,Exceptions?:ComplianceExceptionDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ComplianceSummaryDto} */
    Summary;
    /** @type {ComplianceExceptionDto[]} */
    Exceptions = [];
}
export class ComplianceSummaryRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript ComplianceSummaryRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/records/compliance/summary HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ComplianceSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Exceptions>
    <ComplianceExceptionDto>
      <Count>0</Count>
      <Kind>String</Kind>
      <RefRoute>String</RefRoute>
    </ComplianceExceptionDto>
  </Exceptions>
  <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>
  <Summary>
    <Certs90d>0</Certs90d>
    <Eligible>0</Eligible>
    <Held>0</Held>
    <OverdueCheckouts>0</OverdueCheckouts>
    <OverdueRequests>0</OverdueRequests>
    <PendingTrigger>0</PendingTrigger>
    <QaOpen>0</QaOpen>
    <RequestsOnTime90d>0</RequestsOnTime90d>
    <Running>0</Running>
    <Sessions90d>0</Sessions90d>
    <Total>0</Total>
    <Unscheduled>0</Unscheduled>
  </Summary>
</ComplianceSummaryResponse>