API ApptFields
An ApptField is a highly customizable field that shows on appointments. For example, the office might have an ApptField called "Ins Verified", and you might use the API to set it to "Yes" for a specific appointment. There is some prep work that you must do with the office ahead of time. From within the Open Dental UI at the office, you must first add the field under Setup, Appointments, Appointment Field Defs. There would be additional work to make it also show in the Appt Views and/or Appt Bubble.
Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See ApptField Database Schema.
ApptFields GET (single)
Version Added: 26.1
Gets a single ApptField .
ApptFieldNum: Required in URL.
Example Request
GET /apptfields/11
Example Response:
{
"ApptFieldNum": 11,
"AptNum":101,
"FieldName": "Ins Verified",
"FieldValue":"Yes"
}
200 OK
404 NotFound (with explanation)
ApptFields GET (multiple)
Version Added: 21.1
Gets a list of ApptFields.
AptNum: Optional after version 26.1
FieldName: Optional after version 26.1
Example Request
GET /apptfields?AptNum=101
GET /apptfields?FieldName=Ins%20Verified
GET /apptfields?AptNum=101&FieldName=Ins%20Verified
Example Response:
{
"ApptFieldNum": 11,
"AptNum":101,
"FieldName": "Ins Verified",
"FieldValue":"Yes"
}
ApptFields POST (create)
Version Added: 26.1
Creates a new custom field added to an appointment.
AptNum: Required. FK to appointment.AptNum.
FieldName: Required. FK to apptfielddef.FieldName.
FieldValue: Required. FieldValue must be one of the items in the PickList when inserting an apptfield of ApptFieldType.PickList.
Example Request:
POST /apptfields
{
"FieldName": "Ins Verified",
"AptNum":101,
"FieldValue":"Yes"
}
or
{
"apptFieldDefNum": 1,
"AptNum":101,
"FieldValue":"Yes"
}
Example Response:
{
"ApptFieldNum": 11,
"AptNum":101,
"FieldName": "Ins Verified",
"FieldValue":"Yes"
}
201 Created
400 Bad Request (with explanation)
ApptFields PUT
Version Added: 21.1
Updates an existing ApptField.
ApptFieldNum: Required in URL.
AptNum: Optional after 26.1. FK to appointment.AptNum.
FieldName: Optional after 26.1. FK to apptfielddef.FieldName.
FieldValue: Required.
Example Request:
PUT /apptfields
{
"FieldName": "Ins Verified",
"AptNum":101,
"FieldValue":"Yes"
}
Example Response:
{
"ApptFieldNum": 11,
"AptNum":101,
"FieldName": "Ins Verified",
"FieldValue":"Yes"
}
200 OK
400 Bad Request (with explanation)
ApptFields DELETE
Version Added: 26.1
Deletes an ApptField..
ApptFieldNum: Required in the URL.
Example Requests:
DELETE /apptfields/11
Example Responses:
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)