Trendsic Platform Service

<back to all web services

VisitBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/visits/board
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class BoardReadiness
    {
        public virtual int TotalVisits { get; set; }
        public virtual int Assigned { get; set; }
        public virtual int Unassigned { get; set; }
        public virtual int Conflicts { get; set; }
        public virtual int AssignedPct { get; set; }
    }

    public partial class CrewColumn
    {
        public virtual int CrewID { get; set; }
        public virtual string CrewName { get; set; }
        public virtual string CrewColor { get; set; }
        public virtual int MemberCount { get; set; }
        public virtual List<VisitCard> Visits { get; set; } = [];
        public virtual double DriveMiles { get; set; }
        public virtual int DriveMinutes { get; set; }
        public virtual int OnSiteMinutes { get; set; }
        public virtual int BillablePct { get; set; }
    }

    public partial class VisitBoardRequest
    {
        public virtual string Date { get; set; }
    }

    public partial class VisitBoardResponse
    {
        public virtual string Date { get; set; }
        public virtual List<CrewColumn> Crews { get; set; } = [];
        public virtual List<VisitCard> Unassigned { get; set; } = [];
        public virtual BoardReadiness Readiness { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class VisitCard
    {
        public virtual string VisitKey { get; set; }
        public virtual int JobID { get; set; }
        public virtual int ProjectID { get; set; }
        public virtual string ProjectUID { get; set; }
        public virtual int? AgreementJobID { get; set; }
        public virtual string ScheduledDate { get; set; }
        public virtual string CustomerName { get; set; }
        public virtual string JobName { get; set; }
        public virtual string LocationName { get; set; }
        public virtual string City { get; set; }
        public virtual string Zip { get; set; }
        public virtual double? Lat { get; set; }
        public virtual double? Lng { get; set; }
        public virtual int? CrewID { get; set; }
        public virtual string CrewName { get; set; }
        public virtual int SortOrder { get; set; }
        public virtual string Status { get; set; }
        public virtual int DurationMinutes { get; set; }
        public virtual string EtaWindow { get; set; }
        public virtual bool IsCommercial { get; set; }
    }

}

C# 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
		}
	}
}