GET 17.0/database/appointments/defaultmodel

Description

Get a Appointments model with default values

URI Parameters

None.

None.

None.

Name Description 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:20",
  "endDate": "2025-01-09T20:20",
  "addedDate": "2025-01-09T20:20",
  "userID": 5,
  "assignedUserID": 6,
  "siteID": 7,
  "notes": "sample string 8",
  "appointmentTypeID": 9,
  "confirmed": 64,
  "confirmedDate": "2025-01-09T20:20",
  "followedUp": 64,
  "followedUpDate": "2025-01-09T20:20",
  "followedUpOwner": 64,
  "followedUpOwnerDate": "2025-01-09T20:20",
  "followUpDueDate": "2025-01-09T20:20",
  "reminderInterval": 64,
  "cancelled": 64,
  "cancelledDate": "2025-01-09T20:20",
  "noShow": 64,
  "reminderDate": "2025-01-09T20:20",
  "recurrenceAppointmentID": 22,
  "recurrenceFrequency": 64,
  "recurrenceEndDate": "2025-01-09T20:20",
  "updatedDate": "2025-01-09T20:20",
  "feedbackSentDate": "2025-01-09T20:20",
  "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:20:12.704728+00:00</StartDate>
  <EndDate>2025-01-09T20:20:12.704728+00:00</EndDate>
  <AddedDate>2025-01-09T20:20:12.704728+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:20:12.704728+00:00</ConfirmedDate>
  <FollowedUp>64</FollowedUp>
  <FollowedUpDate>2025-01-09T20:20:12.704728+00:00</FollowedUpDate>
  <FollowedUpOwner>64</FollowedUpOwner>
  <FollowedUpOwnerDate>2025-01-09T20:20:12.704728+00:00</FollowedUpOwnerDate>
  <FollowUpDueDate>2025-01-09T20:20:12.704728+00:00</FollowUpDueDate>
  <ReminderInterval>64</ReminderInterval>
  <Cancelled>64</Cancelled>
  <CancelledDate>2025-01-09T20:20:12.704728+00:00</CancelledDate>
  <NoShow>64</NoShow>
  <ReminderDate>2025-01-09T20:20:12.704728+00:00</ReminderDate>
  <RecurrenceAppointmentID>22</RecurrenceAppointmentID>
  <RecurrenceFrequency>64</RecurrenceFrequency>
  <RecurrenceEndDate>2025-01-09T20:20:12.704728+00:00</RecurrenceEndDate>
  <UpdatedDate>2025-01-09T20:20:12.704728+00:00</UpdatedDate>
  <FeedbackSentDate>2025-01-09T20:20:12.704728+00:00</FeedbackSentDate>
  <SummaryUserAttendees>sample string 27</SummaryUserAttendees>
  <SummaryAttendees>sample string 28</SummaryAttendees>
  <SummaryProperties>sample string 29</SummaryProperties>
</Appointments>