API PatRestrictions
See Edit Patient Information for additional information.
Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See PatRestriction Database Schema.
PatRestrictions GET (single)
Version Added: 25.4.28
Gets a single patrestriction.
PatRestrictionNum: Required in the URL.
Example Request:
GET /patrestrictions/23
Example Response:
{
"PatRestrictionNum": 23,
"PatNum": 102,
"PatRestrictType": "ApptSchedule"
}
200 OK
404 NotFound (with explanation)
PatRestrictions GET (multiple)
Version Added: 25.4.28
Gets a list of patrestrictions.
PatNum: Optional. Get all patrestrictions for a single patient.
Example Requests:
GET /patrestrictions
GET /patrestrictions?PatNum=106
Example Response:
[
{
"PatRestrictionNum": 25,
"PatNum": 106,
"PatRestrictType": "ApptSchedule"
},
{
"PatRestrictionNum": 26,
"PatNum": 107,
"PatRestrictType": "ApptSchedule"
},
etc...
]
200 OK
404 NotFound (with explanation)
PatRestrictions POST
Version Added: 25.4.28
Creates an ApptSchedule patrestriction for a patient.
PatNum: Required.
PatRestrictType: Required. Must be "ApptSchedule".
Example Request:
POST /patrestrictions
{
"PatNum": 113,
"PatRestrictType": "ApptSchedule"
}
Example Response:
{
"PatRestrictionNum": 31,
"PatNum": 113,
"PatRestrictType": "ApptSchedule"
}
201 Created
400 BadRequest (with explanation)
404 NotFound (with explanation)
PatRestrictions DELETE
Version Added: 25.4.28
Deletes a patrestriction.
PatRestrictionNum: Required in the URL.
Example Request:
DELETE /patrestrictions/31
Example Responses:
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)