SageBridge API - getAvailableFunctions function

getAvailableFunctions

Retrieve a list of functions available under your license for a given practice.

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"getAvailableFunctions",                    
"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 functions available under your license for a given practice with subscription expiration time.

Example of XML output:

Call example (C#):

For the source code of working example see testgetAvailableFunctions() 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