Trendsic Platform Service

<back to all web services

CoverageOfferClaimRequest

The following routes are available for this service:
POST/v1/coverage/offer/{Token}/claim
"use strict";
export class CoverageOfferEligChip {
    /** @param {{Label?:string,Detail?:string,State?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Label;
    /** @type {string} */
    Detail;
    /** @type {string} */
    State;
}
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 CoverageOfferViewResponse {
    /** @param {{State?:string,WorkerFirst?:string,Primary?:string,Kind?:string,Role?:string,Pay?:string,Site?:string,Address?:string,GapDate?:string,GapTime?:string,CalMon?:string,CalDay?:string,ReportTo?:string,Elig?:CoverageOfferEligChip[],AssignmentMode?:string,Ticket?:string,Expires?:string,BlockExpl?:CoverageExplanation,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    State;
    /** @type {string} */
    WorkerFirst;
    /** @type {string} */
    Primary;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Role;
    /** @type {string} */
    Pay;
    /** @type {string} */
    Site;
    /** @type {string} */
    Address;
    /** @type {string} */
    GapDate;
    /** @type {string} */
    GapTime;
    /** @type {string} */
    CalMon;
    /** @type {string} */
    CalDay;
    /** @type {string} */
    ReportTo;
    /** @type {CoverageOfferEligChip[]} */
    Elig = [];
    /** @type {string} */
    AssignmentMode;
    /** @type {string} */
    Ticket;
    /** @type {string} */
    Expires;
    /** @type {CoverageExplanation} */
    BlockExpl;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CoverageOfferClaimRequest {
    /** @param {{Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Token;
}

JavaScript CoverageOfferClaimRequest 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.

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

{"Token":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"State":"String","WorkerFirst":"String","Primary":"String","Kind":"String","Role":"String","Pay":"String","Site":"String","Address":"String","GapDate":"String","GapTime":"String","CalMon":"String","CalDay":"String","ReportTo":"String","Elig":[{"Label":"String","Detail":"String","State":"String"}],"AssignmentMode":"String","Ticket":"String","Expires":"String","BlockExpl":{"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"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}