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 .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/records/compliance/summary 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
		}
	},
	Summary: 
	{
		Total: 0,
		Eligible: 0,
		Held: 0,
		Unscheduled: 0,
		PendingTrigger: 0,
		Running: 0,
		OverdueCheckouts: 0,
		OverdueRequests: 0,
		QaOpen: 0,
		RequestsOnTime90d: 0,
		Sessions90d: 0,
		Certs90d: 0
	},
	Exceptions: 
	[
		{
			Kind: String,
			Count: 0,
			RefRoute: String
		}
	]
}