SageBridge API - DeletePortalLocation function

DeletePortalLocation

Delete Portal Location.

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"DeletePortalLocation",                    
"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
facilityId	(string)	36	Unique location identifier.

Example of JSON request:

{ "facilityId": "1" }

Example of XML request:

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": "Location deleted successfuly",
  "validation": null
}

Example of JSON payload (failed):

{
  "code": "-1",
  "description": "Incorrect request. See validation messages",
  "lang": "en",
  "validation": [
    {"id": "333", "display": "Location 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.
301 - Unable to parse request parameters.
330 - FacilityId is required.
332 - Location is not unique.
333 - Location not found.

Known Issues:

None