POST 17.0/database/appointmenttypes/list

Description
Retrieve a list of Appointment Types

URI Parameters
None.

ListOptions

Name	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 AppointmentTypesUpdate

Name	Type	Additional information
ID	integer	None.
Description	string	String length: inclusive between 0 and 30
TypeID	byte	None.
ForeColor	integer	None.
BackColor	integer	None.
FollowupTaskInterval	integer	None.
FollowupTaskPriority	byte	None.
TaskTypeID	integer	None.
FollowupInterval	integer	None.
Duration	integer	None.
AllDay	byte	None.
Confirmation	byte	None.
Followup	byte	None.
RequiresContact	byte	None.
RequiresProperty	byte	None.
ReminderInterval	byte	None.
InActive	byte	None.
LetterTemplateID	integer	None.
SuppressChecking	byte	None.
ShowAsReminder	byte	None.
SMSReminder	byte	None.
EmailReminder	byte	None.
Feedback	byte	None.
EmailConfirmationTemplateID	integer	None.
EmailNotificationTemplateID	integer	None.
EmailReminderTemplateID	integer	None.
SMSConfirmationTemplateID	integer	None.
SMSNotificationTemplateID	integer	None.
SMSReminderTemplateID	integer	None.
LinkToInventorySystem	byte	None.

application/json, text/json

Sample:

[
  {
    "id": 1,
    "description": "sample string 1",
    "typeID": 64,
    "foreColor": 1,
    "backColor": 1,
    "followupTaskInterval": 1,
    "followupTaskPriority": 64,
    "taskTypeID": 1,
    "followupInterval": 1,
    "duration": 1,
    "allDay": 64,
    "confirmation": 64,
    "followup": 64,
    "requiresContact": 64,
    "requiresProperty": 64,
    "reminderInterval": 64,
    "inActive": 64,
    "letterTemplateID": 1,
    "suppressChecking": 64,
    "showAsReminder": 64,
    "smsReminder": 64,
    "emailReminder": 64,
    "feedback": 64,
    "emailConfirmationTemplateID": 1,
    "emailNotificationTemplateID": 1,
    "emailReminderTemplateID": 1,
    "smsConfirmationTemplateID": 1,
    "smsNotificationTemplateID": 1,
    "smsReminderTemplateID": 1,
    "linkToInventorySystem": 64
  },
  {
    "id": 1,
    "description": "sample string 1",
    "typeID": 64,
    "foreColor": 1,
    "backColor": 1,
    "followupTaskInterval": 1,
    "followupTaskPriority": 64,
    "taskTypeID": 1,
    "followupInterval": 1,
    "duration": 1,
    "allDay": 64,
    "confirmation": 64,
    "followup": 64,
    "requiresContact": 64,
    "requiresProperty": 64,
    "reminderInterval": 64,
    "inActive": 64,
    "letterTemplateID": 1,
    "suppressChecking": 64,
    "showAsReminder": 64,
    "smsReminder": 64,
    "emailReminder": 64,
    "feedback": 64,
    "emailConfirmationTemplateID": 1,
    "emailNotificationTemplateID": 1,
    "emailReminderTemplateID": 1,
    "smsConfirmationTemplateID": 1,
    "smsNotificationTemplateID": 1,
    "smsReminderTemplateID": 1,
    "linkToInventorySystem": 64
  }
]

application/xml, text/xml

Sample:

<ArrayOfAppointmentTypesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AppointmentTypesUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <TypeID>64</TypeID>
    <ForeColor>1</ForeColor>
    <BackColor>1</BackColor>
    <FollowupTaskInterval>1</FollowupTaskInterval>
    <FollowupTaskPriority>64</FollowupTaskPriority>
    <TaskTypeID>1</TaskTypeID>
    <FollowupInterval>1</FollowupInterval>
    <Duration>1</Duration>
    <AllDay>64</AllDay>
    <Confirmation>64</Confirmation>
    <Followup>64</Followup>
    <RequiresContact>64</RequiresContact>
    <RequiresProperty>64</RequiresProperty>
    <ReminderInterval>64</ReminderInterval>
    <InActive>64</InActive>
    <LetterTemplateID>1</LetterTemplateID>
    <SuppressChecking>64</SuppressChecking>
    <ShowAsReminder>64</ShowAsReminder>
    <SMSReminder>64</SMSReminder>
    <EmailReminder>64</EmailReminder>
    <Feedback>64</Feedback>
    <EmailConfirmationTemplateID>1</EmailConfirmationTemplateID>
    <EmailNotificationTemplateID>1</EmailNotificationTemplateID>
    <EmailReminderTemplateID>1</EmailReminderTemplateID>
    <SMSConfirmationTemplateID>1</SMSConfirmationTemplateID>
    <SMSNotificationTemplateID>1</SMSNotificationTemplateID>
    <SMSReminderTemplateID>1</SMSReminderTemplateID>
    <LinkToInventorySystem>64</LinkToInventorySystem>
  </AppointmentTypesUpdate>
  <AppointmentTypesUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <TypeID>64</TypeID>
    <ForeColor>1</ForeColor>
    <BackColor>1</BackColor>
    <FollowupTaskInterval>1</FollowupTaskInterval>
    <FollowupTaskPriority>64</FollowupTaskPriority>
    <TaskTypeID>1</TaskTypeID>
    <FollowupInterval>1</FollowupInterval>
    <Duration>1</Duration>
    <AllDay>64</AllDay>
    <Confirmation>64</Confirmation>
    <Followup>64</Followup>
    <RequiresContact>64</RequiresContact>
    <RequiresProperty>64</RequiresProperty>
    <ReminderInterval>64</ReminderInterval>
    <InActive>64</InActive>
    <LetterTemplateID>1</LetterTemplateID>
    <SuppressChecking>64</SuppressChecking>
    <ShowAsReminder>64</ShowAsReminder>
    <SMSReminder>64</SMSReminder>
    <EmailReminder>64</EmailReminder>
    <Feedback>64</Feedback>
    <EmailConfirmationTemplateID>1</EmailConfirmationTemplateID>
    <EmailNotificationTemplateID>1</EmailNotificationTemplateID>
    <EmailReminderTemplateID>1</EmailReminderTemplateID>
    <SMSConfirmationTemplateID>1</SMSConfirmationTemplateID>
    <SMSNotificationTemplateID>1</SMSNotificationTemplateID>
    <SMSReminderTemplateID>1</SMSReminderTemplateID>
    <LinkToInventorySystem>64</LinkToInventorySystem>
  </AppointmentTypesUpdate>
</ArrayOfAppointmentTypesUpdate>

POST 17.0/database/appointmenttypes/list

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