SageBridge API - CheckChangedAppointments function

CheckChangedAppointments

Used to retrieve a list of modified appointments for certain criterias

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"CheckChangedAppointments",                    
"bos5",                                 // practice Path or Tax ID
"JSON",                                 // output format (XML or JSON)
"--request parameters XML or JSON---"   // request parameters
);

Request parameters:

Request parameter JSON string representing set of fields:

patientIds	(string)	(optional)	Comma-separated list of patient IDs to check appointments for.
apptLastModifiedStart	(string)	(required)	Appointment modified time from
apptLastModifiedEnd	(string)	(required)	Appointment modified time to

Notes:

Both apptLastModifiedStart and apptLastModifiedEnd parameters are required.
If patientIds is not provided, then a time range between apptLastModifiedStart and apptLastModifiedEnd cannot exceed 25 hours.

JSON string request example:

{
"patientIds":"123499,280348,2342142,234234",
"apptLastModifiedStart":"07/25/1916 20:36",
"apptLastModifiedEnd":"07/25/2016 20:36"
}

Response:

XML or JSON string representing APIResponse structure.

APIResponse payload element may be encrypted and delivered as Base64 string.
Payload element of APIResponse is a list of modified appointment IDs

Output parameters:

AppointmentId	(string)	Appointment ID.
patientId	(string)	Patient ID.
BirthDate	(string)	Patient BirthDate.
ModifyTimestamp	(string)	Appointment modification timestamp.

JSON Response Example: (Raw JSON )

    [
    { "AppointmentId": "1099884", "PatientId": "123499", "Birthdate": "09/24/1949", "ModifyTimestamp": "4/12/2016 10:08:41 AM" },
    { "AppointmentId": "1112396", "PatientId": "123499", "Birthdate": "09/24/1949", "ModifyTimestamp": "7/11/2016 3:27:30 PM" },
    { "AppointmentId": "1152241", "PatientId": "123499", "Birthdate": "09/24/1949", "ModifyTimestamp": "7/11/2016 4:19:08 PM" },
    { "AppointmentId": "41781", "PatientId": "3907", "Birthdate": "07/24/1944", "ModifyTimestamp": "4/7/2008 3:10:03 PM" },
    { "AppointmentId": "40325", "PatientId": "3907", "Birthdate": "07/24/1944", "ModifyTimestamp": "5/13/2008 8:27:15 AM" },
    { "AppointmentId": "52332", "PatientId": "3907", "Birthdate": "07/24/1944", "ModifyTimestamp": "5/13/2008 10:29:33 AM" },
    { "AppointmentId": "52307", "PatientId": "3907", "Birthdate": "07/24/1944", "ModifyTimestamp": "11/3/2008 7:46:27 AM" },
    { "AppointmentId": "96163", "PatientId": "3907", "Birthdate": "07/24/1944", "ModifyTimestamp": "1/5/2009 2:46:56 PM" },
    { "AppointmentId": "110653", "PatientId": "3907", "Birthdate": "07/24/1944", "ModifyTimestamp": "1/5/2009 3:58:51 PM" },
    { "AppointmentId": "980164", "PatientId": "3907", "Birthdate": "07/24/1944", "ModifyTimestamp": "6/23/2016 8:44:13 AM" },
    { "AppointmentId": "16368", "PatientId": "4444", "Birthdate": "07/08/1932", "ModifyTimestamp": "1/16/2008 10:34:19 AM" },
    { "AppointmentId": "197557", "PatientId": "55534", "Birthdate": "07/15/1994", "ModifyTimestamp": "10/29/2009 4:19:09 PM" },
    { "AppointmentId": "403856", "PatientId": "55534", "Birthdate": "07/15/1994", "ModifyTimestamp": "4/6/2011 4:33:05 PM" },
    { "AppointmentId": "896155", "PatientId": "80416", "Birthdate": "04/06/1955", "ModifyTimestamp": "12/11/2014 9:38:26 AM" },
    { "AppointmentId": "908846", "PatientId": "80416", "Birthdate": "04/06/1955", "ModifyTimestamp": "1/21/2015 12:30:37 PM" },
    { "AppointmentId": "1140928", "PatientId": "80416", "Birthdate": "04/06/1955", "ModifyTimestamp": "6/23/2016 9:41:03 AM" } 
]

Possible return values (see APIResponse )

0 - Success. Description can be vary per function
-1 - General error. Description attribute will show more details about an error
-2 - Function is not supported
500 - Invalid credentials provided
501 - License is expired
502 - License is not active
503 - Token is not active or expired
550 - Unknow functionName or not subscribed
551 - Unknown practice
552 - No Subscription found
553 - Subscription is inactive or expired
600 - Invalid or empty request parameters
601 - No valid route found for this subscription
602 - Unable to parse request parameters

Known Issues:

None