POST api/appointments/scheduler
Request Information
URI Parameters
None.
Body Parameters
AppointmentSchedulerModel| Name | Description | Type | Additional information |
|---|---|---|---|
| owner_id | string |
None. |
|
| organiser | string |
None. |
|
| appointment_type_id | globally unique identifier |
None. |
|
| appointment_type | string |
None. |
|
| appointment_type_color | string |
None. |
|
| attendees | Collection of SelectListItem |
None. |
|
| attendees_string | string |
None. |
|
| reminder_minutes_before_start | integer |
None. |
|
| location | string |
None. |
|
| priority | string |
None. |
|
| notes | string |
None. |
|
| send_invite | boolean |
None. |
|
| completed | boolean |
None. |
|
| origin_link | string |
None. |
|
| created_remotely | boolean |
None. |
|
| readonly | boolean |
None. |
|
| update_schedule_only | boolean |
None. |
|
| title | string |
None. |
|
| description | string |
None. |
|
| start_date | date |
None. |
|
| end_date | date |
None. |
|
| start_timezone | string |
None. |
|
| end_timezone | string |
None. |
|
| is_all_day | boolean |
None. |
|
| recurrence_exception | string |
None. |
|
| recurrence_rule | string |
None. |
|
| id | globally unique identifier |
None. |
|
| subscription_id | globally unique identifier |
None. |
|
| ts | Collection of byte |
None. |
Request Formats
application/json, text/json
Sample:
{
"owner_id": "sample string 1",
"organiser": "sample string 2",
"appointment_type_id": "3704a834-c909-4e90-a63b-4b17829427bb",
"appointment_type": "sample string 3",
"appointment_type_color": "sample string 4",
"attendees": [
{
"value": "sample string 1",
"text": "sample string 2"
},
{
"value": "sample string 1",
"text": "sample string 2"
}
],
"attendees_string": "sample string 5",
"reminder_minutes_before_start": 1,
"location": "sample string 6",
"priority": "sample string 7",
"notes": "sample string 8",
"send_invite": true,
"completed": true,
"origin_link": "sample string 11",
"created_remotely": true,
"readonly": true,
"update_schedule_only": true,
"title": "sample string 15",
"description": "sample string 16",
"start_date": "2025-12-08T19:48:42.909917+08:00",
"end_date": "2025-12-08T19:48:42.909917+08:00",
"start_timezone": "sample string 19",
"end_timezone": "sample string 20",
"is_all_day": true,
"recurrence_exception": "sample string 22",
"recurrence_rule": "sample string 23",
"id": "8b5517c6-8fff-4e27-9aed-8aebbae05733",
"subscription_id": "bb45de80-d7c2-4e14-bbc9-ca13dc023bf0",
"ts": "QEA="
}
application/xml, text/xml
Sample:
<AppointmentSchedulerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models">
<Id xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">8b5517c6-8fff-4e27-9aed-8aebbae05733</Id>
<SubscriptionId xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">bb45de80-d7c2-4e14-bbc9-ca13dc023bf0</SubscriptionId>
<Ts xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">QEA=</Ts>
<AppointmentType>sample string 3</AppointmentType>
<AppointmentTypeColor>sample string 4</AppointmentTypeColor>
<AppointmentTypeId>3704a834-c909-4e90-a63b-4b17829427bb</AppointmentTypeId>
<Attendees xmlns:d2p1="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">
<d2p1:SelectListItem>
<d2p1:Text>sample string 2</d2p1:Text>
<d2p1:Value>sample string 1</d2p1:Value>
</d2p1:SelectListItem>
<d2p1:SelectListItem>
<d2p1:Text>sample string 2</d2p1:Text>
<d2p1:Value>sample string 1</d2p1:Value>
</d2p1:SelectListItem>
</Attendees>
<AttendeesAsString>sample string 5</AttendeesAsString>
<Completed>true</Completed>
<CreatedRemotely>true</CreatedRemotely>
<Description>sample string 16</Description>
<EndDate>2025-12-08T19:48:42.909917+08:00</EndDate>
<EndTimezone>sample string 20</EndTimezone>
<IsAllDay>true</IsAllDay>
<Location>sample string 6</Location>
<Notes>sample string 8</Notes>
<Organiser>sample string 2</Organiser>
<OriginLink>sample string 11</OriginLink>
<OwnerId>sample string 1</OwnerId>
<Priority>sample string 7</Priority>
<ReadOnly>true</ReadOnly>
<RecurrenceException>sample string 22</RecurrenceException>
<RecurrenceRule>sample string 23</RecurrenceRule>
<ReminderMinutesBeforeStart>1</ReminderMinutesBeforeStart>
<SendInvite>true</SendInvite>
<StartDate>2025-12-08T19:48:42.909917+08:00</StartDate>
<StartTimezone>sample string 19</StartTimezone>
<Title>sample string 15</Title>
<UpdateScheduleOnly>true</UpdateScheduleOnly>
</AppointmentSchedulerModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.