SageBridge API - GetPortalLocations function

GetPortalLocations

Retrieve a list of current portal locations.

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"GetPortalLocations",                    
"bos5",                                 // practice Path or Tax ID
"JSON",                                 // output format (XML or JSON)
"--request parameters XML or JSON---"   // request parameters
);

Request parameters:

facilityId

(string)

Get information for specific location (optional).

Notes:

This function can be called without request parameters (important).
If facilityId parameter is not provided or empty then this function will return a list of all portal locations.

JSON string request example:

To get information about specific location

{
  "facilityId": "12345"
}

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 PortalLocation items.

Example of XML payload:

Example of JSON payload:

{
  "locations": [
    {
      "facilityId": "1",
      "name": "Lewisburg Office",
      "abbreviation": "LBG",
      "address": {
        "addr1": "1 Main street",
        "addr2": "Room 201",
        "city": "Lewisburg",
        "state": "PA",
        "zip": "17837"
      },
      "phone": "8005551212",
      "fax": "8005551313"
    },

    {
      "phone": "8005551212",
      "fax": "",
      "facilityId": "5",
      "name": "Main Location",
      "abbreviation": "GSC",
      "address": {
        "addr1": "1 Park Blvd",
        "addr2": "Unit 2",
        "city": "Allenwood",
        "state": "PA",
        "zip": "17810",
        "zip4": null,
        "country": null
      }
    }
  ]
}

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

This function may return other codes not listed above; they may vary by practice.

Known Issues:

None