.. AUTO-GENERATED FILE. DO NOT EDIT.

fuel-pump-inventories-pumps-get-many
====================================

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-8``

Endpoint
--------

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

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

.. code-block:: text

   Function: jef-fuel-pump-inventories-get-8
   API Name: jef-fuel-pump-inventories
   Action: get
   Method: GET
   Resource Path: /fuel-pump-inventories-pumps-get-many
   
   Table:
   - table: jef-fuel-pump-inventories-pumps
   
   Payload Schema:
   - gsi_1_pk: entity_number
   
   Payload Example:
   - gsi_1_pk: 0001
   
   Response Schema:
   - exists: boolean
   - message: string
   - items: [{"entity_number":"string","pump_id":"string","pump_label":"string","product":"string","price_per_liter":"number","display_order":"number","is_active":"boolean","created_at":"string","updated_at":"string"}]

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

.. code-block:: json

   {
     "gsi_1_pk": "entity_number"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "items": "[{\"entity_number\":\"string\",\"pump_id\":\"string\",\"pump_label\":\"string\",\"product\":\"string\",\"price_per_liter\":\"number\",\"display_order\":\"number\",\"is_active\":\"boolean\",\"created_at\":\"string\",\"updated_at\":\"string\"}]"
   }

CMD curl
--------

.. code-block:: text

   curl "https://zgmzv02c7f.execute-api.ap-southeast-1.amazonaws.com/prod/fuel-pump-inventories-pumps-get-many?gsi_1_pk=0001"

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

.. code-block:: text

   curl.exe "https://zgmzv02c7f.execute-api.ap-southeast-1.amazonaws.com/prod/fuel-pump-inventories-pumps-get-many?gsi_1_pk=0001"