Trendsic Platform Service

<back to all web services

CoveragePeopleSearchRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/people/search

export class CoverageExplanationSource
{
    public PolicyName: string;
    public CascadeLevel: string;

    public constructor(init?: Partial<CoverageExplanationSource>) { (Object as any).assign(this, init); }
}

export class CoverageExplanationOverride
{
    public Who: string;
    public Consequence: string;

    public constructor(init?: Partial<CoverageExplanationOverride>) { (Object as any).assign(this, init); }
}

export class CoverageExplanation
{
    public PlainSentence: string;
    public RuleId: string;
    public RuleName: string;
    public Demand: string;
    public Source: CoverageExplanationSource;
    public Kind: string;
    public WhyItExists: string;
    public WhatWouldChangeIt: string;
    public Override: CoverageExplanationOverride;
    public Drill: string;

    public constructor(init?: Partial<CoverageExplanation>) { (Object as any).assign(this, init); }
}

export class CoveragePersonAnswer
{
    public ContactId?: number;
    public Name: string;
    public Tone: string;
    public Answer: string;
    public Expl: CoverageExplanation;

    public constructor(init?: Partial<CoveragePersonAnswer>) { (Object as any).assign(this, init); }
}

export class CoveragePeopleSearchResponse
{
    public Answers: CoveragePersonAnswer[] = [];
    public MissAnswer: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CoveragePeopleSearchResponse>) { (Object as any).assign(this, init); }
}

export class CoveragePeopleSearchRequest
{
    public Q: string;
    public CoverageGapId?: number;

    public constructor(init?: Partial<CoveragePeopleSearchRequest>) { (Object as any).assign(this, init); }
}

TypeScript CoveragePeopleSearchRequest 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/people/search HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Answers: 
	[
		{
			ContactId: 0,
			Name: String,
			Tone: String,
			Answer: String,
			Expl: 
			{
				PlainSentence: String,
				RuleId: String,
				RuleName: String,
				Demand: String,
				Source: 
				{
					PolicyName: String,
					CascadeLevel: String
				},
				Kind: String,
				WhyItExists: String,
				WhatWouldChangeIt: String,
				Override: 
				{
					Who: String,
					Consequence: String
				},
				Drill: String
			}
		}
	],
	MissAnswer: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}