GetPortalProviders

Retrieve a list of current providers.

Call example:


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

Request parameters:

providerId(string)Get information for specific provider (optional).
Notes:
  • This function can be called without request parameters (important) .
  • If providerId parameter is not provided or empty then this function will return a list of all active portal providers.
JSON string request example:
To get information about specific provider 
{
  "providerId": "12345"
}
To get all portal providers 
{
  "providerId": ""
}

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 Portal Provider elements.
Notes:
  • This function can be called without request parameters (important) .
  • If providerId parameter is not provided or empty then this function will return a list of all active portal providers.
Example of XML payload:
Example of JSON payload:
{
  "providers": [
    {
      "providerId": "33",
      "last": "Peter",
      "first": "Smith",
      "middle": "J",
      "credentials": "MD",
      "specialty": "Ophthalmology",
      "abbreviation": "DOC1",
      "sex": "M",
      "phone": "8005551212",
      "email": "provider@clinic.com",
      "takingPatients": "true",
      "seekingPatient": "false",
      "videoVisitOffered": "true",
      "evisitOffered": "true"
    },
    {
      "providerId": "4",
      "phone": "888551212",
      "email": "",
      "takingPatients": "",
      "seekingPatient": "",
      "videoVisitOffered": "true",
      "evisitOffered": "false",
      "last": "Alan",
      "first": "Scott",
      "middle": "M",
      "credentials": "MD",
      "specialty": "Ophthalmology",
      "abbreviation": "HART",
      "sex": "M"
    }
  ]
}
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

See Also:

API Functions, APIResponse data, Portal Provider data