mod-orders-storage (v1)

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

Table of contents

Receiving History

Get list of receiving history API

/orders-storage/receiving-history

Entity representing a receiving-history

GET /orders-storage/receiving-history

Get list of receiving history

GET /orders-storage/receiving-history
Query Parameters
  • query: (string)

    A query expressed as a CQL string (see dev.folio.org/reference/glossary#cql) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

    with valid searchable fields: for example code

    Example:

    (username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
    
    ["code", "MEDGRANT", "="]
    
  • offset: (integer - default: 0 - minimum: 0 - maximum: 2147483647)

    Skip over a number of elements by specifying an offset value for the query

    Example:

    0
  • limit: (integer - default: 10 - minimum: 0 - maximum: 2147483647)

    Limit the number of elements returned in the response

    Example:

    10
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 200

Returns item with a given ID

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "collection of receiving history",
  "type": "object",
  "properties": {
    "receiving_history": {
      "description": "collection of receiving history",
      "type": "array",
      "id": "receiving_history",
      "items": {
        "type": "object",
        "$ref": "receiving_history.json"
      }
    },
    "total_records": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    },
    "first": {
      "description": "The index of the first object contained in this collection",
      "type": "integer"
    },
    "last": {
      "description": "The index of the last object contained in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "receiving_history",
    "total_records"
  ]
}

Example:

{
  "receiving_history":
    [
      {
        "id": "5e317dc2-deeb-4429-b2a1-91e5cd0fd5f7",
        "caption": "Tutorial Volume 10",
        "comment": "Special Edition",
        "dateOrdered": "2018-09-09T00:00:00.000",
        "itemId": "1c92433e-916d-452e-ac76-5268d0ec3f66",
        "poLineId": "c1498090-538a-4470-9525-27e4e0c74b07",
        "poLineNumber": "268758-03",
        "purchaseOrderId": "0804ddec-6545-404a-b54d-a693f505681d",
        "receivedDate": "2018-10-09T00:00:00.000Z",
        "receivingNote": "ASD FGH ABCDEFGHIJKLMNOPQ",
        "receivingStatus": "Expected",
        "supplement": true,
        "title": "Kayak Fishing in the Northern Gulf Coast"
      }
    ],
  "total_records": 1,
  "first": 1,
  "last": 1
}

Response 400

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Body

Media type: text/plain

Type: any

Example:

"unable to list receiving-history -- malformed parameter 'query', syntax error at column 6"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

"unable to list receiving-history -- unauthorized"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"receiving-history not found"

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator