Trendsic Platform Service

<back to all web services

CoveragePoliciesRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/policies
"use strict";
export class CoveragePolicy {
    /** @param {{CoveragePolicyId?:number,CoveragePolicyUID?:string,Name?:string,ScopeLevel?:string,BranchId?:string,BranchName?:string,WorkTypeKey?:string,JobID?:number,JobName?:string,CurrentVersion?:number,IsActive?:boolean,CreatedAt?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CoveragePolicyId;
    /** @type {string} */
    CoveragePolicyUID;
    /** @type {string} */
    Name;
    /** @type {string} */
    ScopeLevel;
    /** @type {?string} */
    BranchId;
    /** @type {string} */
    BranchName;
    /** @type {string} */
    WorkTypeKey;
    /** @type {?number} */
    JobID;
    /** @type {string} */
    JobName;
    /** @type {number} */
    CurrentVersion;
    /** @type {boolean} */
    IsActive;
    /** @type {string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
}
export class CoveragePoliciesResponse {
    /** @param {{Policies?:CoveragePolicy[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CoveragePolicy[]} */
    Policies = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CoveragePoliciesRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript CoveragePoliciesRequest 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/coverage/policies HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Policies: 
	[
		{
			CoveragePolicyId: 0,
			CoveragePolicyUID: 00000000000000000000000000000000,
			Name: String,
			ScopeLevel: String,
			BranchId: 00000000000000000000000000000000,
			BranchName: String,
			WorkTypeKey: String,
			JobID: 0,
			JobName: String,
			CurrentVersion: 0,
			IsActive: False,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}