Complete scanned document upload

Summary

  • Source repository: jef-systems/jef-accounting-backend

  • Source SHA: eaca6413a00fd211146c504137047c3d327f687b

  • Source run id: 31404676080

  • Module: Accounting

  • Lambda function: jef-accounting-complete-scanned-document-upload

  • HTTP method: POST

  • Invocation mode: sync

  • Package mode: no-package

  • API category: Accounting Complex Sync No Package POST APIs

  • API path: /accounting/complex-sync-no-packages/jef-accounting-complete-scanned-document-upload

  • Endpoint URL: https://api.jefoffice.com/accounting/complex-sync-no-packages/jef-accounting-complete-scanned-document-upload

  • Documentation scope: lambda-complex-sync-no-packages

Synchronous Lambda Complex Rule

This API is documented as a synchronous Lambda complex no-package API. API Gateway waits for the Lambda result and returns the final Lambda response.

Description

Confirms that a reserved scanned PDF for the supplied jsin exists in S3 and advances the server-owned document state to uploaded.

Payload Example

{
  "jsin": "1513",
  "document_name": "0123456789abcdef0123456789abcdef.pdf"
}

Payload Schema

{
  "root": {
    "type": "M",
    "required": true,
    "additional_properties": false,
    "attributes": {
      "jsin": {
        "type": "S",
        "required": true,
        "regex": "^[0-9]{4}$"
      },
      "document_name": {
        "type": "S",
        "required": true,
        "regex": "^[A-Za-z0-9][A-Za-z0-9._-]{0,254}$"
      }
    }
  }
}

Response Schema

{
  "root": {
    "type": "M",
    "required": true,
    "additional_properties": false,
    "attributes": {
      "document_name": {
        "type": "S",
        "required": false
      },
      "status": {
        "type": "S",
        "required": false
      },
      "error_code": {
        "type": "S",
        "required": false
      },
      "message": {
        "type": "S",
        "required": false
      }
    }
  }
}

Request Payload

{
  "jsin": "1513",
  "document_name": "0123456789abcdef0123456789abcdef.pdf"
}

CMD curl

curl.exe -X POST "https://api.jefoffice.com/accounting/complex-sync-no-packages/jef-accounting-complete-scanned-document-upload" -H "Content-Type: application/json" --data-raw '{}'

PowerShell curl

curl.exe -X POST "https://api.jefoffice.com/accounting/complex-sync-no-packages/jef-accounting-complete-scanned-document-upload" -H "Content-Type: application/json" --data-raw '{}'