POST 17.0/database/appointments/list

Description

Retrieve a list of Appointments

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of AppointmentsUpdate
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:48",
    "endDate": "2025-01-09T20:48",
    "addedDate": "2025-01-09T20:48",
    "userID": 1,
    "assignedUserID": 1,
    "siteID": 1,
    "notes": "sample string 1",
    "appointmentTypeID": 1,
    "confirmed": 64,
    "confirmedDate": "2025-01-09T20:48",
    "followedUp": 64,
    "followedUpDate": "2025-01-09T20:48",
    "followedUpOwner": 64,
    "followedUpOwnerDate": "2025-01-09T20:48",
    "followUpDueDate": "2025-01-09T20:48",
    "reminderInterval": 64,
    "cancelled": 64,
    "cancelledDate": "2025-01-09T20:48",
    "noShow": 64,
    "reminderDate": "2025-01-09T20:48",
    "recurrenceAppointmentID": 1,
    "recurrenceFrequency": 64,
    "recurrenceEndDate": "2025-01-09T20:48",
    "updatedDate": "2025-01-09T20:48",
    "feedbackSentDate": "2025-01-09T20:48",
    "summaryUserAttendees": "sample string 2",
    "summaryAttendees": "sample string 3",
    "summaryProperties": "sample string 4"
  },
  {
    "id": 1,
    "startDate": "2025-01-09T20:48",
    "endDate": "2025-01-09T20:48",
    "addedDate": "2025-01-09T20:48",
    "userID": 1,
    "assignedUserID": 1,
    "siteID": 1,
    "notes": "sample string 1",
    "appointmentTypeID": 1,
    "confirmed": 64,
    "confirmedDate": "2025-01-09T20:48",
    "followedUp": 64,
    "followedUpDate": "2025-01-09T20:48",
    "followedUpOwner": 64,
    "followedUpOwnerDate": "2025-01-09T20:48",
    "followUpDueDate": "2025-01-09T20:48",
    "reminderInterval": 64,
    "cancelled": 64,
    "cancelledDate": "2025-01-09T20:48",
    "noShow": 64,
    "reminderDate": "2025-01-09T20:48",
    "recurrenceAppointmentID": 1,
    "recurrenceFrequency": 64,
    "recurrenceEndDate": "2025-01-09T20:48",
    "updatedDate": "2025-01-09T20:48",
    "feedbackSentDate": "2025-01-09T20:48",
    "summaryUserAttendees": "sample string 2",
    "summaryAttendees": "sample string 3",
    "summaryProperties": "sample string 4"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfAppointmentsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AppointmentsUpdate>
    <ID>1</ID>
    <StartDate>2025-01-09T20:48:53.5395712+00:00</StartDate>
    <EndDate>2025-01-09T20:48:53.5395712+00:00</EndDate>
    <AddedDate>2025-01-09T20:48:53.5395712+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:48:53.5395712+00:00</ConfirmedDate>
    <FollowedUp>64</FollowedUp>
    <FollowedUpDate>2025-01-09T20:48:53.5395712+00:00</FollowedUpDate>
    <FollowedUpOwner>64</FollowedUpOwner>
    <FollowedUpOwnerDate>2025-01-09T20:48:53.5395712+00:00</FollowedUpOwnerDate>
    <FollowUpDueDate>2025-01-09T20:48:53.5395712+00:00</FollowUpDueDate>
    <ReminderInterval>64</ReminderInterval>
    <Cancelled>64</Cancelled>
    <CancelledDate>2025-01-09T20:48:53.5395712+00:00</CancelledDate>
    <NoShow>64</NoShow>
    <ReminderDate>2025-01-09T20:48:53.5395712+00:00</ReminderDate>
    <RecurrenceAppointmentID>1</RecurrenceAppointmentID>
    <RecurrenceFrequency>64</RecurrenceFrequency>
    <RecurrenceEndDate>2025-01-09T20:48:53.5395712+00:00</RecurrenceEndDate>
    <UpdatedDate>2025-01-09T20:48:53.5395712+00:00</UpdatedDate>
    <FeedbackSentDate>2025-01-09T20:48:53.5395712+00:00</FeedbackSentDate>
    <SummaryUserAttendees>sample string 2</SummaryUserAttendees>
    <SummaryAttendees>sample string 3</SummaryAttendees>
    <SummaryProperties>sample string 4</SummaryProperties>
  </AppointmentsUpdate>
  <AppointmentsUpdate>
    <ID>1</ID>
    <StartDate>2025-01-09T20:48:53.5395712+00:00</StartDate>
    <EndDate>2025-01-09T20:48:53.5395712+00:00</EndDate>
    <AddedDate>2025-01-09T20:48:53.5395712+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:48:53.5395712+00:00</ConfirmedDate>
    <FollowedUp>64</FollowedUp>
    <FollowedUpDate>2025-01-09T20:48:53.5395712+00:00</FollowedUpDate>
    <FollowedUpOwner>64</FollowedUpOwner>
    <FollowedUpOwnerDate>2025-01-09T20:48:53.5395712+00:00</FollowedUpOwnerDate>
    <FollowUpDueDate>2025-01-09T20:48:53.5395712+00:00</FollowUpDueDate>
    <ReminderInterval>64</ReminderInterval>
    <Cancelled>64</Cancelled>
    <CancelledDate>2025-01-09T20:48:53.5395712+00:00</CancelledDate>
    <NoShow>64</NoShow>
    <ReminderDate>2025-01-09T20:48:53.5395712+00:00</ReminderDate>
    <RecurrenceAppointmentID>1</RecurrenceAppointmentID>
    <RecurrenceFrequency>64</RecurrenceFrequency>
    <RecurrenceEndDate>2025-01-09T20:48:53.5395712+00:00</RecurrenceEndDate>
    <UpdatedDate>2025-01-09T20:48:53.5395712+00:00</UpdatedDate>
    <FeedbackSentDate>2025-01-09T20:48:53.5395712+00:00</FeedbackSentDate>
    <SummaryUserAttendees>sample string 2</SummaryUserAttendees>
    <SummaryAttendees>sample string 3</SummaryAttendees>
    <SummaryProperties>sample string 4</SummaryProperties>
  </AppointmentsUpdate>
</ArrayOfAppointmentsUpdate>