POST api/Calendar
Create a new calendar activity for a specific customer Required: SiteOwnerId, Subject, ActivityType, ActivityDateTime, RecurrenceType Agenda - Notes for everyone, Description - Internal notes for your team only, RecurrenceType: 0 - none, 1 - Daily, 2 - Weekly, 3 - Monthly RecurrenceRepeats: repeat x times , RecurrenceInterval: every x recurrence type. Eg: Every 2 Days repeats 3 times Returns: ActivityId
Request Information
URI Parameters
None.
Body Parameters
the Calendar Activity Model containing properties for populating a new Activity
CalendarActivityModelName | Description | Type | Additional information |
---|---|---|---|
SiteOwnerId | integer |
Required |
|
CustomerId | integer |
None. |
|
Subject | string |
Required Max length: 150 |
|
Agenda | string |
None. |
|
Description | string |
None. |
|
ContactEmail | string |
Max length: 150 |
|
UserEmail | string |
Max length: 150 |
|
RecurrenceType | integer |
Required |
|
RecurrenceInterval | integer |
None. |
|
RecurrenceRepeats | integer |
None. |
|
UniqueId | string |
None. |
|
ActivityDateTime | date |
Required |
|
ActivityModifiedDateTime | date |
None. |
|
Duration | integer |
None. |
|
ActivityTypeId | integer |
Required |
|
AllInstances | boolean |
None. |
Request Formats
application/json, text/json
{ "SiteOwnerId": 1, "CustomerId": 2, "Subject": "sample string 3", "Agenda": "sample string 4", "Description": "sample string 5", "ContactEmail": "sample string 6", "UserEmail": "sample string 7", "RecurrenceType": 8, "RecurrenceInterval": 9, "RecurrenceRepeats": 10, "UniqueId": "sample string 11", "ActivityDateTime": "2023-10-04T23:10:49.4727396+13:00", "ActivityModifiedDateTime": "2023-10-04T23:10:49.4727396+13:00", "Duration": 13, "ActivityTypeId": 14, "AllInstances": true }
application/xml, text/xml
<CalendarActivityModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExsalerateWebAPI.Models"> <ActivityDateTime>2023-10-04T23:10:49.4727396+13:00</ActivityDateTime> <ActivityModifiedDateTime>2023-10-04T23:10:49.4727396+13:00</ActivityModifiedDateTime> <ActivityTypeId>14</ActivityTypeId> <Agenda>sample string 4</Agenda> <AllInstances>true</AllInstances> <ContactEmail>sample string 6</ContactEmail> <CustomerId>2</CustomerId> <Description>sample string 5</Description> <Duration>13</Duration> <RecurrenceInterval>9</RecurrenceInterval> <RecurrenceRepeats>10</RecurrenceRepeats> <RecurrenceType>8</RecurrenceType> <SiteOwnerId>1</SiteOwnerId> <Subject>sample string 3</Subject> <UniqueId>sample string 11</UniqueId> <UserEmail>sample string 7</UserEmail> </CalendarActivityModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |