| GET,POST,PUT,DELETE,OPTIONS | /v1/Job/Schedule/{JobID} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| JobID | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| JobSchedule | form | List<CalendarEvent> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CalendarEventId | form | int | No | |
| CalendarId | form | Guid | No | |
| EventStart | form | DateTime | No | |
| EventEnd | form | DateTime | No | |
| Location | form | string | No | |
| Summary | form | string | No | |
| Description | form | string | No | |
| EventTypeId | form | int | No | |
| Recurrence | form | bool | No | |
| RecurrenceFrequency | form | string | No | |
| RecurrenceBy | form | string | No | |
| RecurrenceByValue | form | string | No | |
| RecurrenceUntil | form | DateTime | No | |
| CreatedBy | form | string | No | |
| CreatedByName | form | string | No | |
| DateCreated | form | DateTime | No | |
| ModifiedBy | form | string | No | |
| DateModified | form | DateTime | No | |
| Deleted | form | bool | No | |
| TimeZone | form | string | No | |
| Offset | form | int | No | |
| TextReminderSentDate | form | DateTime | No | |
| Confirmed | form | bool | No | |
| ConfirmationTextId | form | string | No | |
| FirstTextReminderId | form | string | No | |
| SecondTextReminderId | form | string | No | |
| LocationUID | form | Guid? | No | |
| AgentReminderSentDate | form | DateTime | No | |
| ContactId | form | int | No | |
| IsPrivate | form | bool | No | |
| ProjectID | form | int | No | |
| JobID | form | int | No | |
| ProjectStartDate | form | DateTime | No | |
| ProjectEndDate | form | DateTime | No | |
| MaxCrewEndDate | form | DateTime | No | |
| MaxEquipmentEndDate | form | DateTime | No | |
| CheckInId | form | Guid | No | |
| AllDay | form | bool | No | |
| JobName | form | string | No | |
| JobStatusName | form | string | No | |
| JobStatusId | form | int | No | |
| ProjectName | form | string | No | |
| ResourceId | form | int | No | |
| ResourceName | form | string | No | |
| Original_EventStart | form | DateTime | No | |
| Original_Recurrence | form | bool | No | |
| Original_RecurrenceFrequency | form | string | No | |
| Original_RecurrenceBy | form | string | No | |
| Original_RecurrenceByValue | form | string | No | |
| Original_RecurrenceUntil | form | DateTime | No | |
| Checksum | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Job/Schedule/{JobID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
JobID: 0
}
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
}
},
JobSchedule:
[
{
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
}
]
}