Trendsic Platform Service

<back to all web services

ScheduleStatusRequest

Requires Authentication
The following routes are available for this service:
PUT/v1/schedule/status
ScheduleStatusRequest Parameters:
NameParameterData TypeRequiredDescription
WorkerScheduleItemIDbodyintNo
StatusbodystringNo
WorkerNotesbodystringNo
WorkerScheduleResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<WorkerScheduleItem>No
SchedulableJobsformList<SchedulableJob>No
WorkersformList<ScheduleWorker>No
CrewsformList<Crew>No
BudgetedCrewformList<ScheduleWorker>No
LastAssignmentformScheduleLastAssignmentNo
AutoFillformScheduleAutoFillResultNo
DatesScheduledformint?No
WorkersScheduledformint?No
ItemsRemovedformint?No
ResponseStatusformResponseStatusNo
WorkerScheduleItem Parameters:
NameParameterData TypeRequiredDescription
WorkerScheduleItemIDformintNo
JobIDformintNo
ProjectIDformint?No
ContactIDformintNo
ScheduledDateformDateTime?No
SortOrderformintNo
SourceCrewIDformint?No
StatusformstringNo
StartedAtformDateTime?No
CompletedAtformDateTime?No
WorkerNotesformstringNo
JobNameformstringNo
ProjectNameformstringNo
FirstNameformstringNo
LastNameformstringNo
WorkerNameformstringNo
SourceCrewNameformstringNo
ProjectLocationIDformint?No
ProjectLocationNameformstringNo
LocationZipformstringNo
LocationCityformstringNo
LocationLatitudeformdecimal?No
LocationLongitudeformdecimal?No
JobStatusNameformstringNo
SchedulableJob Parameters:
NameParameterData TypeRequiredDescription
JobIDformintNo
JobNameformstringNo
ProjectIDformintNo
ProjectNameformstringNo
StatusIDformint?No
StatusNameformstringNo
ProjectLocationIDformint?No
ProjectLocationNameformstringNo
LocationZipformstringNo
LocationCityformstringNo
LocationLatitudeformdecimal?No
LocationLongitudeformdecimal?No
ExpectedStartDateformDateTime?No
ExpectedCompletionDateformDateTime?No
IsRecurringformboolNo
OccurrenceDatesformList<string>No
ScheduleWorker Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
FirstNameformstringNo
LastNameformstringNo
NameformstringNo
InitialsformstringNo
Rateformdecimal?No
ImageUrlformstringNo
Crew Parameters:
NameParameterData TypeRequiredDescription
CrewIDformintNo
CrewNameformstringNo
CrewNumberformstringNo
CrewManagerContactIDformintNo
CrewManagerContactNameformstringNo
CrewColorformstringNo
RecordCreatedDateformDateTimeNo
ActiveformboolNo
CreatedByUIDformGuidNo
ProjectIDformintNo
CrewMemberCountformintNo
ProjectCrewIDformintNo
ProjectNameformstringNo
ScheduleLastAssignment Parameters:
NameParameterData TypeRequiredDescription
JobIDformintNo
ContactIdsformList<int>No
SourceCrewIDformint?No
ScheduleAutoFillResult Parameters:
NameParameterData TypeRequiredDescription
JobsFilledformintNo
JobsSkippedformintNo
VisitsScheduledformintNo

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.

PUT /v1/schedule/status HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	WorkerScheduleItemID: 0,
	Status: String,
	WorkerNotes: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Items: 
	[
		{
			WorkerScheduleItemID: 0,
			JobID: 0,
			ProjectID: 0,
			ContactID: 0,
			ScheduledDate: 0001-01-01,
			SortOrder: 0,
			SourceCrewID: 0,
			Status: String,
			StartedAt: 0001-01-01,
			CompletedAt: 0001-01-01,
			WorkerNotes: String,
			JobName: String,
			ProjectName: String,
			FirstName: String,
			LastName: String,
			WorkerName: String,
			SourceCrewName: String,
			ProjectLocationID: 0,
			ProjectLocationName: String,
			LocationZip: String,
			LocationCity: String,
			LocationLatitude: 0,
			LocationLongitude: 0,
			JobStatusName: String
		}
	],
	SchedulableJobs: 
	[
		{
			JobID: 0,
			JobName: String,
			ProjectID: 0,
			ProjectName: String,
			StatusID: 0,
			StatusName: String,
			ProjectLocationID: 0,
			ProjectLocationName: String,
			LocationZip: String,
			LocationCity: String,
			LocationLatitude: 0,
			LocationLongitude: 0,
			ExpectedStartDate: 0001-01-01,
			ExpectedCompletionDate: 0001-01-01,
			IsRecurring: False,
			OccurrenceDates: 
			[
				String
			]
		}
	],
	Workers: 
	[
		{
			ContactId: 0,
			FirstName: String,
			LastName: String,
			Name: String,
			Initials: String,
			Rate: 0,
			ImageUrl: String
		}
	],
	Crews: 
	[
		{
			CrewID: 0,
			CrewName: String,
			CrewNumber: String,
			CrewManagerContactID: 0,
			CrewManagerContactName: String,
			CrewColor: String,
			RecordCreatedDate: 0001-01-01,
			Active: False,
			CreatedByUID: 00000000000000000000000000000000,
			ProjectID: 0,
			CrewMemberCount: 0,
			ProjectCrewID: 0,
			ProjectName: String
		}
	],
	BudgetedCrew: 
	[
		{
			ContactId: 0,
			FirstName: String,
			LastName: String,
			Name: String,
			Initials: String,
			Rate: 0,
			ImageUrl: String
		}
	],
	LastAssignment: 
	{
		JobID: 0,
		ContactIds: 
		[
			0
		],
		SourceCrewID: 0
	},
	AutoFill: 
	{
		JobsFilled: 0,
		JobsSkipped: 0,
		VisitsScheduled: 0
	},
	DatesScheduled: 0,
	WorkersScheduled: 0,
	ItemsRemoved: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}