PUT 17.0/database/appointments/{id}

Description
Update existing Appointments

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

AppointmentsUpdate

Name	Type	Additional information
ID	integer	None.
StartDate	date	None.
EndDate	date	None.
AddedDate	date	None.
UserID	integer	None.
AssignedUserID	integer	None.
SiteID	integer	None.
Notes	string	None.
AppointmentTypeID	integer	None.
Confirmed	byte	None.
ConfirmedDate	date	None.
FollowedUp	byte	None.
FollowedUpDate	date	None.
FollowedUpOwner	byte	None.
FollowedUpOwnerDate	date	None.
FollowUpDueDate	date	None.
ReminderInterval	byte	None.
Cancelled	byte	None.
CancelledDate	date	None.
NoShow	byte	None.
ReminderDate	date	None.
RecurrenceAppointmentID	integer	None.
RecurrenceFrequency	byte	None.
RecurrenceEndDate	date	None.
UpdatedDate	date	None.
FeedbackSentDate	date	None.
SummaryUserAttendees	string	String length: inclusive between 0 and 2048
SummaryAttendees	string	String length: inclusive between 0 and 2048
SummaryProperties	string	String length: inclusive between 0 and 2048

application/json, text/json

Sample:

{
  "id": 1,
  "startDate": "2025-01-09T20:19",
  "endDate": "2025-01-09T20:19",
  "addedDate": "2025-01-09T20:19",
  "userID": 1,
  "assignedUserID": 1,
  "siteID": 1,
  "notes": "sample string 1",
  "appointmentTypeID": 1,
  "confirmed": 64,
  "confirmedDate": "2025-01-09T20:19",
  "followedUp": 64,
  "followedUpDate": "2025-01-09T20:19",
  "followedUpOwner": 64,
  "followedUpOwnerDate": "2025-01-09T20:19",
  "followUpDueDate": "2025-01-09T20:19",
  "reminderInterval": 64,
  "cancelled": 64,
  "cancelledDate": "2025-01-09T20:19",
  "noShow": 64,
  "reminderDate": "2025-01-09T20:19",
  "recurrenceAppointmentID": 1,
  "recurrenceFrequency": 64,
  "recurrenceEndDate": "2025-01-09T20:19",
  "updatedDate": "2025-01-09T20:19",
  "feedbackSentDate": "2025-01-09T20:19",
  "summaryUserAttendees": "sample string 2",
  "summaryAttendees": "sample string 3",
  "summaryProperties": "sample string 4"
}

application/xml, text/xml

Sample:

<AppointmentsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <StartDate>2025-01-09T20:19:52.2359583+00:00</StartDate>
  <EndDate>2025-01-09T20:19:52.2359583+00:00</EndDate>
  <AddedDate>2025-01-09T20:19:52.2359583+00:00</AddedDate>
  <UserID>1</UserID>
  <AssignedUserID>1</AssignedUserID>
  <SiteID>1</SiteID>
  <Notes>sample string 1</Notes>
  <AppointmentTypeID>1</AppointmentTypeID>
  <Confirmed>64</Confirmed>
  <ConfirmedDate>2025-01-09T20:19:52.2359583+00:00</ConfirmedDate>
  <FollowedUp>64</FollowedUp>
  <FollowedUpDate>2025-01-09T20:19:52.2359583+00:00</FollowedUpDate>
  <FollowedUpOwner>64</FollowedUpOwner>
  <FollowedUpOwnerDate>2025-01-09T20:19:52.2359583+00:00</FollowedUpOwnerDate>
  <FollowUpDueDate>2025-01-09T20:19:52.2359583+00:00</FollowUpDueDate>
  <ReminderInterval>64</ReminderInterval>
  <Cancelled>64</Cancelled>
  <CancelledDate>2025-01-09T20:19:52.2359583+00:00</CancelledDate>
  <NoShow>64</NoShow>
  <ReminderDate>2025-01-09T20:19:52.2359583+00:00</ReminderDate>
  <RecurrenceAppointmentID>1</RecurrenceAppointmentID>
  <RecurrenceFrequency>64</RecurrenceFrequency>
  <RecurrenceEndDate>2025-01-09T20:19:52.2359583+00:00</RecurrenceEndDate>
  <UpdatedDate>2025-01-09T20:19:52.2359583+00:00</UpdatedDate>
  <FeedbackSentDate>2025-01-09T20:19:52.2359583+00:00</FeedbackSentDate>
  <SummaryUserAttendees>sample string 2</SummaryUserAttendees>
  <SummaryAttendees>sample string 3</SummaryAttendees>
  <SummaryProperties>sample string 4</SummaryProperties>
</AppointmentsUpdate>

