.. AUTO-GENERATED FILE. DO NOT EDIT.

layer-farm-egg-production-records-patch-one
===========================================

Source
------

- Repository: ``jef-systems/jef-layer-farm-backend``
- Source Run ID: ``24916443201``
- Source SHA: ``04fc05c78cba84982ce19870a690a0b7b6a02d48``
- Module: ``layer-farm``
- Documentation Scope: ``async``
- Lambda: ``jef-layer-farm-patch-3``

Endpoint
--------

- API Name: ``jef-layer-farm``
- Action Name: ``patch``
- Method: ``PATCH``
- Scope Label: ``Async``
- Resource Path: ``/layer-farm-egg-production-records-patch-one``
- Complete Endpoint: ``https://vx9egxavaa.execute-api.ap-southeast-1.amazonaws.com/prod/layer-farm-egg-production-records-patch-one``
- Lambda ARN: ``arn:aws:lambda:ap-southeast-1:246715082475:function:jef-layer-farm-patch-3``
- curl payload mode: ``json_body``

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

.. code-block:: text

   Function: jef-layer-farm-patch-3
   API Name: jef-layer-farm
   Action: patch
   Method: PATCH
   Resource Path: /layer-farm-egg-production-records-patch-one
   
   Payload:
   - entity_number: string-4-digits-nonzerostart
   - record_id: string-{house-slug}-{batch-slug}-{date}
   - flock_id: string-{house-slug}-{batch-slug}-optional
   - house: string-optional
   - batch: string-optional
   - start_date: string-yyyy-mm-dd-optional
   - date: string-yyyy-mm-dd-optional
   - caretaker: string-optional
   - previous_population: number-whole-number-optional
   - mortality: number-whole-number-optional
   - total_eggs: number-whole-number-optional
   - trays: number-whole-number-optional
   - damaged_eggs: number-whole-number-optional
   - medications: [{"id":"string","dose":"string","notes":"string"}]
   - observations: {"appetite":"string","water_intake":"string","droppings":"string","breathing":"string","shell_quality":"string","bird_activity":"string"}
   - actions_taken: ["string"]
   - remarks: ["string"]
   - next_medications_date: string-yyyy-mm-dd-optional
   - next_medications: [{"id":"string","dose":"string","notes":"string"}]
   - is_deleted: boolean-optional
   
   Response:
   - exists: boolean
   - message: string
   - source: string when operation reaches DynamoDB
   - item: object when found/created/updated
   - key: object when not found or duplicate

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

.. code-block:: json

   {
     "entity_number": "string-4-digits-nonzerostart",
     "record_id": "string-{house-slug}-{batch-slug}-{date}",
     "flock_id": "string-{house-slug}-{batch-slug}-optional",
     "house": "string-optional",
     "batch": "string-optional",
     "start_date": "string-yyyy-mm-dd-optional",
     "date": "string-yyyy-mm-dd-optional",
     "caretaker": "string-optional",
     "previous_population": "number-whole-number-optional",
     "mortality": "number-whole-number-optional",
     "total_eggs": "number-whole-number-optional",
     "trays": "number-whole-number-optional",
     "damaged_eggs": "number-whole-number-optional",
     "medications": "[{\"id\":\"string\",\"dose\":\"string\",\"notes\":\"string\"}]",
     "observations": "{\"appetite\":\"string\",\"water_intake\":\"string\",\"droppings\":\"string\",\"breathing\":\"string\",\"shell_quality\":\"string\",\"bird_activity\":\"string\"}",
     "actions_taken": "[\"string\"]",
     "remarks": "[\"string\"]",
     "next_medications_date": "string-yyyy-mm-dd-optional",
     "next_medications": "[{\"id\":\"string\",\"dose\":\"string\",\"notes\":\"string\"}]",
     "is_deleted": "boolean-optional"
   }

Response
--------

.. code-block:: json

   {
     "exists": "boolean",
     "message": "string",
     "source": "string when operation reaches DynamoDB",
     "item": "object when found/created/updated",
     "key": "object when not found or duplicate"
   }

CMD curl
--------

.. code-block:: text

   curl -X PATCH "https://vx9egxavaa.execute-api.ap-southeast-1.amazonaws.com/prod/layer-farm-egg-production-records-patch-one" -H "Content-Type: application/json" --data-raw "{\"entity_number\": \"string-4-digits-nonzerostart\", \"record_id\": \"string-{house-slug}-{batch-slug}-{date}\", \"flock_id\": \"string-{house-slug}-{batch-slug}-optional\", \"house\": \"string-optional\", \"batch\": \"string-optional\", \"start_date\": \"string-yyyy-mm-dd-optional\", \"date\": \"string-yyyy-mm-dd-optional\", \"caretaker\": \"string-optional\", \"previous_population\": \"number-whole-number-optional\", \"mortality\": \"number-whole-number-optional\", \"total_eggs\": \"number-whole-number-optional\", \"trays\": \"number-whole-number-optional\", \"damaged_eggs\": \"number-whole-number-optional\", \"medications\": \"[{\\\"id\\\":\\\"string\\\",\\\"dose\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\"}]\", \"observations\": \"{\\\"appetite\\\":\\\"string\\\",\\\"water_intake\\\":\\\"string\\\",\\\"droppings\\\":\\\"string\\\",\\\"breathing\\\":\\\"string\\\",\\\"shell_quality\\\":\\\"string\\\",\\\"bird_activity\\\":\\\"string\\\"}\", \"actions_taken\": \"[\\\"string\\\"]\", \"remarks\": \"[\\\"string\\\"]\", \"next_medications_date\": \"string-yyyy-mm-dd-optional\", \"next_medications\": \"[{\\\"id\\\":\\\"string\\\",\\\"dose\\\":\\\"string\\\",\\\"notes\\\":\\\"string\\\"}]\", \"is_deleted\": \"boolean-optional\"}"

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

.. code-block:: text

   curl.exe -X PATCH "https://vx9egxavaa.execute-api.ap-southeast-1.amazonaws.com/prod/layer-farm-egg-production-records-patch-one" -H "Content-Type: application/json" --data-raw '{"entity_number": "string-4-digits-nonzerostart", "record_id": "string-{house-slug}-{batch-slug}-{date}", "flock_id": "string-{house-slug}-{batch-slug}-optional", "house": "string-optional", "batch": "string-optional", "start_date": "string-yyyy-mm-dd-optional", "date": "string-yyyy-mm-dd-optional", "caretaker": "string-optional", "previous_population": "number-whole-number-optional", "mortality": "number-whole-number-optional", "total_eggs": "number-whole-number-optional", "trays": "number-whole-number-optional", "damaged_eggs": "number-whole-number-optional", "medications": "[{\"id\":\"string\",\"dose\":\"string\",\"notes\":\"string\"}]", "observations": "{\"appetite\":\"string\",\"water_intake\":\"string\",\"droppings\":\"string\",\"breathing\":\"string\",\"shell_quality\":\"string\",\"bird_activity\":\"string\"}", "actions_taken": "[\"string\"]", "remarks": "[\"string\"]", "next_medications_date": "string-yyyy-mm-dd-optional", "next_medications": "[{\"id\":\"string\",\"dose\":\"string\",\"notes\":\"string\"}]", "is_deleted": "boolean-optional"}'