| RETURN PARAMETER DESCRIPTION |
Example of Successful Return:
"ApptCancelLetterIEN": "",
"CHAR4": "",
"CancelLetter": "",
"CancelLetterIEN": "",
"CheckinCheckoutTime": "",
"ClinicIEN": 5230,
"ClinicName": "TEST CLINIC 1",
"ClinicStatus": "INACTIVE",
"CreditStopCodeAMISNum": "",
"CreditStopCodeName": "",
"CreditStopCodeNum": "",
"DefaultApptType": "",
"DefaultToPCPractitioner": "",
"Diagnosis": [
""
],
"DisplayClinicAppt": "YES",
"DivisionIEN": 1,
"DivisionName": "CHEYENNE VAMROC",
"ECheckinAllowed": "NO",
{
"HolidaySchedule": "",
"HourClinicDisplayBegins": 8,
"InactivateDate": "2026-08-09",
"IncrementsPerHr": "20-MIN ",
"LengthOfAppt": 20,
"MaxDaysForFutureBooking": 30,
"MeetsAtThisFacility": "",
"NoShowLetter": "",
"NoShowLetterIEN": "",
"NonCountClinic": "NO",
"Clinic": {
"OverbooksPerDayMax": 4,
"PatientFriendlyName": "",
"PbspID": 45678990,
"PhysicalLocation": "",
"PreApptLetter": "",
"PreApptLetterIEN": "",
"PreCheckinAllowed": "NO",
"Principal": "",
"PrivilegedUser": [
""
"Abbreviation": "",
],
"ProhibitAccessToClinic": "",
"Provider": [
""
],
"ReactivateDate": "",
"ReqActionProfiles": "YES",
"ReqXrayFilms": "",
"Resource IEN": 3598,
"Service": "MEDICINE",
"AdminInpatientMeds": "",
"SpecialInstructions": "",
"StationNumber": 442,
"StopCodeAMISNum": 303,
"StopCodeName": "CARDIOLOGY",
"StopCodeNum": 147,
"Subspecialty": [
""
],
"Telephone": "",
"TelephoneExtension": "",
"AllowPatScheduling": "NO",
"Timezone": "EASTERN",
"TimezoneException": 0,
"VariableApptLength": "",
"VeteranSelfCancel": "YES",
"WorkloadValidationCheckout": ""
}
}
Example of a Returned Error:
"AllowableConsecutiveNoShows": 5,
{
"Clinic": "",
"Error": [
"Invalid Clinic ID."
]
}
"ApptCancelLetter": "",
|