Trendsic Platform Service

<back to all web services

CoveragePeopleSearchRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/people/search
"use strict";
export class CoverageExplanationSource {
    /** @param {{PolicyName?:string,CascadeLevel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PolicyName;
    /** @type {string} */
    CascadeLevel;
}
export class CoverageExplanationOverride {
    /** @param {{Who?:string,Consequence?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Who;
    /** @type {string} */
    Consequence;
}
export class CoverageExplanation {
    /** @param {{PlainSentence?:string,RuleId?:string,RuleName?:string,Demand?:string,Source?:CoverageExplanationSource,Kind?:string,WhyItExists?:string,WhatWouldChangeIt?:string,Override?:CoverageExplanationOverride,Drill?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PlainSentence;
    /** @type {string} */
    RuleId;
    /** @type {string} */
    RuleName;
    /** @type {string} */
    Demand;
    /** @type {CoverageExplanationSource} */
    Source;
    /** @type {string} */
    Kind;
    /** @type {string} */
    WhyItExists;
    /** @type {string} */
    WhatWouldChangeIt;
    /** @type {CoverageExplanationOverride} */
    Override;
    /** @type {string} */
    Drill;
}
export class CoveragePersonAnswer {
    /** @param {{ContactId?:number,Name?:string,Tone?:string,Answer?:string,Expl?:CoverageExplanation}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    ContactId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Tone;
    /** @type {string} */
    Answer;
    /** @type {CoverageExplanation} */
    Expl;
}
export class CoveragePeopleSearchResponse {
    /** @param {{Answers?:CoveragePersonAnswer[],MissAnswer?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CoveragePersonAnswer[]} */
    Answers = [];
    /** @type {string} */
    MissAnswer;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CoveragePeopleSearchRequest {
    /** @param {{Q?:string,CoverageGapId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Q;
    /** @type {?number} */
    CoverageGapId;
}

JavaScript CoveragePeopleSearchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}