Trendsic Platform Service

<back to all web services

CoverageSelfClaimRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/coverage/self/claim
"use strict";
export class CoverageSelfEligibility {
    /** @param {{Tone?:string,Text?:string,CanClaim?:boolean,ClaimLabel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Tone;
    /** @type {string} */
    Text;
    /** @type {boolean} */
    CanClaim;
    /** @type {string} */
    ClaimLabel;
}
export class CoverageSelfMatrixRow {
    /** @param {{Name?:string,Note?:string,Tone?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Note;
    /** @type {string} */
    Tone;
}
export class CoverageSelfCard {
    /** @param {{CoverageGapId?:number,Kind?:string,Status?:string,ShiftDay?:string,ShiftWindow?:string,ShiftStartUtc?:string,Site?:string,RoleNeeded?:string,ExpiryLabel?:string,PosterName?:string,EligibleCount?:number,IneligibleCount?:number,MyEligibility?:CoverageSelfEligibility,Matrix?:CoverageSelfMatrixRow[],SwapState?:string,SwapFromName?:string,SwapTargetName?:string,OfferShift?:string,WantShift?:string,ConflictOk?:boolean,ConflictLabel?:string,CanRespond?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CoverageGapId;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Status;
    /** @type {string} */
    ShiftDay;
    /** @type {string} */
    ShiftWindow;
    /** @type {?string} */
    ShiftStartUtc;
    /** @type {string} */
    Site;
    /** @type {string} */
    RoleNeeded;
    /** @type {string} */
    ExpiryLabel;
    /** @type {string} */
    PosterName;
    /** @type {number} */
    EligibleCount;
    /** @type {number} */
    IneligibleCount;
    /** @type {CoverageSelfEligibility} */
    MyEligibility;
    /** @type {CoverageSelfMatrixRow[]} */
    Matrix = [];
    /** @type {string} */
    SwapState;
    /** @type {string} */
    SwapFromName;
    /** @type {string} */
    SwapTargetName;
    /** @type {string} */
    OfferShift;
    /** @type {string} */
    WantShift;
    /** @type {boolean} */
    ConflictOk;
    /** @type {string} */
    ConflictLabel;
    /** @type {boolean} */
    CanRespond;
}
export class CoverageSelfCardResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Card?:CoverageSelfCard}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CoverageSelfCard} */
    Card;
}
export class CoverageSelfClaimRequest {
    /** @param {{CoverageGapId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CoverageGapId;
}

JavaScript CoverageSelfClaimRequest DTOs

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/self/claim HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CoverageSelfClaimRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CoverageGapId>0</CoverageGapId>
</CoverageSelfClaimRequest>

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

<CoverageSelfCardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Card>
    <CanRespond>false</CanRespond>
    <ConflictLabel>String</ConflictLabel>
    <ConflictOk>false</ConflictOk>
    <CoverageGapId>0</CoverageGapId>
    <EligibleCount>0</EligibleCount>
    <ExpiryLabel>String</ExpiryLabel>
    <IneligibleCount>0</IneligibleCount>
    <Kind>String</Kind>
    <Matrix>
      <CoverageSelfMatrixRow>
        <Name>String</Name>
        <Note>String</Note>
        <Tone>String</Tone>
      </CoverageSelfMatrixRow>
    </Matrix>
    <MyEligibility>
      <CanClaim>false</CanClaim>
      <ClaimLabel>String</ClaimLabel>
      <Text>String</Text>
      <Tone>String</Tone>
    </MyEligibility>
    <OfferShift>String</OfferShift>
    <PosterName>String</PosterName>
    <RoleNeeded>String</RoleNeeded>
    <ShiftDay>String</ShiftDay>
    <ShiftStartUtc>0001-01-01T00:00:00</ShiftStartUtc>
    <ShiftWindow>String</ShiftWindow>
    <Site>String</Site>
    <Status>String</Status>
    <SwapFromName>String</SwapFromName>
    <SwapState>String</SwapState>
    <SwapTargetName>String</SwapTargetName>
    <WantShift>String</WantShift>
  </Card>
  <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>
</CoverageSelfCardResponse>