| Requires any of the roles: | Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator, Worker, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/CalendarEvent/{CalendarEventId} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/CalendarEvent |
export class CalendarEvent
{
public CalendarEventId: number;
public CalendarId: string;
public EventStart: string;
public EventEnd: string;
public Location: string;
public Summary: string;
public Description: string;
public EventTypeId: number;
public Recurrence: boolean;
public RecurrenceFrequency: string;
public RecurrenceBy: string;
public RecurrenceByValue: string;
public RecurrenceUntil: string;
public CreatedBy: string;
public CreatedByName: string;
public DateCreated: string;
public ModifiedBy: string;
public DateModified: string;
public Deleted: boolean;
public TimeZone: string;
public Offset: number;
public TextReminderSentDate: string;
public Confirmed: boolean;
public ConfirmationTextId: string;
public FirstTextReminderId: string;
public SecondTextReminderId: string;
public LocationUID?: string;
public AgentReminderSentDate: string;
public ContactId: number;
public IsPrivate: boolean;
public ProjectID: number;
public JobID: number;
public ProjectStartDate: string;
public ProjectEndDate: string;
public MaxCrewEndDate: string;
public MaxEquipmentEndDate: string;
public CheckInId: string;
public AllDay: boolean;
public JobName: string;
public JobStatusName: string;
public JobStatusId: number;
public ProjectName: string;
public ResourceId: number;
public ResourceName: string;
public Original_EventStart: string;
public Original_Recurrence: boolean;
public Original_RecurrenceFrequency: string;
public Original_RecurrenceBy: string;
public Original_RecurrenceByValue: string;
public Original_RecurrenceUntil: string;
public Checksum: string;
public constructor(init?: Partial<CalendarEvent>) { (Object as any).assign(this, init); }
}
export class CalendarEventResponse
{
public ResponseStatus: ResponseStatus;
public CalendarEvent: CalendarEvent[] = [];
public constructor(init?: Partial<CalendarEventResponse>) { (Object as any).assign(this, init); }
}
export class CalendarEventRequest
{
public CalendarEvent: CalendarEvent[] = [];
public constructor(init?: Partial<CalendarEventRequest>) { (Object as any).assign(this, init); }
}
TypeScript CalendarEventRequest DTOs
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/CalendarEvent/{CalendarEventId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CalendarEvent:
[
{
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
}
]
}
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
}
},
CalendarEvent:
[
{
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
}
]
}