executeAPICall()

Single web-method that can be used to execute all production functions through SageBridge API.
Call example:
//
string result=SageBridgeAPI.executeAPICall(
    string securityToken, 
    string functionName, 
    string practiceid, 
    string outputFormat, 
    string parameters);
//
Example of call for getProviders function:
//
string result = SageBridgeAPI.executeAPICall(
    "cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
    "GetProviders",                         // function name
    "36-3744018",                           // practice path (or Tax ID)
    "XML",                                  // output format
    null                                    // no request parameters
);
//

Request:

Input parameters:
securityToken(string)(required)Security token obtained previously from getSecurityToken() web-method
functionName(string)(required)Function to execute. See complete list of supported functions
practiceId(string)(required)Practice unique ID. Can be practice Path or Tax ID
parameters(string)(required)Function specific set of request parameters. See specific function for details
outputFormat(string)(optional)Defines a serialization method for APIResponse. Possible values: "XML", "JSON"
Notes:
  • parameters value can be in form of XML or JSON string. SageBridge API will automatically detect a format used
  • If encryption is enabled then request parameters value must be encrypted and function will encrypt payload output data as well. Contact us about encryption details.

Response:

XML or JSON string representing APIResponse structure.

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

APIResponse payload element will have function specific set of data requested.
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

Notes:

None

See Also:

APIResponse structure, API Functions, API Methods, API Data