Trendsic Platform Service

VisitBoardRequest

The following routes are available for this service:
GET,OPTIONS	/v1/visits/board

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class BoardReadiness
            Public Overridable Property TotalVisits As Integer
            Public Overridable Property Assigned As Integer
            Public Overridable Property Unassigned As Integer
            Public Overridable Property Conflicts As Integer
            Public Overridable Property AssignedPct As Integer
        End Class

        Public Partial Class CrewColumn
            Public Overridable Property CrewID As Integer
            Public Overridable Property CrewName As String
            Public Overridable Property CrewColor As String
            Public Overridable Property MemberCount As Integer
            Public Overridable Property Visits As List(Of VisitCard) = New List(Of VisitCard)
            Public Overridable Property DriveMiles As Double
            Public Overridable Property DriveMinutes As Integer
            Public Overridable Property OnSiteMinutes As Integer
            Public Overridable Property BillablePct As Integer
        End Class

        Public Partial Class VisitBoardRequest
            Public Overridable Property [Date] As String
        End Class

        Public Partial Class VisitBoardResponse
            Public Overridable Property [Date] As String
            Public Overridable Property Crews As List(Of CrewColumn) = New List(Of CrewColumn)
            Public Overridable Property Unassigned As List(Of VisitCard) = New List(Of VisitCard)
            Public Overridable Property Readiness As BoardReadiness
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class VisitCard
            Public Overridable Property VisitKey As String
            Public Overridable Property JobID As Integer
            Public Overridable Property ProjectID As Integer
            Public Overridable Property ProjectUID As String
            Public Overridable Property AgreementJobID As Integer?
            Public Overridable Property ScheduledDate As String
            Public Overridable Property CustomerName As String
            Public Overridable Property JobName As String
            Public Overridable Property LocationName As String
            Public Overridable Property City As String
            Public Overridable Property Zip As String
            Public Overridable Property Lat As Double?
            Public Overridable Property Lng As Double?
            Public Overridable Property CrewID As Integer?
            Public Overridable Property CrewName As String
            Public Overridable Property SortOrder As Integer
            Public Overridable Property Status As String
            Public Overridable Property DurationMinutes As Integer
            Public Overridable Property EtaWindow As String
            Public Overridable Property IsCommercial As Boolean
        End Class
    End Namespace
End Namespace

VB.NET VisitBoardRequest DTOs

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

HTTP + JSV

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

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}