SageBridge API - getReferralSources function

getReferralSources

Retrieve a list of referral sources for given practice.

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"getReferralSources",                    
"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 an array of Dictionary Items

Example of XML payload:

Example of JSON payload:

[
{"id":"8cb1a75e-761d-44bf-90ff-3acd54e4a082","description":"My Dad told me","abbreviation":"DEMO_DAD","active":"1"},
{"id":"9d1e4afd-4645-4ada-b664-aa6e72234dc9","description":"Found on streets","abbreviation":"DEMO_STREET","active":"1"},
{"id":"8331852F-7533-4156-AA03-60FF39D2D9F1","description":"Noticed in a movie","abbreviation":"DEMO_MOVIE","active":"1"},
{"id":"D3A0ED08-A99F-4E51-8130-3E633A677A8B","description":"Appeared in my dreams","abbreviation":"DEMO_DREAMS","active":"1"}
]

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