| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CalendarEvent | body | 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| CalendarEvent | form | List<CalendarEvent> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<CalendarEventRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<CalendarEvent>
<CalendarEvent>
<AgentReminderSentDate>0001-01-01T00:00:00</AgentReminderSentDate>
<AllDay>false</AllDay>
<CalendarEventId>0</CalendarEventId>
<CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
<CheckInId>00000000-0000-0000-0000-000000000000</CheckInId>
<Checksum>String</Checksum>
<ConfirmationTextId>String</ConfirmationTextId>
<Confirmed>false</Confirmed>
<ContactId>0</ContactId>
<CreatedBy>String</CreatedBy>
<CreatedByName>String</CreatedByName>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateModified>0001-01-01T00:00:00</DateModified>
<Deleted>false</Deleted>
<Description>String</Description>
<EventEnd>0001-01-01T00:00:00</EventEnd>
<EventStart>0001-01-01T00:00:00</EventStart>
<EventTypeId>0</EventTypeId>
<FirstTextReminderId>String</FirstTextReminderId>
<IsPrivate>false</IsPrivate>
<JobID>0</JobID>
<JobName>String</JobName>
<JobStatusId>0</JobStatusId>
<JobStatusName>String</JobStatusName>
<Location>String</Location>
<LocationUID>00000000-0000-0000-0000-000000000000</LocationUID>
<MaxCrewEndDate>0001-01-01T00:00:00</MaxCrewEndDate>
<MaxEquipmentEndDate>0001-01-01T00:00:00</MaxEquipmentEndDate>
<ModifiedBy>String</ModifiedBy>
<Offset>0</Offset>
<Original_EventStart>0001-01-01T00:00:00</Original_EventStart>
<Original_Recurrence>false</Original_Recurrence>
<Original_RecurrenceBy>String</Original_RecurrenceBy>
<Original_RecurrenceByValue>String</Original_RecurrenceByValue>
<Original_RecurrenceFrequency>String</Original_RecurrenceFrequency>
<Original_RecurrenceUntil>0001-01-01T00:00:00</Original_RecurrenceUntil>
<ProjectEndDate>0001-01-01T00:00:00</ProjectEndDate>
<ProjectID>0</ProjectID>
<ProjectName>String</ProjectName>
<ProjectStartDate>0001-01-01T00:00:00</ProjectStartDate>
<Recurrence>false</Recurrence>
<RecurrenceBy>String</RecurrenceBy>
<RecurrenceByValue>String</RecurrenceByValue>
<RecurrenceFrequency>String</RecurrenceFrequency>
<RecurrenceUntil>0001-01-01T00:00:00</RecurrenceUntil>
<ResourceId>0</ResourceId>
<ResourceName>String</ResourceName>
<SecondTextReminderId>String</SecondTextReminderId>
<Summary>String</Summary>
<TextReminderSentDate>0001-01-01T00:00:00</TextReminderSentDate>
<TimeZone>String</TimeZone>
</CalendarEvent>
</CalendarEvent>
</CalendarEventRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CalendarEventResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<CalendarEvent>
<CalendarEvent>
<AgentReminderSentDate>0001-01-01T00:00:00</AgentReminderSentDate>
<AllDay>false</AllDay>
<CalendarEventId>0</CalendarEventId>
<CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
<CheckInId>00000000-0000-0000-0000-000000000000</CheckInId>
<Checksum>String</Checksum>
<ConfirmationTextId>String</ConfirmationTextId>
<Confirmed>false</Confirmed>
<ContactId>0</ContactId>
<CreatedBy>String</CreatedBy>
<CreatedByName>String</CreatedByName>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateModified>0001-01-01T00:00:00</DateModified>
<Deleted>false</Deleted>
<Description>String</Description>
<EventEnd>0001-01-01T00:00:00</EventEnd>
<EventStart>0001-01-01T00:00:00</EventStart>
<EventTypeId>0</EventTypeId>
<FirstTextReminderId>String</FirstTextReminderId>
<IsPrivate>false</IsPrivate>
<JobID>0</JobID>
<JobName>String</JobName>
<JobStatusId>0</JobStatusId>
<JobStatusName>String</JobStatusName>
<Location>String</Location>
<LocationUID>00000000-0000-0000-0000-000000000000</LocationUID>
<MaxCrewEndDate>0001-01-01T00:00:00</MaxCrewEndDate>
<MaxEquipmentEndDate>0001-01-01T00:00:00</MaxEquipmentEndDate>
<ModifiedBy>String</ModifiedBy>
<Offset>0</Offset>
<Original_EventStart>0001-01-01T00:00:00</Original_EventStart>
<Original_Recurrence>false</Original_Recurrence>
<Original_RecurrenceBy>String</Original_RecurrenceBy>
<Original_RecurrenceByValue>String</Original_RecurrenceByValue>
<Original_RecurrenceFrequency>String</Original_RecurrenceFrequency>
<Original_RecurrenceUntil>0001-01-01T00:00:00</Original_RecurrenceUntil>
<ProjectEndDate>0001-01-01T00:00:00</ProjectEndDate>
<ProjectID>0</ProjectID>
<ProjectName>String</ProjectName>
<ProjectStartDate>0001-01-01T00:00:00</ProjectStartDate>
<Recurrence>false</Recurrence>
<RecurrenceBy>String</RecurrenceBy>
<RecurrenceByValue>String</RecurrenceByValue>
<RecurrenceFrequency>String</RecurrenceFrequency>
<RecurrenceUntil>0001-01-01T00:00:00</RecurrenceUntil>
<ResourceId>0</ResourceId>
<ResourceName>String</ResourceName>
<SecondTextReminderId>String</SecondTextReminderId>
<Summary>String</Summary>
<TextReminderSentDate>0001-01-01T00:00:00</TextReminderSentDate>
<TimeZone>String</TimeZone>
</CalendarEvent>
</CalendarEvent>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</CalendarEventResponse>