Skip to main content

HS.BulkFHIR.UI.RestHandler

class HS.BulkFHIR.UI.RestHandler extends %CSP.REST, HS.BulkFHIR.Util

Dispatch class for all UI REST requests

Method Inventory

Parameters

parameter CHARSET = UTF-8;
Inherited description: Specifies the default character set for the page. This can be overriden using the <CSP:CONTENT CHARSET=> tag, or by setting the %response.CharSet property in the OnPreHTTP() method. If this parameter is not specified, then for the default charset is utf-8.
parameter HandleCorsRequest = 1;
Inherited description: This parameter influences the CORS support. The default is an empty string meaning 'not specified'. If set to true (1) then CORS processing is ON. If set to false (0) then CORS processing is OFF. If left unset ("") then the decision to process CORS is delegated to the setting on the URL map route.
parameter UseSession = 0;
Inherited description: This parameter controls the CSP session support. By default the CSP session will be ended after each request in accordance with the spirit of REST. However this CAN be overridden by the user. To use a session, it's necessary to manage the CSPSESSION cookie. Browsers do this automatically but command line tools such as CURL require the setting of options.

Note that if you choose to use a session then this will use a CSP license until the session is ended or expires and the grace period has been satisfied. If you use the default of no session then this will be the same behavior as SOAP requests of holding a license for ten seconds.

Methods

classmethod OnPreDispatch(pUrl As %String, pMethod As %String, ByRef pContinue As %Boolean) as %Status
Override of %CSP.REST OnPreDispatch(). This method gets called prior to dispatch of EVERY request. If this method sets pContinue to 0, the request will NOT be dispatched according to the UrlMap. In that case it is the responsibility of this method to return a response.
classmethod Response(pResponse="", pSC="") as %Status
Output either response or error message in a standard way
classmethod httpStatusResponse(pSC As %Status) as %Boolean
Same response handler as HSMOD.REST.Base, but always send response body with error description

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new tab