.. AUTO-GENERATED FILE. DO NOT EDIT.

fuel-pump-inventories-gas-stations-get-one
==========================================

Source
------

- Repository: ``jef-systems/jef-fuel-pump-inventories-backend``
- Source Run ID: ``24966853525``
- Source SHA: ``1159f01c85f4a6aefdd03618419a726c3fc9edbb``
- Module: ``fuel-pump-inventories``
- Documentation Scope: ``get``
- Lambda: ``jef-fuel-pump-inventories-get-1``

Endpoint
--------

- API Name: ``jef-fuel-pump-inventories``
- Action Name: ``get``
- Method: ``GET``
- Scope Label: ``GET``
- Resource Path: ``/fuel-pump-inventories-gas-stations-get-one``
- Complete Endpoint: ``https://zgmzv02c7f.execute-api.ap-southeast-1.amazonaws.com/prod/fuel-pump-inventories-gas-stations-get-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-fuel-pump-inventories-get-1``
- curl payload mode: ``query_string``

API Gateway Description
-----------------------

.. code-block:: text

   Function: jef-fuel-pump-inventories-get-1
   API Name: jef-fuel-pump-inventories
   Action: get
   Method: GET
   Resource Path: /fuel-pump-inventories-gas-stations-get-one
   
   Table:
   - table: jef-fuel-pump-inventories-gas-stations
   
   Payload Schema:
   - pk: entity_number
   
   Payload Example:
   - pk: 0001
   
   Response Schema:
   - exists: boolean
   - message: string
   - item: {"entity_number":"string","station_name":"string","address":"string"}

Request Payload
---------------

.. code-block:: json

   {
     "pk": "entity_number"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "item": "{\"entity_number\":\"string\",\"station_name\":\"string\",\"address\":\"string\"}"
   }

CMD curl
--------

.. code-block:: text

   curl "https://zgmzv02c7f.execute-api.ap-southeast-1.amazonaws.com/prod/fuel-pump-inventories-gas-stations-get-one?pk=0001"

PowerShell curl
---------------

.. code-block:: text

   curl.exe "https://zgmzv02c7f.execute-api.ap-southeast-1.amazonaws.com/prod/fuel-pump-inventories-gas-stations-get-one?pk=0001"