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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ComplianceSummaryDto() = 
        member val Total:Int32 = new Int32() with get,set
        member val Eligible:Int32 = new Int32() with get,set
        member val Held:Int32 = new Int32() with get,set
        member val Unscheduled:Int32 = new Int32() with get,set
        member val PendingTrigger:Int32 = new Int32() with get,set
        member val Running:Int32 = new Int32() with get,set
        member val OverdueCheckouts:Int32 = new Int32() with get,set
        member val OverdueRequests:Int32 = new Int32() with get,set
        member val QaOpen:Int32 = new Int32() with get,set
        member val RequestsOnTime90d:Int32 = new Int32() with get,set
        member val Sessions90d:Int32 = new Int32() with get,set
        member val Certs90d:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type ComplianceExceptionDto() = 
        member val Kind:String = null with get,set
        member val Count:Int32 = new Int32() with get,set
        member val RefRoute:String = null with get,set

    [<AllowNullLiteral>]
    type ComplianceSummaryResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Summary:ComplianceSummaryDto = null with get,set
        member val Exceptions:ResizeArray<ComplianceExceptionDto> = new ResizeArray<ComplianceExceptionDto>() with get,set

    [<AllowNullLiteral>]
    type ComplianceSummaryRequest() = 
        class end

F# 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>