Trendsic Platform Service

<back to all web services

VisitBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/visits/board
"use strict";
export class VisitCard {
    /** @param {{VisitKey?:string,JobID?:number,ProjectID?:number,ProjectUID?:string,AgreementJobID?:number,ScheduledDate?:string,CustomerName?:string,JobName?:string,LocationName?:string,City?:string,Zip?:string,Lat?:number,Lng?:number,CrewID?:number,CrewName?:string,SortOrder?:number,Status?:string,DurationMinutes?:number,EtaWindow?:string,IsCommercial?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    VisitKey;
    /** @type {number} */
    JobID;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    ProjectUID;
    /** @type {?number} */
    AgreementJobID;
    /** @type {string} */
    ScheduledDate;
    /** @type {string} */
    CustomerName;
    /** @type {string} */
    JobName;
    /** @type {string} */
    LocationName;
    /** @type {string} */
    City;
    /** @type {string} */
    Zip;
    /** @type {?number} */
    Lat;
    /** @type {?number} */
    Lng;
    /** @type {?number} */
    CrewID;
    /** @type {string} */
    CrewName;
    /** @type {number} */
    SortOrder;
    /** @type {string} */
    Status;
    /** @type {number} */
    DurationMinutes;
    /** @type {string} */
    EtaWindow;
    /** @type {boolean} */
    IsCommercial;
}
export class CrewColumn {
    /** @param {{CrewID?:number,CrewName?:string,CrewColor?:string,MemberCount?:number,Visits?:VisitCard[],DriveMiles?:number,DriveMinutes?:number,OnSiteMinutes?:number,BillablePct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CrewID;
    /** @type {string} */
    CrewName;
    /** @type {string} */
    CrewColor;
    /** @type {number} */
    MemberCount;
    /** @type {VisitCard[]} */
    Visits = [];
    /** @type {number} */
    DriveMiles;
    /** @type {number} */
    DriveMinutes;
    /** @type {number} */
    OnSiteMinutes;
    /** @type {number} */
    BillablePct;
}
export class BoardReadiness {
    /** @param {{TotalVisits?:number,Assigned?:number,Unassigned?:number,Conflicts?:number,AssignedPct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TotalVisits;
    /** @type {number} */
    Assigned;
    /** @type {number} */
    Unassigned;
    /** @type {number} */
    Conflicts;
    /** @type {number} */
    AssignedPct;
}
export class VisitBoardResponse {
    /** @param {{Date?:string,Crews?:CrewColumn[],Unassigned?:VisitCard[],Readiness?:BoardReadiness,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Date;
    /** @type {CrewColumn[]} */
    Crews = [];
    /** @type {VisitCard[]} */
    Unassigned = [];
    /** @type {BoardReadiness} */
    Readiness;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class VisitBoardRequest {
    /** @param {{Date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Date;
}

JavaScript VisitBoardRequest 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/visits/board HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Date":"String","Crews":[{"CrewID":0,"CrewName":"String","CrewColor":"String","MemberCount":0,"Visits":[{"VisitKey":"String","JobID":0,"ProjectID":0,"ProjectUID":"String","AgreementJobID":0,"ScheduledDate":"String","CustomerName":"String","JobName":"String","LocationName":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"CrewID":0,"CrewName":"String","SortOrder":0,"Status":"String","DurationMinutes":0,"EtaWindow":"String","IsCommercial":false}],"DriveMiles":0,"DriveMinutes":0,"OnSiteMinutes":0,"BillablePct":0}],"Unassigned":[{"VisitKey":"String","JobID":0,"ProjectID":0,"ProjectUID":"String","AgreementJobID":0,"ScheduledDate":"String","CustomerName":"String","JobName":"String","LocationName":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"CrewID":0,"CrewName":"String","SortOrder":0,"Status":"String","DurationMinutes":0,"EtaWindow":"String","IsCommercial":false}],"Readiness":{"TotalVisits":0,"Assigned":0,"Unassigned":0,"Conflicts":0,"AssignedPct":0},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}