Trendsic Platform Service

<back to all web services

MaterialProjectJobsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Project/{ProjectID}/material/{MaterialID}/Jobs
MaterialProjectJobsRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
MaterialIDpathintNo
MaterialProjectJobsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
JobsformList<Job>No
Job Parameters:
NameParameterData TypeRequiredDescription
JobIDformintNo
JobNameformstringNo
JobTypeIDformintNo
ExpectedStartDateformDateTimeNo
ActualStartDateformDateTimeNo
ExpectedCompletionDateformDateTimeNo
ActualEndDateformDateTimeNo
ActiveformboolNo
CreatedByUIDformGuidNo
ProjectIDformintNo
StatusIdformintNo
AdvancedSchedulingformboolNo
ShowTimesformboolNo
ScheduleformList<CalendarEvent>No
CalendarEvent Parameters:
NameParameterData TypeRequiredDescription
CalendarEventIdformintNo
CalendarIdformGuidNo
EventStartformDateTimeNo
EventEndformDateTimeNo
LocationformstringNo
SummaryformstringNo
DescriptionformstringNo
EventTypeIdformintNo
RecurrenceformboolNo
RecurrenceFrequencyformstringNo
RecurrenceByformstringNo
RecurrenceByValueformstringNo
RecurrenceUntilformDateTimeNo
CreatedByformstringNo
CreatedByNameformstringNo
DateCreatedformDateTimeNo
ModifiedByformstringNo
DateModifiedformDateTimeNo
DeletedformboolNo
TimeZoneformstringNo
OffsetformintNo
TextReminderSentDateformDateTimeNo
ConfirmedformboolNo
ConfirmationTextIdformstringNo
FirstTextReminderIdformstringNo
SecondTextReminderIdformstringNo
LocationUIDformGuid?No
AgentReminderSentDateformDateTimeNo
ContactIdformintNo
IsPrivateformboolNo
ProjectIDformintNo
JobIDformintNo
ProjectStartDateformDateTimeNo
ProjectEndDateformDateTimeNo
MaxCrewEndDateformDateTimeNo
MaxEquipmentEndDateformDateTimeNo
CheckInIdformGuidNo
AllDayformboolNo
JobNameformstringNo
JobStatusNameformstringNo
JobStatusIdformintNo
ProjectNameformstringNo
ResourceIdformintNo
ResourceNameformstringNo
Original_EventStartformDateTimeNo
Original_RecurrenceformboolNo
Original_RecurrenceFrequencyformstringNo
Original_RecurrenceByformstringNo
Original_RecurrenceByValueformstringNo
Original_RecurrenceUntilformDateTimeNo
ChecksumformstringNo

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/Project/{ProjectID}/material/{MaterialID}/Jobs 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
		}
	},
	Jobs: 
	[
		{
			JobID: 0,
			JobName: String,
			JobTypeID: 0,
			ExpectedStartDate: 0001-01-01,
			ActualStartDate: 0001-01-01,
			ExpectedCompletionDate: 0001-01-01,
			ActualEndDate: 0001-01-01,
			Active: False,
			CreatedByUID: 00000000000000000000000000000000,
			ProjectID: 0,
			StatusId: 0,
			AdvancedScheduling: False,
			ShowTimes: False,
			Schedule: 
			[
				{
					CalendarEventId: 0,
					CalendarId: 00000000000000000000000000000000,
					EventStart: 0001-01-01,
					EventEnd: 0001-01-01,
					Location: String,
					Summary: String,
					Description: String,
					EventTypeId: 0,
					Recurrence: False,
					RecurrenceFrequency: String,
					RecurrenceBy: String,
					RecurrenceByValue: String,
					RecurrenceUntil: 0001-01-01,
					CreatedBy: String,
					CreatedByName: String,
					DateCreated: 0001-01-01,
					ModifiedBy: String,
					DateModified: 0001-01-01,
					Deleted: False,
					TimeZone: String,
					Offset: 0,
					TextReminderSentDate: 0001-01-01,
					Confirmed: False,
					ConfirmationTextId: String,
					FirstTextReminderId: String,
					SecondTextReminderId: String,
					LocationUID: 00000000000000000000000000000000,
					AgentReminderSentDate: 0001-01-01,
					ContactId: 0,
					IsPrivate: False,
					ProjectID: 0,
					JobID: 0,
					ProjectStartDate: 0001-01-01,
					ProjectEndDate: 0001-01-01,
					MaxCrewEndDate: 0001-01-01,
					MaxEquipmentEndDate: 0001-01-01,
					CheckInId: 00000000000000000000000000000000,
					AllDay: False,
					JobName: String,
					JobStatusName: String,
					JobStatusId: 0,
					ProjectName: String,
					ResourceId: 0,
					ResourceName: String,
					Original_EventStart: 0001-01-01,
					Original_Recurrence: False,
					Original_RecurrenceFrequency: String,
					Original_RecurrenceBy: String,
					Original_RecurrenceByValue: String,
					Original_RecurrenceUntil: 0001-01-01,
					Checksum: String
				}
			]
		}
	]
}