SageBridge API - EnablePortalProviderLocation function

EnablePortalProviderLocation

Create or Update Portal Provider Location.

Call example:


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

Request parameters:

Name	Type	Size	Desciption
providerId	(string)	36	Unique provider identifier (required).
facilityId	(string)	36	Unique location identifier (required).
bookingCode	(string)	50	Booking Code (optional).
bookingName	(string)	30	Booking Name - description for bookingCode (optional).
qaEnabled	(string)		Enabled for Quick Appointments (0/1 or N/Y or false/true) (required)

Notes:

If combination of providerId and facilityId does not exists, it will be created. Otherwise updated.
bookingCode is required for some practices to book an appointment. Define it if required by practice.
bookingCode must be a uniqie per practice, if used.

JSON string request example:

{
  "providerId": "4",
  "facilityId": "5",
  "bookingCode": "DOC4LOC5",
  "bookingName": "Doctor DOC4 at faciliiy LOC5",
  "qaEnabled": "true"
}

XML request example:

Response:

XML or JSON string representing APIResponse structure.

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

Response data:

Name	Type	Desciption
code	(string)	0 - operation successfull. Otherwise see description and validation data.
description	(string)	Result Descriptions
validation	(array)	List of validation errors.
validation.id	(string)	Error/Validation code. See possible validation codes below.
validation.display	(string)	Error description.

Example of JSON payload (success):

{
  "code": "0",
  "description": "Provider location updated successfuly",
  "lang": "en",
  "validation": []
}

Example of JSON payload (failed):

{
  "code": "-1",
  "description": "Request failed. See validation messages",
  "lang": "en",
  "validation": [
    {
      "id": "308",
      "display": "Provider not found"
    }
  ]
}

Example of XML payload (success):

Example of XML payload (failed):

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.

Validation codes:

300 - Unable to process a request.
307 - Too long parameter value. See "display" for more details.
302 - ProviderId is required.
308 - Provider not found.
309 - Provider is not unique.
330 - FacilityId is required.
333 - Location not found.
335 - Location is not unique.
401 - Booking Code already exists.

Known Issues:

None