Function Engineinfo_API(@API) /*********************************************************************************************************************** This program is proprietary and is not to be used by or disclosed to others, nor is it to be copied without written permission from SRP Computer Solutions, Inc. Name : Engineinfo_API Description : API logic for the Engineinfo resource. Notes : All web APIs should include the API_SETUP insert. This will provide several useful variables: HTTPMethod - The HTTP Method (Verb) submitted by the client (e.g., GET, POST, etc.) APIURL - The URL for the API entry point (e.g., api.mysite.com/v1). FullEndpointURL - The URL submitted by the client, including query params. FullEndpointURLNoQuery - The URL submitted by the client, excluding query params. EndpointSegment - The URL endpoint segment. ParentURL - The URL path preceeding the current endpoint. CurrentAPI - The name of this stored procedure. Parameters : API [in] -- Web API to process. Format is [APIPattern].[HTTPMethod]: - APIPattern must follow this structure Engineinfo[.ID.[]] - HTTPMethod can be any valid HTTP method, e.g., GET, POST, PUT, DELETE, etc. Examples: - Engineinfo.POST - Engineinfo.ID.PUT - Engineinfo.ID.firstName.GET Response [out] -- Response to be sent back to the Controller (HTTP_MCP) or requesting procedure. Web API services do not rely upon anything being returned in the response. This is what the various services like SetResponseBody and SetResponseStatus services are for. A response value is only helpful if the developers want to use it for debug purposes. History : (Date, Initials, Notes) 07/17/24 xxx Original programmer. ***********************************************************************************************************************/ #pragma precomp SRP_PreCompiler $insert APP_INSERTS $insert API_SETUP $insert HTTP_INSERTS $insert ENGINE_HEALTH_EQUATES Declare function System_Healthcheck_Services GoToAPI else // The specific resource endpoint doesn't have a API handler yet. HTTP_Services('SetResponseStatus', 200, 'This is a valid endpoint but a web API handler has not yet been created.') end Return Response OR '' //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // Endpoint Handlers //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// API remotehealthcheck.HEAD API remotehealthcheck.GET HTTP_Resource_Services('LoremIpsum') end api API engineinfo.HEAD API engineinfo.GET HTTP_Resource_Services('LoremIpsum') end api API engineinfo.ID.HEAD API engineinfo.ID.GET EngineID = EndpointSegment If RowExists('APP_INFO', EngineID) then EngineHealthInfo = System_Healthcheck_Services('GetEngineHealthInfo', EngineID) If Error_Services('NoError') then EngineJSON = System_Healthcheck_Services('ConvertEngineHealthInfoToJSON', EngineHealthInfo, FullEndpointURL) ResponseCode = 200 HTTP_Services('SetResponseHeaderField', 'Content-Location', FullEndpointURL) HTTP_Services('SetResponseBody', EngineJSON, False$, 'application/hal+json') HTTP_Services('SetResponseStatus', ResponseCode) end else HTTP_Services('SetResponseStatus', 500, Error_Services('GetMessage')) end end else HTTP_Services('SetResponseStatus', 401, 'Invalid Engine ID.') end end api