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/OATH_API.txt
+++ b/FRAMEWORKS/STPROC/OATH_API.txt
@ -0,0 +1,56 @@
+Function Oath_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        :   Oath_API
+
+    Description :   API logic for the Oath 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 [Resource].[HTTPMethod]. For example:
+                                    - Oath.POST
+                                    - Oath.ID.PUT
+                                    - Oath.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)
+        11/22/18    dmb     Original programmer. - [SRPFW-256]
+
+***********************************************************************************************************************/
+
+#pragma precomp SRP_PreCompiler
+
+$insert APP_INSERTS
+$insert API_SETUP
+$insert HTTP_INSERTS
+
+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 ''
+
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// Web APIs
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+
+API oath.GET
+
+end api