Trendsic Platform Service

<back to all web services

CoverageOfferClaimRequest

The following routes are available for this service:
POST/v1/coverage/offer/{Token}/claim
CoverageOfferClaimRequest Parameters:
NameParameterData TypeRequiredDescription
TokenpathstringNo
CoverageOfferViewResponse Parameters:
NameParameterData TypeRequiredDescription
StateformstringNo
WorkerFirstformstringNo
PrimaryformstringNo
KindformstringNo
RoleformstringNo
PayformstringNo
SiteformstringNo
AddressformstringNo
GapDateformstringNo
GapTimeformstringNo
CalMonformstringNo
CalDayformstringNo
ReportToformstringNo
EligformList<CoverageOfferEligChip>No
AssignmentModeformstringNo
TicketformstringNo
ExpiresformstringNo
BlockExplformCoverageExplanationNo
ResponseStatusformResponseStatusNo
CoverageOfferEligChip Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
DetailformstringNo
StateformstringNo
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.

POST /v1/coverage/offer/{Token}/claim HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CoverageOfferClaimRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Token>String</Token>
</CoverageOfferClaimRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CoverageOfferViewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Address>String</Address>
  <AssignmentMode>String</AssignmentMode>
  <BlockExpl>
    <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>
  </BlockExpl>
  <CalDay>String</CalDay>
  <CalMon>String</CalMon>
  <Elig>
    <CoverageOfferEligChip>
      <Detail>String</Detail>
      <Label>String</Label>
      <State>String</State>
    </CoverageOfferEligChip>
  </Elig>
  <Expires>String</Expires>
  <GapDate>String</GapDate>
  <GapTime>String</GapTime>
  <Kind>String</Kind>
  <Pay>String</Pay>
  <Primary>String</Primary>
  <ReportTo>String</ReportTo>
  <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>
  <Role>String</Role>
  <Site>String</Site>
  <State>String</State>
  <Ticket>String</Ticket>
  <WorkerFirst>String</WorkerFirst>
</CoverageOfferViewResponse>