Trendsic Platform Service

<back to all web services

WorkerMyDayRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/worker/myday

export class WorkerVisit
{
    public WorkerScheduleItemID: number;
    public JobID: number;
    public SortOrder: number;
    public Status: string;
    public PropertyName: string;
    public Address: string;
    public TimeWindow: string;
    public DistanceLabel: string;
    public ServiceSummary: string;
    public AreaCount?: number;
    public AccessNotes: string;
    public HasRestrictedDetails: boolean;
    public CanViewRestricted: boolean;
    public PriorVisitNotes: string;
    public RainRisk: boolean;
    public CompletedAtLabel: string;

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

export class WorkerMyDayResponse
{
    public ResponseStatus: ResponseStatus;
    public Route: string;
    public DateLabel: string;
    public IsCrewLead: boolean;
    public IsCrewMember: boolean;
    public Visits: WorkerVisit[] = [];

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

export class WorkerMyDayRequest
{
    public Date: string;

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

TypeScript WorkerMyDayRequest 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/worker/myday HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Route: String,
	DateLabel: String,
	IsCrewLead: False,
	IsCrewMember: False,
	Visits: 
	[
		{
			WorkerScheduleItemID: 0,
			JobID: 0,
			SortOrder: 0,
			Status: String,
			PropertyName: String,
			Address: String,
			TimeWindow: String,
			DistanceLabel: String,
			ServiceSummary: String,
			AreaCount: 0,
			AccessNotes: String,
			HasRestrictedDetails: False,
			CanViewRestricted: False,
			PriorVisitNotes: String,
			RainRisk: False,
			CompletedAtLabel: String
		}
	]
}