Trendsic Platform Service

<back to all web services

VisitBoardRequest

export class VisitCard
{
    public VisitKey: string;
    public JobID: number;
    public ProjectID: number;
    public ProjectUID: string;
    public AgreementJobID?: number;
    public ScheduledDate: string;
    public CustomerName: string;
    public JobName: string;
    public LocationName: string;
    public City: string;
    public Zip: string;
    public Lat?: number;
    public Lng?: number;
    public CrewID?: number;
    public CrewName: string;
    public SortOrder: number;
    public Status: string;
    public DurationMinutes: number;
    public EtaWindow: string;
    public IsCommercial: boolean;

    public constructor(init?: Partial<VisitCard>) { (Object as any).assign(this, init); }
}

export class CrewColumn
{
    public CrewID: number;
    public CrewName: string;
    public CrewColor: string;
    public MemberCount: number;
    public Visits: VisitCard[] = [];
    public DriveMiles: number;
    public DriveMinutes: number;
    public OnSiteMinutes: number;
    public BillablePct: number;

    public constructor(init?: Partial<CrewColumn>) { (Object as any).assign(this, init); }
}

export class BoardReadiness
{
    public TotalVisits: number;
    public Assigned: number;
    public Unassigned: number;
    public Conflicts: number;
    public AssignedPct: number;

    public constructor(init?: Partial<BoardReadiness>) { (Object as any).assign(this, init); }
}

export class VisitBoardResponse
{
    public Date: string;
    public Crews: CrewColumn[] = [];
    public Unassigned: VisitCard[] = [];
    public Readiness: BoardReadiness;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<VisitBoardResponse>) { (Object as any).assign(this, init); }
}

export class VisitBoardRequest
{
    public Date: string;

    public constructor(init?: Partial<VisitBoardRequest>) { (Object as any).assign(this, init); }
}

TypeScript VisitBoardRequest DTOs

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