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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CoveragePeopleSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Answers>
    <CoveragePersonAnswer>
      <Answer>String</Answer>
      <ContactId>0</ContactId>
      <Expl>
        <Demand>String</Demand>
        <Drill>String</Drill>
        <Kind>String</Kind>
        <Override>
          <Consequence>String</Consequence>
          <Who>String</Who>
        </Override>
        <PlainSentence>String</PlainSentence>
        <RuleId>String</RuleId>
        <RuleName>String</RuleName>
        <Source>
          <CascadeLevel>String</CascadeLevel>
          <PolicyName>String</PolicyName>
        </Source>
        <WhatWouldChangeIt>String</WhatWouldChangeIt>
        <WhyItExists>String</WhyItExists>
      </Expl>
      <Name>String</Name>
      <Tone>String</Tone>
    </CoveragePersonAnswer>
  </Answers>
  <MissAnswer>String</MissAnswer>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CoveragePeopleSearchResponse>