HS.HC.FHIRSQL.REST.APIBase
abstract class HS.HC.FHIRSQL.REST.APIBase extends %CSP.REST, HS.HC.FHIRSQL.REST.Common
Method Inventory
Parameters
parameter AnalysisVersion = 1;
The AnalysisVersion, SpecificationVersion, ProjectionVersion and RepositoryVersion
MUST be kept in sync between the inheriting FrontEndAPI.V* and BackEndAPI.V*
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 CONVERTINPUTSTREAM = 1;
CONVERTIMPUTSTREAM is required to handle the UTF-8 characters ie japanese (IF-4520)
parameter ProjectionVersion = 1;
parameter RepositoryVersion = 1;
parameter SpecificationVersion = 1;
parameter VERSION;
Methods
classmethod GetVersions() as %DynamicAbstractObject
return an object containing current versions of the latest versions of the REST api, analysis, specification and projection
eg { "api": 2, "analysis": 1, "specification": 1, "projection": 2 }
classmethod OnPreDispatch(pUrl As %String, pMethod As %String, ByRef pContinue As %Boolean) as %Status
Override %CSP.REST OnPreDispatch method
This method gets called prior to dispatch of the request. Put any common code here
that you want to be executed for EVERY request. If pContinue is set to 0, the
request will NOT be dispatched according to the UrlMap. In this case it's the
responsibility of the user to return a response.
classmethod getMethods(pClassname, pJustDiffs As %Boolean, Output pMethods)
classmethod info() as %Status
Generate information about this endpoint
Query parameters include VERSION for a particular version and prior
DIFFS = 1 will only show the methods for this particular version (essentially what has changed for this version)
Inherited Members
Inherited Methods
- %ClassIsLatestVersion()
- %ClassName()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %New()
- %OriginalNamespace()
- %PackageName()
- %SetModified()
- AcceptsContentType()
- AccessCheck()
- ConvertParameter()
- Decrypt()
- DispatchRequest()
- DrawCSS3STYLE()
- DrawHEAD()
- DrawSTHEAD()
- DrawSTTitle()
- DrawSTYLE()
- DrawTitle()
- DrawTitleSection()
- Encrypt()
- Error()
- EscapeHTML()
- EscapeURL()
- GetAuthChallenge()
- Http403()
- Http404()
- Http405()
- Http500()
- HyperEventCall()
- HyperEventHead()
- Include()
- InsertHiddenField()
- InsertHiddenFields()
- IsPrivate()
- Link()
- Login()
- OnErrorSetup()
- OnHTTPHeader()
- OnHandleCorsRequest()
- OnHandleOptionsRequest()
- OnLoginPage()
- OnPage()
- OnPageError()
- OnPostHTTP()
- OnPostHyperEvent()
- OnPreHTTP()
- OnPreHyperEvent()
- OnSecurityTokenPage()
- PackageReply()
- Page()
- QuoteJS()
- ReportError()
- ReportHttpStatusCode()
- Respond()
- RewriteURL()
- SetResponseHeaderIfEmpty()
- ShowError()
- StartTimer()
- StatusToJSON()
- StatusToProxyObject()
- StopTimer()
- SupportedVerbs()
- ThrowError()
- UnescapeHTML()
- UnescapeURL()
- ValidateArray()
- ValidateObject()
- ValidateTemplate()