added frameworks entities

2024-03-25 15:15:48 -07:00
parent 81e4baccb1
commit 600a8e1f61
95 changed files with 59733 additions and 0 deletions
--- a/FRAMEWORKS/STPROC/PING_API.txt
+++ b/FRAMEWORKS/STPROC/PING_API.txt
@ -0,0 +1,82 @@
+Function Ping_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        :   Ping_API
+
+    Description :   API logic for the Ping 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.
+                        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 Ping[.ID.[<Property>]]
+                                    - HTTPMethod can be any valid HTTP method, e.g., GET, POST, PUT, DELETE, etc.
+                                Examples:
+                                    - Ping.POST
+                                    - Ping.ID.PUT
+                                    - Ping.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)
+        06/24/19    dmb     [SRPFW-276] Original programmer.
+        01/18/20    dmb     [SRPFW-296] Update the ping.GET API by replacing Utility_DotNet('TIMEZONE') with
+                            the SRP_DateTime service (SRP Utilities 2.1) to avoid localization problems and potential
+                            502 Bad Gateway errors.
+        01/23/20    dmb     [SRPFW-296] Add matching HEAD APIs for all GET APIs.
+
+***********************************************************************************************************************/
+
+#pragma precomp SRP_PreCompiler
+
+$insert APP_INSERTS
+$insert API_SETUP
+$insert HTTP_INSERTS
+
+Declare function    SRP_DateTime
+
+GoToAPI else
+    // The specific resource endpoint doesn't have a API handler yet.
+    HTTP_Services('SetResponseStatus', 204, 'This is a valid endpoint but a web API handler has not yet been created.')
+end
+
+Return Response OR ''
+
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// Endpoint Handlers
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+
+API ping.HEAD
+API ping.GET
+
+    Properties  = 'currentDateTime'
+    Values      = SRP_DateTime('Format', SRP_DateTime('Now', True$), "DDD, DD MMM YYYY hh:mm:ss 'GMT'")
+    objResource = HTTP_Resource_Services('AddProperties', '', Properties, Values)
+    Rels        = 'self' : @FM : 'apiEntryPoint'
+    URLs        = FullEndpointURL : @FM : APIURL
+    HTTP_Resource_Services('AddLinkRelations', objResource, Rels, URLs)
+
+    If Error_Services('NoError') then
+        // Serialize the object into a JSON string.
+        jsonResource    = HTTP_Resource_Services('GetSerializedResource', objResource)
+        // Set the response body with the JSON string and set the Content-Type response header.
+        HTTP_Services('SetResponseBody', jsonResource, False$, 'application/hal+json')
+    end else
+        HTTP_Services('SetResponseError', '', '', 500, Error_Services('GetMessage'), FullEndpointURL)
+    end
+
+end api