SageBridge API - GetLocations function

GetLocations

Retrieve a list of locations for given practice.

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"GetLocations",                    
"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

Notes:

This function also can be called as GetLocationsR10, if enabled in a license.

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

Example of XML output:

Example of JSON Output:

{
  "locations": [
    {
      "facilityId": "13C69063-DD37-45E0-B1D5-2FFF6D9F300F",
      "name": "Brookline",
      "active": "true",
      "address": {
        "addr1": "1101 Beacon Str 6W",
        "add2": "",
        "city": "Brookline",
        "state": "MA",
        "zip": "02446"
      },
      "contact": {
        "phone": "(617) 566-0062",
        "fax": ""
      }
    },
    {
      "facilityId": "B493CC23-BB53-4AF6-8D77-F1ED6D0BB6D2",
      "name": "Lawrence",
      "active": "true",
      "address": {
        "addr1": "280 Haverhill Street",
        "add2": "",
        "city": "Lawrence",
        "state": "MA",
        "zip": "01840"
      },
      "contact": {
        "phone": "",
        "fax": ""
      }
    }
  ]
}

XML Example.
Note: All XML code inside of <payload> element is escaped. See raw string response
JSON Example

Call example (C#):

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