Trendsic Platform Service

<back to all web services

WorkerMyDayRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/worker/myday
"use strict";
export class WorkerVisit {
    /** @param {{WorkerScheduleItemID?:number,JobID?:number,SortOrder?:number,Status?:string,PropertyName?:string,Address?:string,TimeWindow?:string,DistanceLabel?:string,ServiceSummary?:string,AreaCount?:number,AccessNotes?:string,HasRestrictedDetails?:boolean,CanViewRestricted?:boolean,PriorVisitNotes?:string,RainRisk?:boolean,CompletedAtLabel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkerScheduleItemID;
    /** @type {number} */
    JobID;
    /** @type {number} */
    SortOrder;
    /** @type {string} */
    Status;
    /** @type {string} */
    PropertyName;
    /** @type {string} */
    Address;
    /** @type {string} */
    TimeWindow;
    /** @type {string} */
    DistanceLabel;
    /** @type {string} */
    ServiceSummary;
    /** @type {?number} */
    AreaCount;
    /** @type {string} */
    AccessNotes;
    /** @type {boolean} */
    HasRestrictedDetails;
    /** @type {boolean} */
    CanViewRestricted;
    /** @type {string} */
    PriorVisitNotes;
    /** @type {boolean} */
    RainRisk;
    /** @type {string} */
    CompletedAtLabel;
}
export class WorkerMyDayResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Route?:string,DateLabel?:string,IsCrewLead?:boolean,IsCrewMember?:boolean,Visits?:WorkerVisit[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {string} */
    Route;
    /** @type {string} */
    DateLabel;
    /** @type {boolean} */
    IsCrewLead;
    /** @type {boolean} */
    IsCrewMember;
    /** @type {WorkerVisit[]} */
    Visits = [];
}
export class WorkerMyDayRequest {
    /** @param {{Date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Date;
}

JavaScript WorkerMyDayRequest 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/worker/myday HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkerMyDayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DateLabel>String</DateLabel>
  <IsCrewLead>false</IsCrewLead>
  <IsCrewMember>false</IsCrewMember>
  <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>
  <Route>String</Route>
  <Visits>
    <WorkerVisit>
      <AccessNotes>String</AccessNotes>
      <Address>String</Address>
      <AreaCount>0</AreaCount>
      <CanViewRestricted>false</CanViewRestricted>
      <CompletedAtLabel>String</CompletedAtLabel>
      <DistanceLabel>String</DistanceLabel>
      <HasRestrictedDetails>false</HasRestrictedDetails>
      <JobID>0</JobID>
      <PriorVisitNotes>String</PriorVisitNotes>
      <PropertyName>String</PropertyName>
      <RainRisk>false</RainRisk>
      <ServiceSummary>String</ServiceSummary>
      <SortOrder>0</SortOrder>
      <Status>String</Status>
      <TimeWindow>String</TimeWindow>
      <WorkerScheduleItemID>0</WorkerScheduleItemID>
    </WorkerVisit>
  </Visits>
</WorkerMyDayResponse>