Trendsic Platform Service

<back to all web services

VisitBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/visits/board
import Foundation
import ServiceStack

public class VisitBoardRequest : Codable
{
    public var date:String

    required public init(){}
}

public class VisitBoardResponse : Codable
{
    public var date:String
    public var crews:[CrewColumn] = []
    public var unassigned:[VisitCard] = []
    public var readiness:BoardReadiness
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class CrewColumn : Codable
{
    public var crewID:Int
    public var crewName:String
    public var crewColor:String
    public var memberCount:Int
    public var visits:[VisitCard] = []
    public var driveMiles:Double
    public var driveMinutes:Int
    public var onSiteMinutes:Int
    public var billablePct:Int

    required public init(){}
}

public class VisitCard : Codable
{
    public var visitKey:String
    public var jobID:Int
    public var projectID:Int
    public var projectUID:String
    public var agreementJobID:Int?
    public var scheduledDate:String
    public var customerName:String
    public var jobName:String
    public var locationName:String
    public var city:String
    public var zip:String
    public var lat:Double?
    public var lng:Double?
    public var crewID:Int?
    public var crewName:String
    public var sortOrder:Int
    public var status:String
    public var durationMinutes:Int
    public var etaWindow:String
    public var isCommercial:Bool

    required public init(){}
}

public class BoardReadiness : Codable
{
    public var totalVisits:Int
    public var assigned:Int
    public var unassigned:Int
    public var conflicts:Int
    public var assignedPct:Int

    required public init(){}
}

Swift VisitBoardRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}