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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class VisitBoardRequest
{
    open var Date:String? = null
}

open class VisitBoardResponse
{
    open var Date:String? = null
    open var Crews:ArrayList<CrewColumn> = ArrayList<CrewColumn>()
    open var Unassigned:ArrayList<VisitCard> = ArrayList<VisitCard>()
    open var Readiness:BoardReadiness? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CrewColumn
{
    open var CrewID:Int? = null
    open var CrewName:String? = null
    open var CrewColor:String? = null
    open var MemberCount:Int? = null
    open var Visits:ArrayList<VisitCard> = ArrayList<VisitCard>()
    open var DriveMiles:Double? = null
    open var DriveMinutes:Int? = null
    open var OnSiteMinutes:Int? = null
    open var BillablePct:Int? = null
}

open class VisitCard
{
    open var VisitKey:String? = null
    open var JobID:Int? = null
    open var ProjectID:Int? = null
    open var ProjectUID:String? = null
    open var AgreementJobID:Int? = null
    open var ScheduledDate:String? = null
    open var CustomerName:String? = null
    open var JobName:String? = null
    open var LocationName:String? = null
    open var City:String? = null
    open var Zip:String? = null
    open var Lat:Double? = null
    open var Lng:Double? = null
    open var CrewID:Int? = null
    open var CrewName:String? = null
    open var SortOrder:Int? = null
    open var Status:String? = null
    open var DurationMinutes:Int? = null
    open var EtaWindow:String? = null
    open var IsCommercial:Boolean? = null
}

open class BoardReadiness
{
    open var TotalVisits:Int? = null
    open var Assigned:Int? = null
    open var Unassigned:Int? = null
    open var Conflicts:Int? = null
    open var AssignedPct:Int? = null
}

Kotlin 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"}}}