API ToothInitials
See Missing/Primary Teeth for more information.
Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See ToothInitial Database Schema.
ToothInitials GET
Version Added: 24.2.3
Gets all toothinitials.
PatNum: Optional.
Example Requests:
GET /toothinitials
GET /toothinitials?PatNum=13
Example Response:
[
{
"ToothInitialNum": 322,
"PatNum": 13,
"ToothNum": "32",
"InitialType": "Missing",
"Movement": "0",
"DrawingSegment": "",
"ColorDraw": "0,0,0",
"SecDateTEntry": "2024-05-30 12:18:00",
"SecDateTEdit": "2024-05-30 12:18:00",
"DrawText": ""
},
{
"ToothInitialNum": 324,
"PatNum": 13,
"ToothNum": "17",
"InitialType": "Hidden",
"Movement": "0",
"DrawingSegment": "",
"ColorDraw": "0,0,0",
"SecDateTEntry": "2024-05-30 12:18:08",
"SecDateTEdit": "2024-05-30 12:18:08",
"DrawText": ""
},
{
"ToothInitialNum": 344,
"PatNum": 13,
"ToothNum": "22",
"InitialType": "Rotate",
"Movement": "-20",
"DrawingSegment": "",
"ColorDraw": "0,0,0",
"SecDateTEntry": "2024-05-30 12:42:57",
"SecDateTEdit": "2024-05-30 12:42:57",
"DrawText": ""
},
etc...
]
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)
ToothInitials POST (create)
Version Added: 24.2.3
Creates a toothinitial for a patient.
PatNum: Required.
ToothNum: Required. A single tooth number, either 1-32 or A-T.
InitialType: (Updated in version 26.1.29) Required. Either "Missing", "Hidden", "Primary", "ShiftM", "ShiftO", "ShiftB", "Rotate", "TipM", or "TipB".
Movement: (Added in version 26.1.29) Required when InitialType is "ShiftM", "ShiftO", "ShiftB", "Rotate", "TipM", or "TipB". Shift in mm, or rotation / tipping in degrees.
Example Request:
POST /toothinitials
{
"PatNum": 13,
"ToothNum": 32,
"InitialType": "Missing"
}
Example Response:
{
"ToothInitialNum": 346,
"PatNum": 13,
"ToothNum": "32",
"InitialType": "Missing",
"Movement": "0",
"DrawingSegment": "",
"ColorDraw": "0,0,0",
"SecDateTEntry": "2024-05-30 14:11:19",
"SecDateTEdit": "2024-05-30 14:11:19",
"DrawText": ""
}
201 Created
400 BadRequest (with explanation)
404 NotFound (with explanation)
ToothInitials PUT ClearMovements
Version Added: 26.1.29
For a patient, clears toothInitials with ToothInitialTypes of ShiftM, ShiftO, ShiftB, Rotate, TipM, or TipB for either specific teeth or for all teeth. Similar to clicking the 'Selected Teeth' or "All Teeth' buttons in the Movements tab of the Chart Module.
PatNum: Required.
toothNums: This or clearAll is required. An array of ToothNums in ["1","2","3", "A"] format. 1-32 and A-T are allowed. Clears movements for toothNums.
clearAll: This or toothNums is required. Set to "True" to clear all movements for the patNum..
Example Requests:
PUT /toothinitials/ClearMovements
{
"PatNum": 72,
"toothNums": ["1","2","3","A"]
}
or
{
"PatNum": 72,
"clearAll": "True"
}
Example Responses:
200 OK
400 BadRequest (with explanation)
ToothInitials DELETE
Version Added: 24.2.3
Deletes an existing toothinitial with an InitialType of "Missing", "Hidden", "Primary", "ShiftM", "ShiftO", "ShiftB", "Rotate", "TipM", or "TipB" .
ToothInitialNum: Required in the URL.
Example Request:
DELETE /toothinitials/346
Example Responses:
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)