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 .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Route":"String","DateLabel":"String","IsCrewLead":false,"IsCrewMember":false,"Visits":[{"WorkerScheduleItemID":0,"JobID":0,"SortOrder":0,"Status":"String","PropertyName":"String","Address":"String","TimeWindow":"String","DistanceLabel":"String","ServiceSummary":"String","AreaCount":0,"AccessNotes":"String","HasRestrictedDetails":false,"CanViewRestricted":false,"PriorVisitNotes":"String","RainRisk":false,"CompletedAtLabel":"String"}]}