SageBridge API - GetSchedulingOptions function

GetSchedulingOptions

Used to Retrieve a list of doctor, location, visit types combinations allowed for scheduling

Call example:


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

Request parameters:

Request parameter is a JSON string representing set of fields:

extProviderId	(string)	External Provider ID.
extLocationId	(string)	External Location ID.
extVisitTypeId	(string)	External VisitType ID.
lang	(string)	Language to translate visit type names and description.
filterVisitType	(string)	Extra options to filter out returned visit types (primarily used by the Sophrona patient portal).

Notes:

Any or all parameters can be NULL or empty.
If lang parameter is not provided, then devault value "en" (English) will be used.
If filterVisitType parameter is not provided, then not filters will be applied on visit types.
filterVisitType = 0 - include only visit types defined by Sophrona.
filterVisitType = 1 - include only visit types defined by Sophrona with "filter1" internal flag.
filterVisitType = 2 - include only visit types defined by Sophrona for portal Appointment Requests.
filterVisitType = 3 - include only visit types defined by Sophrona for portal QuickAppointments.
filterVisitType = 4 - include only visit types defined by Sophrona for QuickAppointments Widget.
(important) For some specific licesne types the filterVisitType value may be ignored and special filter applied. Please contact Sophrona for more details.

JSON string request example (all available options):

{
"extProviderId":null,
"extLocationId":null,
"extVisitTypeId":null
}

JSON string request example (options for specific provider only):

{
"extProviderId":"BEB44BF5-81FC-45CF-AC5D-43C8EFA83017",
"extLocationId":null,
"extVisitTypeId":null
}

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 SchedulingOption elements.

Payload JSON Response Example:

[
{"providerFirstName":"Samir",
"providerMiddleInitial":"",
"providerLastName":"Melki",
"externalProviderId":"BEB44BF5-81FC-45CF-AC5D-43C8EFA83017",
"providerAbbreviation":null,
"locationName":"Brookline",
"externalLocationId":"13C69063-DD37-45E0-B1D5-2FFF6D9F300F",
"locationAbbreviation":null,
"visitTypeDescription":"Cataract Evaluation",
"externalVisitTypeId":"10B85F7C-A88F-4E86-8559-DB1B39C80793",
"visitTypeComment":"Cataract Evaluation",
"visitTypeAbbreviation":null,
"newPatients":null},

{"providerFirstName":"Samir",
"providerMiddleInitial":"",
"providerLastName":"Melki",
"externalProviderId":"BEB44BF5-81FC-45CF-AC5D-43C8EFA83017",
"providerAbbreviation":null,
"locationName":"Brookline",
"externalLocationId":"13C69063-DD37-45E0-B1D5-2FFF6D9F300F",
"locationAbbreviation":null,
"visitTypeDescription":"Lasik Consultation",
"externalVisitTypeId":"CED07165-961D-4C4E-910D-8EFEBE16F440",
"visitTypeComment":"Established Pt. Follow Up",
"visitTypeAbbreviation":null,
"newPatients":null},

{... etc ...}
]

Payload XML Response Example: