API SheetDefs

See API Specification

SheetDefs GET (single)

Version Added: 25.X.XX

Gets a single SheetDef.

SheetDefNum: Required in URL.

Example Request:
GET /sheetdefs/1

Example Response:
{
"SheetDefNum": 1,
"Description": "Excuse Letter",
"SheetType": "PatientLetter"
}

200 OK
404 NotFound

SheetDefs GET (multiple)

Version Added: 23.2.5.0

Gets a list of SheetDefs.

SheetType: Optional. (Added in version 25.X.XX). Filter by SheetTypeEnum. See Database Schema for options.

Example Requests:
GET /sheetdefs
GET /sheetdefs?SheetType=PatientForm

Example Response:
[
{
"SheetDefNum": 1,
"Description": "Excuse Letter",
"SheetType": "PatientLetter"
},
{
"SheetDefNum": 2,
"Description": "Screening",
"SheetType": "Screening"
},
{
"SheetDefNum": 3,
"Description": "Registration Form",
"SheetType": "PatientForm"
},
etc...
]

200 OK
400 BadRequest (with explanation)