SageBridge API - getVisitTypes function

getVisitTypes

Retrieve a list of visit types for given practice.

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"getVisitTypes",                    
"bos5",                                 // practice Path or Tax ID
"JSON",                                 // output format  (XML or JSON)
null                                    // request parameters are not required for this function
);

Request parameters:

No request parameter required for this function

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

Example of XML output:

Example of JSON Output:

[
{
"visitTypeId":"CED07165-961D-4C4E-910D-8EFEBE16F440",
"name":"Lasik Consultation",
"description":"Lasik Consultation",
"duration":"30",
"abbreviation":"LSK",
"active":"1",
"categoryId":"14",
"categoryName":"VISIT",
"categoryAbbreviation":"VST",
"visitTypePk":"30"
},
{
"visitTypeId":"10B85F7C-A88F-4E86-8559-DB1B39C80793",
"name":"Cataract Evaluation",
"description":"Cataract Evaluation",
"duration":"30",
"abbreviation":null,
"active":"1",
"categoryId":"14",
"categoryName":"VISIT",
"categoryAbbreviation":"VST",
"visitTypePk":"30"
},
{--VISIT TYPE 3 INFO--},
{--VISIT TYPE 4 INFO--},
...etc...
]

Examples of full API responses:

XML Example.
Note: All XML code inside of <payload> element is escaped. See raw string response
JSON Example

Call example (C#):

For the source code of working example see testgetVisitTypes() method in SageBridgeApiCallExecutor class of SageBrige.API.Tester project can be downloaded here.

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.

Notes:

All examples of source code and compiled version of SageBridge API can be found here.

Known Issues:

None