Trendsic Platform Service

<back to all web services

CoveragePlannedRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/planned
"use strict";
export class CoveragePtoCheck {
    /** @param {{Ok?:boolean,Text?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Ok;
    /** @type {string} */
    Text;
}
export class CoveragePlannedItem {
    /** @param {{WorkerTimeOffID?:number,ContactId?:number,WorkerName?:string,Initials?:string,Dates?:string,Reason?:string,Stage?:string,StageLabel?:string,NeedBook?:boolean,CoverageGapId?:number,Checks?:CoveragePtoCheck[],DenyReason?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkerTimeOffID;
    /** @type {number} */
    ContactId;
    /** @type {string} */
    WorkerName;
    /** @type {string} */
    Initials;
    /** @type {string} */
    Dates;
    /** @type {string} */
    Reason;
    /** @type {string} */
    Stage;
    /** @type {string} */
    StageLabel;
    /** @type {boolean} */
    NeedBook;
    /** @type {?number} */
    CoverageGapId;
    /** @type {CoveragePtoCheck[]} */
    Checks = [];
    /** @type {string} */
    DenyReason;
}
export class CoveragePlannedResponse {
    /** @param {{Items?:CoveragePlannedItem[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CoveragePlannedItem[]} */
    Items = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CoveragePlannedRequest {
    constructor(init) { Object.assign(this, init) }
}

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

GET /v1/coverage/planned HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<CoveragePlannedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Items>
    <CoveragePlannedItem>
      <Checks>
        <CoveragePtoCheck>
          <Ok>false</Ok>
          <Text>String</Text>
        </CoveragePtoCheck>
      </Checks>
      <ContactId>0</ContactId>
      <CoverageGapId>0</CoverageGapId>
      <Dates>String</Dates>
      <DenyReason>String</DenyReason>
      <Initials>String</Initials>
      <NeedBook>false</NeedBook>
      <Reason>String</Reason>
      <Stage>String</Stage>
      <StageLabel>String</StageLabel>
      <WorkerName>String</WorkerName>
      <WorkerTimeOffID>0</WorkerTimeOffID>
    </CoveragePlannedItem>
  </Items>
  <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>
</CoveragePlannedResponse>