Trendsic Platform Service

<back to all web services

CoveragePeopleSearchRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/people/search
CoveragePeopleSearchRequest Parameters:
NameParameterData TypeRequiredDescription
QquerystringNo
CoverageGapIdqueryint?No
CoveragePeopleSearchResponse Parameters:
NameParameterData TypeRequiredDescription
AnswersformList<CoveragePersonAnswer>No
MissAnswerformstringNo
ResponseStatusformResponseStatusNo
CoveragePersonAnswer Parameters:
NameParameterData TypeRequiredDescription
ContactIdformint?No
NameformstringNo
ToneformstringNo
AnswerformstringNo
ExplformCoverageExplanationNo
CoverageExplanation Parameters:
NameParameterData TypeRequiredDescription
PlainSentenceformstringNo
RuleIdformstringNo
RuleNameformstringNo
DemandformstringNo
SourceformCoverageExplanationSourceNo
KindformstringNo
WhyItExistsformstringNo
WhatWouldChangeItformstringNo
OverrideformCoverageExplanationOverrideNo
DrillformstringNo
CoverageExplanationSource Parameters:
NameParameterData TypeRequiredDescription
PolicyNameformstringNo
CascadeLevelformstringNo
CoverageExplanationOverride Parameters:
NameParameterData TypeRequiredDescription
WhoformstringNo
ConsequenceformstringNo

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