SageBridge API - GetPortalVisitTypes function

GetPortalVisitTypes

Retrieve a list of portal visit types.

Call example:


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

Request parameters:

None, can be passed as empty string.

Response:

XML or JSON string representing APIResponse structure.

APIResponse payload element may be encrypted and delivered as Base64 string.

Notes:

Payload element of APIResponse is a list of PortalVisitType elements.
appointmenType items may have more fields than shown below. Please see PortalVisitType for a full list of fields.

Example of JSON payload:

{
  "visitTypes": [
    {
      "visitTypeId": 405,
      "visitTypeName": "Eye Exam",
      "appointmentTypes": [
        {
          "apptTypeId": "77",
          "description": "Established Pt Eye Exam",
          "duration": 15,
          "problemOk": false,
          "newPatients": false,
          "refractionNeeded": false,
          "abbreviation": "EVALLAS",
          "variationId": 1986
        },
        {
          "apptTypeId": "77",
          "description": "Established Pt Eye Exam",
          "duration": 15,
          "problemOk": true,
          "newPatients": false,
          "refractionNeeded": false,
          "abbreviation": "EVALLAS",
          "variationId": 1987
        },
        {
          "apptTypeId": "77",
          "description": "Established Pt Eye Exam",
          "duration": 15,
          "problemOk": false,
          "newPatients": false,
          "refractionNeeded": true,
          "abbreviation": "EVALLAS",
          "variationId": 1988
        },
        {
          "apptTypeId": "77",
          "description": "Established Pt Eye Exam",
          "duration": 15,
          "problemOk": true,
          "newPatients": false,
          "refractionNeeded": true,
          "abbreviation": "EVALLAS",
          "variationId": 1989
        },
        {
          "apptTypeId": "77",
          "description": "New Pt Eye Exam",
          "duration": 15,
          "problemOk": false,
          "newPatients": true,
          "refractionNeeded": false,
          "abbreviation": "EVALLAS",
          "variationId": 1990
        },
        {
          "apptTypeId": "77",
          "description": "New Pt Eye Exam",
          "duration": 15,
          "problemOk": true,
          "newPatients": true,
          "refractionNeeded": false,
          "abbreviation": "EVALLAS",
          "variationId": 1991
        },
        {
          "apptTypeId": "77",
          "description": "New Pt Eye Exam",
          "duration": 15,
          "problemOk": false,
          "newPatients": true,
          "refractionNeeded": true,
          "abbreviation": "EVALLAS",
          "variationId": 1992
        },
        {
          "apptTypeId": "77",
          "description": "New Pt Eye Exam",
          "duration": 15,
          "problemOk": true,
          "newPatients": true,
          "refractionNeeded": true,
          "abbreviation": "EVALLAS",
          "variationId": 1993
        }
      ]
    },
    {
      "visitTypeId": 6430,
      "visitTypeName": "Video Visit",
      "appointmentTypes": [
        {
          "apptTypeId": "44",
          "description": "Video Visit",
          "duration": 30,
          "problemOk": false,
          "newPatients": false,
          "refractionNeeded": false,
          "abbreviation": "",
          "variationId": 5280
        }
      ]
    }
  ]
}

Example of XML payload:

Possible return codes

0 - Success. Description may vary by 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