GET 17.0/database/appointmenttypes/{id}

Description

Retrieve Appointment Types

URI Parameters
Name Description Type Additional information
id

integer

Required

None.

None.

AppointmentTypes
Name Description 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 2",
  "typeID": 64,
  "foreColor": 4,
  "backColor": 5,
  "followupTaskInterval": 6,
  "followupTaskPriority": 64,
  "taskTypeID": 8,
  "followupInterval": 9,
  "duration": 10,
  "allDay": 64,
  "confirmation": 64,
  "followup": 64,
  "requiresContact": 64,
  "requiresProperty": 64,
  "reminderInterval": 64,
  "inActive": 64,
  "letterTemplateID": 18,
  "suppressChecking": 64,
  "showAsReminder": 64,
  "smsReminder": 64,
  "emailReminder": 64,
  "feedback": 64,
  "emailConfirmationTemplateID": 24,
  "emailNotificationTemplateID": 25,
  "emailReminderTemplateID": 26,
  "smsConfirmationTemplateID": 27,
  "smsNotificationTemplateID": 28,
  "smsReminderTemplateID": 29,
  "linkToInventorySystem": 64
}

application/xml, text/xml
Sample: 
<AppointmentTypes xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <Description>sample string 2</Description>
  <TypeID>64</TypeID>
  <ForeColor>4</ForeColor>
  <BackColor>5</BackColor>
  <FollowupTaskInterval>6</FollowupTaskInterval>
  <FollowupTaskPriority>64</FollowupTaskPriority>
  <TaskTypeID>8</TaskTypeID>
  <FollowupInterval>9</FollowupInterval>
  <Duration>10</Duration>
  <AllDay>64</AllDay>
  <Confirmation>64</Confirmation>
  <Followup>64</Followup>
  <RequiresContact>64</RequiresContact>
  <RequiresProperty>64</RequiresProperty>
  <ReminderInterval>64</ReminderInterval>
  <InActive>64</InActive>
  <LetterTemplateID>18</LetterTemplateID>
  <SuppressChecking>64</SuppressChecking>
  <ShowAsReminder>64</ShowAsReminder>
  <SMSReminder>64</SMSReminder>
  <EmailReminder>64</EmailReminder>
  <Feedback>64</Feedback>
  <EmailConfirmationTemplateID>24</EmailConfirmationTemplateID>
  <EmailNotificationTemplateID>25</EmailNotificationTemplateID>
  <EmailReminderTemplateID>26</EmailReminderTemplateID>
  <SMSConfirmationTemplateID>27</SMSConfirmationTemplateID>
  <SMSNotificationTemplateID>28</SMSNotificationTemplateID>
  <SMSReminderTemplateID>29</SMSReminderTemplateID>
  <LinkToInventorySystem>64</LinkToInventorySystem>
</AppointmentTypes>