application/x-www-form-urlencoded
Sample: Sample not available.

Appointments

Name	Type	Additional information
ID	integer	None.
StartDate	date	None.
EndDate	date	None.
AddedDate	date	None.
UserID	integer	None.
AssignedUserID	integer	None.
SiteID	integer	None.
Notes	string	None.
AppointmentTypeID	integer	None.
Confirmed	byte	None.
ConfirmedDate	date	None.
FollowedUp	byte	None.
FollowedUpDate	date	None.
FollowedUpOwner	byte	None.
FollowedUpOwnerDate	date	None.
FollowUpDueDate	date	None.
ReminderInterval	byte	None.
Cancelled	byte	None.
CancelledDate	date	None.
NoShow	byte	None.
ReminderDate	date	None.
RecurrenceAppointmentID	integer	None.
RecurrenceFrequency	byte	None.
RecurrenceEndDate	date	None.
UpdatedDate	date	None.
FeedbackSentDate	date	None.
SummaryUserAttendees	string	String length: inclusive between 0 and 2048
SummaryAttendees	string	String length: inclusive between 0 and 2048
SummaryProperties	string	String length: inclusive between 0 and 2048

application/json, text/json

Sample:

{
  "id": 1,
  "startDate": "2025-01-09T20:19",
  "endDate": "2025-01-09T20:19",
  "addedDate": "2025-01-09T20:19",
  "userID": 5,
  "assignedUserID": 6,
  "siteID": 7,
  "notes": "sample string 8",
  "appointmentTypeID": 9,
  "confirmed": 64,
  "confirmedDate": "2025-01-09T20:19",
  "followedUp": 64,
  "followedUpDate": "2025-01-09T20:19",
  "followedUpOwner": 64,
  "followedUpOwnerDate": "2025-01-09T20:19",
  "followUpDueDate": "2025-01-09T20:19",
  "reminderInterval": 64,
  "cancelled": 64,
  "cancelledDate": "2025-01-09T20:19",
  "noShow": 64,
  "reminderDate": "2025-01-09T20:19",
  "recurrenceAppointmentID": 22,
  "recurrenceFrequency": 64,
  "recurrenceEndDate": "2025-01-09T20:19",
  "updatedDate": "2025-01-09T20:19",
  "feedbackSentDate": "2025-01-09T20:19",
  "summaryUserAttendees": "sample string 27",
  "summaryAttendees": "sample string 28",
  "summaryProperties": "sample string 29"
}

application/xml, text/xml

Sample:

<Appointments xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <StartDate>2025-01-09T20:19:52.2515835+00:00</StartDate>
  <EndDate>2025-01-09T20:19:52.2515835+00:00</EndDate>
  <AddedDate>2025-01-09T20:19:52.2515835+00:00</AddedDate>
  <UserID>5</UserID>
  <AssignedUserID>6</AssignedUserID>
  <SiteID>7</SiteID>
  <Notes>sample string 8</Notes>
  <AppointmentTypeID>9</AppointmentTypeID>
  <Confirmed>64</Confirmed>
  <ConfirmedDate>2025-01-09T20:19:52.2515835+00:00</ConfirmedDate>
  <FollowedUp>64</FollowedUp>
  <FollowedUpDate>2025-01-09T20:19:52.2515835+00:00</FollowedUpDate>
  <FollowedUpOwner>64</FollowedUpOwner>
  <FollowedUpOwnerDate>2025-01-09T20:19:52.2515835+00:00</FollowedUpOwnerDate>
  <FollowUpDueDate>2025-01-09T20:19:52.2515835+00:00</FollowUpDueDate>
  <ReminderInterval>64</ReminderInterval>
  <Cancelled>64</Cancelled>
  <CancelledDate>2025-01-09T20:19:52.2515835+00:00</CancelledDate>
  <NoShow>64</NoShow>
  <ReminderDate>2025-01-09T20:19:52.2515835+00:00</ReminderDate>
  <RecurrenceAppointmentID>22</RecurrenceAppointmentID>
  <RecurrenceFrequency>64</RecurrenceFrequency>
  <RecurrenceEndDate>2025-01-09T20:19:52.2515835+00:00</RecurrenceEndDate>
  <UpdatedDate>2025-01-09T20:19:52.2515835+00:00</UpdatedDate>
  <FeedbackSentDate>2025-01-09T20:19:52.2515835+00:00</FeedbackSentDate>
  <SummaryUserAttendees>sample string 27</SummaryUserAttendees>
  <SummaryAttendees>sample string 28</SummaryAttendees>
  <SummaryProperties>sample string 29</SummaryProperties>
</Appointments>

PUT 17.0/database/appointments/{id}

Description

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml