Trendsic Platform Service

<back to all web services

ShiftPatternsRequest

Requires Authentication
The following routes are available for this service:
GET/v1/workforce/patterns
"use strict";
export class ShiftPattern {
    /** @param {{ShiftPatternID?:number,BranchId?:string,Code?:string,Name?:string,Struct?:string,HoursPerDay?:number,OnDays?:number,OffDays?:number,PatternType?:string,IsNight?:boolean,HasBoundary?:boolean,IsHitch?:boolean,HasTravel?:boolean,IsSeasonal?:boolean,SeasonalWindow?:string,IsDayRate?:boolean,OtRuleId?:string,PerDiemRuleId?:string,Packs?:string,Status?:string,IsSeed?:boolean,AssignedCount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ShiftPatternID;
    /** @type {?string} */
    BranchId;
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {string} */
    Struct;
    /** @type {number} */
    HoursPerDay;
    /** @type {number} */
    OnDays;
    /** @type {number} */
    OffDays;
    /** @type {string} */
    PatternType;
    /** @type {boolean} */
    IsNight;
    /** @type {boolean} */
    HasBoundary;
    /** @type {boolean} */
    IsHitch;
    /** @type {boolean} */
    HasTravel;
    /** @type {boolean} */
    IsSeasonal;
    /** @type {string} */
    SeasonalWindow;
    /** @type {boolean} */
    IsDayRate;
    /** @type {string} */
    OtRuleId;
    /** @type {string} */
    PerDiemRuleId;
    /** @type {string} */
    Packs;
    /** @type {string} */
    Status;
    /** @type {boolean} */
    IsSeed;
    /** @type {number} */
    AssignedCount;
}
export class ShiftPatternsResponse {
    /** @param {{Patterns?:ShiftPattern[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ShiftPattern[]} */
    Patterns = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ShiftPatternsRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript ShiftPatternsRequest 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/workforce/patterns HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<ShiftPatternsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Patterns>
    <ShiftPattern>
      <AssignedCount>0</AssignedCount>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <Code>String</Code>
      <HasBoundary>false</HasBoundary>
      <HasTravel>false</HasTravel>
      <HoursPerDay>0</HoursPerDay>
      <IsDayRate>false</IsDayRate>
      <IsHitch>false</IsHitch>
      <IsNight>false</IsNight>
      <IsSeasonal>false</IsSeasonal>
      <IsSeed>false</IsSeed>
      <Name>String</Name>
      <OffDays>0</OffDays>
      <OnDays>0</OnDays>
      <OtRuleId>String</OtRuleId>
      <Packs>String</Packs>
      <PatternType>String</PatternType>
      <PerDiemRuleId>String</PerDiemRuleId>
      <SeasonalWindow>String</SeasonalWindow>
      <ShiftPatternID>0</ShiftPatternID>
      <Status>String</Status>
      <Struct>String</Struct>
    </ShiftPattern>
  </Patterns>
  <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>
</ShiftPatternsResponse>