See API Specification

Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See AppointmentType Database Schema.

AppointmentTypes GET (single)

Version Added: 25.4.35

Gets a single appointmenttype.

AppointmentTypeNum: Required in URL.

Example Request:
GET /appointmenttypes/1

Example Response:
{
"AppointmentTypeNum": 1,
"AppointmentTypeName": "WebSched New Patient Default",
"appointmentTypeColor": "93,54,220",
"IsHidden": "false",
"Pattern": "//XX//",
"CodeStr": "",
"CodeStrRequired": "",
"RequiredProcCodesNeeded": 0,
"BlockoutTypes": ""
}

200 OK
404 NotFound (with explanation)

AppointmentTypes GET (multiple)

Version Added: 22.4.10

Example Request:
GET /appointmenttypes

Example Response:
[
{
"AppointmentTypeNum": 1,
"AppointmentTypeName": "WebSched New Patient Default",
"appointmentTypeColor": "93,54,220",
"IsHidden": "false",
"Pattern": "//XX//",
"CodeStr": "",
"CodeStrRequired": "",
"RequiredProcCodesNeeded": 0,
"BlockoutTypes": ""
},
{
"AppointmentTypeNum": 2,
"AppointmentTypeName": "WebSched",
"appointmentTypeColor": "74,250,61",
"IsHidden": "false",
"Pattern": "//XX//",
"CodeStr": "D0272,D0274",
"CodeStrRequired": "D0272,D0274",
"RequiredProcCodesNeeded": "AtLeastOne",
"BlockoutTypes": "TeleExam"
},
etc...
]

200 OK