Holding summaries version v1.0

HTTP status code 200

Returns a list of holding-summary items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of holding summary elements",
  "type": "object",
  "properties": {
    "holdingSummaries": {
      "description": "an array of holding summaries",
      "id": "holdingSummaries",
      "type": "array",
      "items": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Holding summary",
        "properties": {
          "poLineId": {
            "description": "Purchase order line id",
            "type": "string",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "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}$"
          },
          "poLineNumber": {
            "description": "Purchase order line number",
            "type": "string"
          },
          "polReceiptStatus": {
            "description": "Purchase order line receipt status",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "enum": [
              "Awaiting Receipt",
              "Cancelled",
              "Fully Received",
              "Partially Received",
              "Pending",
              "Receipt Not Required",
              "Ongoing"
            ],
            "default": "Pending"
          },
          "orderType": {
            "description": "Purchase order type",
            "type": "string",
            "enum": [
              "One-Time",
              "Ongoing"
            ]
          },
          "orderStatus": {
            "description": "Order status",
            "type": "string",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "enum": [
              "Pending",
              "Open",
              "Closed"
            ],
            "default": "Pending"
          },
          "orderSentDate": {
            "description": "Order sent date",
            "type": "string",
            "format": "date-time"
          },
          "orderCloseReason": {
            "description": "Close reason for purchase order",
            "type": "object",
            "$schema": "http://json-schema.org/draft-04/schema#",
            "properties": {
              "reason": {
                "description": "close reason description",
                "type": "string"
              },
              "note": {
                "description": "free-form notes related to closing reason",
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      }
    },
    "totalRecords": {
      "description": "total number of records in the array",
      "type": "integer"
    }
  },
  "required": [
    "holdingSummaries",
    "totalRecords"
  ]
}

Example:

{
  "holdingSummaries": [
    {
      "poLineId": "c0d08448-347b-418a-8c2f-5fb50248d67e",
      "poLineNumber": "12545-1",
      "polReceiptStatus": "Awaiting Receipt",
      "orderType": "One-Time",
      "orderStatus": "Open",
      "orderSentDate": "2018-10-11T00:00:00.000Z",
      "orderCloseReason": {
        "reason": "Complete",
        "note": "EE"
      }
    }
  ],
  "totalRecords": 1
}

HTTP status code 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: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

unable to list holding-summary -- malformed parameter 'query', syntax error at column 6

HTTP status code 500

Internal server error, e.g. due to misconfiguration

Body

Media type: application/json

Type: any

Example:

{
  "errors": [
    {
      "message": "may not be null",
      "type": "1",
      "code": "-1",
      "parameters": [
        {
          "key": "moduleTo",
          "value": "null"
        }
      ]
    }
  ]
}

Media type: text/plain

Type: any

Example:

internal server error, contact administrator