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
import Foundation
import ServiceStack

public class ComplianceSummaryRequest : Codable
{
    required public init(){}
}

public class ComplianceSummaryResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var summary:ComplianceSummaryDto
    public var exceptions:[ComplianceExceptionDto] = []

    required public init(){}
}

public class ComplianceSummaryDto : Codable
{
    public var total:Int
    public var eligible:Int
    public var held:Int
    public var unscheduled:Int
    public var pendingTrigger:Int
    public var running:Int
    public var overdueCheckouts:Int
    public var overdueRequests:Int
    public var qaOpen:Int
    public var requestsOnTime90d:Int
    public var sessions90d:Int
    public var certs90d:Int

    required public init(){}
}

public class ComplianceExceptionDto : Codable
{
    public var kind:String
    public var count:Int
    public var refRoute:String

    required public init(){}
}


Swift 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
		}
	]
}