SageBridge API - GetProviders function

GetProviders

Retrieve a list of providers for given practice. Please provide practiceId parameter for executeAPICall method.

Call example:


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

Request parameters:

activeOnly

(string)

"1" - include only active providers, "0" - include all providers. (default:0)

Notes:

No request parameter is required for this function.
If request parameter is not provided, then activeOnly value will be set to default value of "0" and function will return both active and not active providers.
To get only active providers, please provider a request with activeOnly flag set to "1".
Output data has an "active" flag to indicate provider active status.

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

Examples of full API responses:

XML Example.
Note: All XML code inside of <payload> element is escaped. See raw string response
JSON 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.

Notes:

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

Known Issues:

None