hardware-rental-item

Source

  • Repository: jef-systems/jef-hardware-backend

  • Source Run ID: 24854223497

  • Source SHA: c33cd70faaabb5012e45c8006fc54830c2713078

  • Module: hardware

  • Documentation Scope: get

  • Lambda: jef-hardware-get-8

Endpoint

  • API Name: jef-hardware

  • Action Name: get

  • Method: GET

  • Scope Label: GET

  • Resource Path: /hardware-rental-item

  • Complete Endpoint: https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-rental-item

  • Lambda ARN: arn:aws:lambda:ap-southeast-1:246715082475:function:jef-hardware-get-8

  • curl payload mode: query_string

API Gateway Description

Function: jef-hardware-get-8
API Name: jef-hardware
Action: get
Method: GET
Resource Path: /hardware-rental-item

Payload:
- pk: string-optional
- rentalId: string-optional

Response:
- exists: boolean
- message: string
- item: {"pk":"string-{rentalId}","gsi_1_pk":"string-{customerId}","gsi_1_sk":"string-{createdAt}","gsi_2_pk":"string-{rentalStatus}","gsi_2_sk":"string-{createdAt}","gsi_3_pk":"string-{printStatus}","gsi_3_sk":"string-{createdAt}","id":"string","rentalId":"string","orderNumber":"string","createdAt":"string-iso8601","updatedAt":"string-iso8601","cashierName":"string","terminalName":"string","customerId":"string","customerCode":"string","customerName":"string","customerMobileNumber":"string","customerAddress":"string","customerGovernmentIdType":"string","customerGovernmentIdNumber":"string","deposit":"number-whole-number","grossTotal":"number-whole-number","totalDue":"number-whole-number","items":[{"lineId":"string","equipmentId":"string","toolboxNumber":"string","equipmentName":"string","category":"string","includedItems":["string"],"ratePerDay":"number-whole-number","days":"number-whole-number","subtotal":"number-whole-number","qrValue":"string","expectedReturnAt":"string-iso8601"}],"expectedReturnAt":"string-iso8601","rentalStatus":"string","printStatus":"string","printedAt":"string-iso8601|string-empty","printerDeviceId":"string|string-empty","printerDeviceName":"string|string-empty","version":"number-whole-number","isDeleted":"boolean","syncStatus":"string","syncAttemptCount":"number-whole-number"}
- source: string

Request Payload

{
  "pk": "string-optional",
  "rentalId": "string-optional"
}

Response

{
  "exists": "boolean",
  "message": "string",
  "item": "{\"pk\":\"string-{rentalId}\",\"gsi_1_pk\":\"string-{customerId}\",\"gsi_1_sk\":\"string-{createdAt}\",\"gsi_2_pk\":\"string-{rentalStatus}\",\"gsi_2_sk\":\"string-{createdAt}\",\"gsi_3_pk\":\"string-{printStatus}\",\"gsi_3_sk\":\"string-{createdAt}\",\"id\":\"string\",\"rentalId\":\"string\",\"orderNumber\":\"string\",\"createdAt\":\"string-iso8601\",\"updatedAt\":\"string-iso8601\",\"cashierName\":\"string\",\"terminalName\":\"string\",\"customerId\":\"string\",\"customerCode\":\"string\",\"customerName\":\"string\",\"customerMobileNumber\":\"string\",\"customerAddress\":\"string\",\"customerGovernmentIdType\":\"string\",\"customerGovernmentIdNumber\":\"string\",\"deposit\":\"number-whole-number\",\"grossTotal\":\"number-whole-number\",\"totalDue\":\"number-whole-number\",\"items\":[{\"lineId\":\"string\",\"equipmentId\":\"string\",\"toolboxNumber\":\"string\",\"equipmentName\":\"string\",\"category\":\"string\",\"includedItems\":[\"string\"],\"ratePerDay\":\"number-whole-number\",\"days\":\"number-whole-number\",\"subtotal\":\"number-whole-number\",\"qrValue\":\"string\",\"expectedReturnAt\":\"string-iso8601\"}],\"expectedReturnAt\":\"string-iso8601\",\"rentalStatus\":\"string\",\"printStatus\":\"string\",\"printedAt\":\"string-iso8601|string-empty\",\"printerDeviceId\":\"string|string-empty\",\"printerDeviceName\":\"string|string-empty\",\"version\":\"number-whole-number\",\"isDeleted\":\"boolean\",\"syncStatus\":\"string\",\"syncAttemptCount\":\"number-whole-number\"}",
  "source": "string"
}

CMD curl

curl "https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-rental-item?pk=string-optional&rentalId=string-optional"

PowerShell curl

curl.exe "https://24jo9zrosl.execute-api.ap-southeast-1.amazonaws.com/prod/hardware-rental-item?pk=string-optional&rentalId=string-optional"