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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class ComplianceExceptionDto
    {
        public virtual string Kind { get; set; }
        public virtual int Count { get; set; }
        public virtual string RefRoute { get; set; }
    }

    public partial class ComplianceSummaryDto
    {
        public virtual int Total { get; set; }
        public virtual int Eligible { get; set; }
        public virtual int Held { get; set; }
        public virtual int Unscheduled { get; set; }
        public virtual int PendingTrigger { get; set; }
        public virtual int Running { get; set; }
        public virtual int OverdueCheckouts { get; set; }
        public virtual int OverdueRequests { get; set; }
        public virtual int QaOpen { get; set; }
        public virtual int RequestsOnTime90d { get; set; }
        public virtual int Sessions90d { get; set; }
        public virtual int Certs90d { get; set; }
    }

    public partial class ComplianceSummaryRequest
    {
    }

    public partial class ComplianceSummaryResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual ComplianceSummaryDto Summary { get; set; }
        public virtual List<ComplianceExceptionDto> Exceptions { get; set; } = [];
    }

}

C# 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
		}
	]
}