SageBridge API - GetPracticeQAStopQuestions function

GetPracticeQAStopQuestions

Retrieve a list of practice specific questions for Book Appointments.

Call example:


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

Request:

Request parameter JSON or XML string representing set of fields:

lang	(string)	Specified an output language.
visitTypeId	(string)	Specifies a visit type to get questions for.

Notes:

Both lang and visitTypeId parameters are optional.
If lang parameter is not specified then default value of "en" (English) will be used.
Each practice may specify different sets of questions for different visit types. If so, use visitTypeId parameter to get a questions for a specific visit type. Otherwise leave it blank.

JSON string request example (English language requested):

{
  "visitTypeId": "",
  "lang": "en"
}

XML string request example (Spanish language requested):

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 stop questions

lang	(string)	Requested language.
textYes	(string)	Language-specific "Yes" answer text.
textNo	(string)	Language-specific "No" answer text.
questions	(array)	List of questions.
questions.questionText	(string)	Language-specific question text.
questions.stopText	(string)	Language-specific text to show for "Yes" answer.
questions.required	(string)	(0/1) - Answer is required indicator.

Notes:

If translation for specific text is not found, then English version will be used instead.
Please contact Sophrona support team to add missed translations.

JSON Response Example:

{
  "lang": "en",
  "textYes": "Yes",
  "textNo": "No",
  "questions": [
    {"question": "Have you had any Eye Syrgery in the last six months?","stopText": "Please call the clinic to schedule.", "required": "1"},
    {"question": "Are you experiencing sever eye pain currently?","stopText": "Please call 911", "required": "0"}
  ]
}

XML Response Example:

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

This function may return other codes not listed above; they may vary by practice.

Known Issues:

None