Orders Storage (v1)

http://github.com/folio-org/mod-orders-storage

Table of contents

Purchase Order Line Numbers

API used to manage Purchase Order Line numbers. This API is intended for internal use only

/orders-storage/po-line-number

GET /orders-storage/po-line-number

Get purchase order line numbers

GET /orders-storage/po-line-number
Query Parameters
  • purchaseOrderId: required (string - pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$)

    Purchase Order Id

    Example:

    8ad4b87b-9b47-4199-b0c3-5480745c6b41
  • poLineNumbers: required (integer - default: 1)

    Quantity of the PO line numbers

    Example:

    1

Response 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of sequence numbers",
  "type": "object",
  "properties": {
    "sequenceNumbers": {
      "description": "The list of sequence numbers",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}

Response 400

Bad request, e.g. malformed request body or query parameter

Body

Media type: text/plain

Type: any

Example:

Unable to generate purchase order line number

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact Administrator