| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<VisitBoardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Crews>
<CrewColumn>
<BillablePct>0</BillablePct>
<CrewColor>String</CrewColor>
<CrewID>0</CrewID>
<CrewName>String</CrewName>
<DriveMiles>0</DriveMiles>
<DriveMinutes>0</DriveMinutes>
<MemberCount>0</MemberCount>
<OnSiteMinutes>0</OnSiteMinutes>
<Visits>
<VisitCard>
<AgreementJobID>0</AgreementJobID>
<City>String</City>
<CrewID>0</CrewID>
<CrewName>String</CrewName>
<CustomerName>String</CustomerName>
<DurationMinutes>0</DurationMinutes>
<EtaWindow>String</EtaWindow>
<IsCommercial>false</IsCommercial>
<JobID>0</JobID>
<JobName>String</JobName>
<Lat>0</Lat>
<Lng>0</Lng>
<LocationName>String</LocationName>
<ProjectID>0</ProjectID>
<ProjectUID>String</ProjectUID>
<ScheduledDate>String</ScheduledDate>
<SortOrder>0</SortOrder>
<Status>String</Status>
<VisitKey>String</VisitKey>
<Zip>String</Zip>
</VisitCard>
</Visits>
</CrewColumn>
</Crews>
<Date>String</Date>
<Readiness>
<Assigned>0</Assigned>
<AssignedPct>0</AssignedPct>
<Conflicts>0</Conflicts>
<TotalVisits>0</TotalVisits>
<Unassigned>0</Unassigned>
</Readiness>
<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>
<Unassigned>
<VisitCard>
<AgreementJobID>0</AgreementJobID>
<City>String</City>
<CrewID>0</CrewID>
<CrewName>String</CrewName>
<CustomerName>String</CustomerName>
<DurationMinutes>0</DurationMinutes>
<EtaWindow>String</EtaWindow>
<IsCommercial>false</IsCommercial>
<JobID>0</JobID>
<JobName>String</JobName>
<Lat>0</Lat>
<Lng>0</Lng>
<LocationName>String</LocationName>
<ProjectID>0</ProjectID>
<ProjectUID>String</ProjectUID>
<ScheduledDate>String</ScheduledDate>
<SortOrder>0</SortOrder>
<Status>String</Status>
<VisitKey>String</VisitKey>
<Zip>String</Zip>
</VisitCard>
</Unassigned>
</VisitBoardResponse>