mod-orders (v1)

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

Table of contents

mod-orders

This module implements the CRUD interface

/po_line

Collection of po_line items.

GET /po_line

Get list of purchase orders

GET /po_line
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 a list of po_line items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "collection of purchase order line records",
  "type": "object",
  "properties": {
    "po_lines": {
      "description": "collection of purchase order line records",
      "type": "array",
      "id": "po_lines",
      "items": {
        "type": "object",
        "$ref": "po_line.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": [
    "po_lines",
    "total_records"
  ]
}

Example:

{
    "po_lines": [
      {
        "id": "c0d08448-347b-418a-8c2f-5fb50248d67e",
        "created": "2010-10-08T03:53:00.000Z",
        "created_by": "55bac7fc-fed8-11e8-8eb2-f2801f1b9fd1",
        "edition": "First edition",
        "checkin_items": false,
        "instance_id": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
        "agreement_id": "bdc75fea-fed8-11e8-8eb2-f2801f1b9fd1",
        "acquisition_method": "Purchase At Vendor System",
        "adjustment": "1363467f-eb47-4e09-9e28-e25aa464adb7",
        "alerts": [
          "9a665b22-9fe5-4c95-b4ee-837a5433c95d"
        ],
        "cancellation_restriction": false,
        "cancellation_restriction_note": "ABCDEFGHIJKLMNOPQRSTUVW",
        "claims": [
          "f7d7d4e4-255e-46dc-9f08-b953fb1e872d"
        ],
        "collection": false,
        "contributors": [
          {
            "contributor": "Ed Mashburn",
            "contributor_type": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
          }
        ],
        "cost": "e047212b-c94f-4cb1-84b0-367848381494",
        "description": "ABCDEFGH",
        "details": "349d9438-12bd-4e2e-9eb6-dfa830ab99a4",
        "donor": "ABCDEFGHIJKLM",
        "eresource": "468b679c-378b-4009-9a17-a6711cefc85f",
        "fund_distribution": [
          "d10879e8-8c2d-4850-bcb9-0ec8e2e10021"
        ],
        "location": "a4e65e03-99a4-4b39-8e6a-ae666ac52bea",
        "order_format": "Physical Resource",
        "owner": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
        "payment_status": "Awaiting Payment",
        "physical": "5ee243f9-72e5-4464-bdbc-43a21873d648",
        "po_line_description": "ABCDEFGHIJKLMNOPQRSTUVWXY",
        "po_line_number": "268758-03",
        "po_line_workflow_status": "Open",
        "publication_date": "2017",
        "publisher": "Schiffer Publishing",
        "purchase_order_id": "d79b0bcc-DcAD-1E4E-Abb7-DbFcaD5BB3bb",
        "receipt_date": "2018-10-09T00:00:00.000Z",
        "receipt_status": "Awaiting Receipt",
        "renewal": "8e414baa-8cf2-4916-a90f-d1da4009e06e",
        "reporting_codes": [
          "5926dcd7-85f5-4504-8283-712595ebc38b",
          "fa316c04-8101-4e72-8aaf-01281bac718f",
          "ea68b696-3125-4940-bf91-1d128323473e"
        ],
        "requester": "Leo Bulero",
        "rush": true,
        "selector": "ABCD",
        "source": "024b6f41-c5c6-4280-858e-33fba452a334",
        "tags": [
          "ABCDEFGHIJKLMNOPQRSTU",
          "ABCDEFG",
          "ABCDEFGHIJKLMNOPQRSTU",
          "ABCDEFGHIJKLMNO"
        ],
        "title": "Kayak Fishing in the Northern Gulf Coast",
        "vendor_detail": "d5065f0d-fb88-4d23-b0c1-57e754fba40e"
      }
    ],
    "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 po_line -- 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 po_line -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

internal server error, contact administrator

POST /po_line

Create a new po_line item.

POST /po_line
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "purchase order line",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID identifying this purchase order line",
      "type": "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}$"
    },
    "created": {
      "description": "date/time when this purchase order line was created",
      "type": "string",
      "format": "date-time"
    },
    "created_by": {
      "description": "UUID of the user this purchase order line was created by",
      "type": "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}$"
    },
    "edition": {
      "description": "edition of the material",
      "type": "string"
    },
    "checkin_items": {
      "description": "if true this will toggle the Check-in workflow for details associated with this PO line",
      "type": "boolean"
    },
    "instance_id": {
      "description": "UUID of the instance record this purchase order line is related to",
      "type": "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}$"
    },
    "agreement_id": {
      "description": "UUID of the agreement this purchase order line is related to",
      "type": "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}$"
    },
    "acquisition_method": {
      "description": "the acquisition method for this purchase order line",
      "type": "string",
      "enum": [
        "Approval Plan",
        "Demand Driven Acquisitions (DDA)",
        "Depository",
        "Evidence Based Acquisitions (EBA)",
        "Exchange",
        "Gift",
        "Purchase At Vendor System",
        "Purchase",
        "Technical"
      ]
    },
    "adjustment": {
      "description": "UUID of the adjustment record associated with this purchase order line",
      "type": "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}$"
    },
    "alerts": {
      "description": "an array of alert record IDs",
      "id": "alerts",
      "type": "array",
      "items": {
        "description": "UUID of an alert record",
        "type": "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}$"
      }
    },
    "cancellation_restriction": {
      "description": "whether or not there are cancellation restrictions for this purchase order line",
      "type": "boolean"
    },
    "cancellation_restriction_note": {
      "description": "free-form notes related to cancellation restrictions",
      "type": "string"
    },
    "claims": {
      "description": "an array of claim record IDs",
      "id": "claims",
      "type": "array",
      "items": {
        "description": "UUID of a claim record",
        "type": "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}$"
      }
    },
    "collection": {
      "description": "whether or not this purchase order line is for a collection",
      "type": "boolean"
    },
    "contributors": {
      "description": "list of contributors to the material",
      "id": "contributors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "contributor": {
            "description": "the name of a contributor to the material",
            "type": "string"
          },
          "contributor_type": {
            "description": "UUID of the contributor type",
            "type": "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}$"
          }
        }
      }
    },
    "cost": {
      "description": "UUID of the cost record",
      "type": "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}$"
    },
    "description": {
      "description": "description of the material",
      "type": "string"
    },
    "details": {
      "description": "UUID of the details record",
      "type": "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}$"
    },
    "donor": {
      "description": "the donor contributing to this purchase order line",
      "type": "string"
    },
    "eresource": {
      "description": "UUID of the eresource record",
      "type": "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}$"
    },
    "fund_distribution": {
      "description": "the UUIDs of the fund distribution records for this purchase order line",
      "id": "fund_distribution",
      "type": "array",
      "items": {
        "description": "UUID of a fund distribution record",
        "type": "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}$"
      }
    },
    "location": {
      "description": "UUID of the location record",
      "type": "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}$"
    },
    "order_format": {
      "description": "The purchase order line format",
      "type": "string",
      "enum": [
        "Container",
        "Electronic Resource",
        "P/E Mix",
        "Physical Resource",
        "Service"
      ]
    },
    "owner": {
      "description": "the owner of this purchase order line",
      "type": "string"
    },
    "payment_status": {
      "description": "The purchase order line payment status",
      "type": "string",
      "enum": [
        "Awaiting Payment",
        "Cancelled",
        "Fully Paid",
        "Partially Paid",
        "Payment Not Required",
        "Pending"
      ]
    },
    "physical": {
      "description": "UUID of the physical (details) record",
      "type": "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}$"
    },
    "po_line_description": {
      "description": "purchase order line description",
      "type": "string"
    },
    "po_line_number": {
      "description": "A human readable number assigned to this PO line",
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{5,16}-[0-9]{1,3}$"
    },
    "po_line_workflow_status": {
      "description": "The status of this purchase order line",
      "type": "string",
      "enum": [
        "Closed",
        "Open",
        "Pending"
      ]
    },
    "publication_date": {
      "description": "date (year) of the material's publication",
      "type": "string",
      "pattern": "^[0-9]{4}$"
    },
    "publisher": {
      "description": "publisher of the material",
      "type": "string"
    },
    "purchase_order_id": {
      "description": "UUID of the purchase order",
      "type": "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}$"
    },
    "receipt_date": {
      "description": "date the purchase order line was received",
      "type": [
        "null",
        "string"
      ],
      "format": "date-time"
    },
    "receipt_status": {
      "description": "The purchase order line receipt status",
      "type": "string",
      "enum": [
        "Awaiting Receipt",
        "Cancelled",
        "Fully Received",
        "Partially Received",
        "Pending",
        "Receipt Not Required"
      ]
    },
    "renewal": {
      "description": "UUID of the renewal record",
      "type": "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}$"
    },
    "reporting_codes": {
      "description": "a list of reporting codes associated with this purchase order line",
      "id": "reporting_codes",
      "type": "array",
      "items": {
        "description": "UUID of the reporting code",
        "type": "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}$"
      }
    },
    "requester": {
      "description": "who requested this purchase order line",
      "type": "string"
    },
    "rush": {
      "description": "whether or not this is a rush order",
      "type": "boolean"
    },
    "selector": {
      "description": "who selected this material",
      "type": "string"
    },
    "source": {
      "description": "UUID of the source record",
      "type": "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}$"
    },
    "tags": {
      "description": "arbitrary tags associated with this purchase order line",
      "id": "tags",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "title": {
      "description": "title of the material",
      "type": "string"
    },
    "vendor_detail": {
      "description": "UUID of the vendor detail record",
      "type": "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}$"
    }
  },
  "additionalProperties": false
}

Example:

{
  "acquisition_method": "Purchase At Vendor System",
  "created": "2010-10-08T03:53:00.000Z",
  "created_by": "55bac7fc-fed8-11e8-8eb2-f2801f1b9fd1",
  "edition": "First edition",
  "checkin_items": false,
  "instance_id": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
  "agreement_id": "bdc75fea-fed8-11e8-8eb2-f2801f1b9fd1",
  "adjustment": "1363467f-eb47-4e09-9e28-e25aa464adb7",
  "alerts": [
    "9a665b22-9fe5-4c95-b4ee-837a5433c95d"
  ],
  "cancellation_restriction": false,
  "cancellation_restriction_note": "ABCDEFGHIJKLMNOPQRSTUVW",
  "claims": [
    "f7d7d4e4-255e-46dc-9f08-b953fb1e872d"
  ],
  "collection": false,
  "contributors": [
    {
      "contributor": "Ed Mashburn",
      "contributor_type": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": "e047212b-c94f-4cb1-84b0-367848381494",
  "description": "ABCDEFGH",
  "details": "349d9438-12bd-4e2e-9eb6-dfa830ab99a4",
  "donor": "ABCDEFGHIJKLM",
  "eresource": "468b679c-378b-4009-9a17-a6711cefc85f",
  "fund_distribution": [
    "d10879e8-8c2d-4850-bcb9-0ec8e2e10021"
  ],
  "location": "a4e65e03-99a4-4b39-8e6a-ae666ac52bea",
  "order_format": "Physical Resource",
  "owner": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
  "payment_status": "Awaiting Payment",
  "physical": "5ee243f9-72e5-4464-bdbc-43a21873d648",
  "po_line_description": "ABCDEFGHIJKLMNOPQRSTUVWXY",
  "po_line_number": "268758-03",
  "po_line_workflow_status": "Open",
  "publication_date": "2017",
  "publisher": "Schiffer Publishing",
  "purchase_order_id": "d79b0bcc-DcAD-1E4E-Abb7-DbFcaD5BB3bb",
  "receipt_date": "2018-10-09T00:00:00.000Z",
  "receipt_status": "Awaiting Receipt",
  "renewal": "8e414baa-8cf2-4916-a90f-d1da4009e06e",
  "reporting_codes": [
    "5926dcd7-85f5-4504-8283-712595ebc38b",
    "fa316c04-8101-4e72-8aaf-01281bac718f",
    "ea68b696-3125-4940-bf91-1d128323473e"
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": "024b6f41-c5c6-4280-858e-33fba452a334",
  "tags": [
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFG",
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFGHIJKLMNO"
  ],
  "title": "Kayak Fishing in the Northern Gulf Coast",
  "vendor_detail": "d5065f0d-fb88-4d23-b0c1-57e754fba40e"

}

Response 201

Returns a newly created item, with server-controlled fields like 'id' populated

Headers
  • Location: required (string)

    URI to the created po_line item

Body

Media type: application/json

Type: any

Example:

{
  "acquisition_method": "Purchase At Vendor System",
  "created": "2010-10-08T03:53:00.000Z",
  "created_by": "55bac7fc-fed8-11e8-8eb2-f2801f1b9fd1",
  "edition": "First edition",
  "checkin_items": false,
  "instance_id": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
  "agreement_id": "bdc75fea-fed8-11e8-8eb2-f2801f1b9fd1",
  "adjustment": "1363467f-eb47-4e09-9e28-e25aa464adb7",
  "alerts": [
    "9a665b22-9fe5-4c95-b4ee-837a5433c95d"
  ],
  "cancellation_restriction": false,
  "cancellation_restriction_note": "ABCDEFGHIJKLMNOPQRSTUVW",
  "claims": [
    "f7d7d4e4-255e-46dc-9f08-b953fb1e872d"
  ],
  "collection": false,
  "contributors": [
    {
      "contributor": "Ed Mashburn",
      "contributor_type": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": "e047212b-c94f-4cb1-84b0-367848381494",
  "description": "ABCDEFGH",
  "details": "349d9438-12bd-4e2e-9eb6-dfa830ab99a4",
  "donor": "ABCDEFGHIJKLM",
  "eresource": "468b679c-378b-4009-9a17-a6711cefc85f",
  "fund_distribution": [
    "d10879e8-8c2d-4850-bcb9-0ec8e2e10021"
  ],
  "location": "a4e65e03-99a4-4b39-8e6a-ae666ac52bea",
  "order_format": "Physical Resource",
  "owner": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
  "payment_status": "Awaiting Payment",
  "physical": "5ee243f9-72e5-4464-bdbc-43a21873d648",
  "po_line_description": "ABCDEFGHIJKLMNOPQRSTUVWXY",
  "po_line_number": "268758-03",
  "po_line_workflow_status": "Open",
  "publication_date": "2017",
  "publisher": "Schiffer Publishing",
  "purchase_order_id": "d79b0bcc-DcAD-1E4E-Abb7-DbFcaD5BB3bb",
  "receipt_date": "2018-10-09T00:00:00.000Z",
  "receipt_status": "Awaiting Receipt",
  "renewal": "8e414baa-8cf2-4916-a90f-d1da4009e06e",
  "reporting_codes": [
    "5926dcd7-85f5-4504-8283-712595ebc38b",
    "fa316c04-8101-4e72-8aaf-01281bac718f",
    "ea68b696-3125-4940-bf91-1d128323473e"
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": "024b6f41-c5c6-4280-858e-33fba452a334",
  "tags": [
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFG",
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFGHIJKLMNO"
  ],
  "title": "Kayak Fishing in the Northern Gulf Coast",
  "vendor_detail": "d5065f0d-fb88-4d23-b0c1-57e754fba40e"

}

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 add po_line -- malformed JSON at 13:3"

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create po_line -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /po_line/{id}

Retrieve po_line item with given {po_lineId}

GET /po_line/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • 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": "purchase order line",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID identifying this purchase order line",
      "type": "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}$"
    },
    "created": {
      "description": "date/time when this purchase order line was created",
      "type": "string",
      "format": "date-time"
    },
    "created_by": {
      "description": "UUID of the user this purchase order line was created by",
      "type": "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}$"
    },
    "edition": {
      "description": "edition of the material",
      "type": "string"
    },
    "checkin_items": {
      "description": "if true this will toggle the Check-in workflow for details associated with this PO line",
      "type": "boolean"
    },
    "instance_id": {
      "description": "UUID of the instance record this purchase order line is related to",
      "type": "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}$"
    },
    "agreement_id": {
      "description": "UUID of the agreement this purchase order line is related to",
      "type": "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}$"
    },
    "acquisition_method": {
      "description": "the acquisition method for this purchase order line",
      "type": "string",
      "enum": [
        "Approval Plan",
        "Demand Driven Acquisitions (DDA)",
        "Depository",
        "Evidence Based Acquisitions (EBA)",
        "Exchange",
        "Gift",
        "Purchase At Vendor System",
        "Purchase",
        "Technical"
      ]
    },
    "adjustment": {
      "description": "UUID of the adjustment record associated with this purchase order line",
      "type": "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}$"
    },
    "alerts": {
      "description": "an array of alert record IDs",
      "id": "alerts",
      "type": "array",
      "items": {
        "description": "UUID of an alert record",
        "type": "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}$"
      }
    },
    "cancellation_restriction": {
      "description": "whether or not there are cancellation restrictions for this purchase order line",
      "type": "boolean"
    },
    "cancellation_restriction_note": {
      "description": "free-form notes related to cancellation restrictions",
      "type": "string"
    },
    "claims": {
      "description": "an array of claim record IDs",
      "id": "claims",
      "type": "array",
      "items": {
        "description": "UUID of a claim record",
        "type": "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}$"
      }
    },
    "collection": {
      "description": "whether or not this purchase order line is for a collection",
      "type": "boolean"
    },
    "contributors": {
      "description": "list of contributors to the material",
      "id": "contributors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "contributor": {
            "description": "the name of a contributor to the material",
            "type": "string"
          },
          "contributor_type": {
            "description": "UUID of the contributor type",
            "type": "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}$"
          }
        }
      }
    },
    "cost": {
      "description": "UUID of the cost record",
      "type": "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}$"
    },
    "description": {
      "description": "description of the material",
      "type": "string"
    },
    "details": {
      "description": "UUID of the details record",
      "type": "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}$"
    },
    "donor": {
      "description": "the donor contributing to this purchase order line",
      "type": "string"
    },
    "eresource": {
      "description": "UUID of the eresource record",
      "type": "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}$"
    },
    "fund_distribution": {
      "description": "the UUIDs of the fund distribution records for this purchase order line",
      "id": "fund_distribution",
      "type": "array",
      "items": {
        "description": "UUID of a fund distribution record",
        "type": "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}$"
      }
    },
    "location": {
      "description": "UUID of the location record",
      "type": "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}$"
    },
    "order_format": {
      "description": "The purchase order line format",
      "type": "string",
      "enum": [
        "Container",
        "Electronic Resource",
        "P/E Mix",
        "Physical Resource",
        "Service"
      ]
    },
    "owner": {
      "description": "the owner of this purchase order line",
      "type": "string"
    },
    "payment_status": {
      "description": "The purchase order line payment status",
      "type": "string",
      "enum": [
        "Awaiting Payment",
        "Cancelled",
        "Fully Paid",
        "Partially Paid",
        "Payment Not Required",
        "Pending"
      ]
    },
    "physical": {
      "description": "UUID of the physical (details) record",
      "type": "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}$"
    },
    "po_line_description": {
      "description": "purchase order line description",
      "type": "string"
    },
    "po_line_number": {
      "description": "A human readable number assigned to this PO line",
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{5,16}-[0-9]{1,3}$"
    },
    "po_line_workflow_status": {
      "description": "The status of this purchase order line",
      "type": "string",
      "enum": [
        "Closed",
        "Open",
        "Pending"
      ]
    },
    "publication_date": {
      "description": "date (year) of the material's publication",
      "type": "string",
      "pattern": "^[0-9]{4}$"
    },
    "publisher": {
      "description": "publisher of the material",
      "type": "string"
    },
    "purchase_order_id": {
      "description": "UUID of the purchase order",
      "type": "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}$"
    },
    "receipt_date": {
      "description": "date the purchase order line was received",
      "type": [
        "null",
        "string"
      ],
      "format": "date-time"
    },
    "receipt_status": {
      "description": "The purchase order line receipt status",
      "type": "string",
      "enum": [
        "Awaiting Receipt",
        "Cancelled",
        "Fully Received",
        "Partially Received",
        "Pending",
        "Receipt Not Required"
      ]
    },
    "renewal": {
      "description": "UUID of the renewal record",
      "type": "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}$"
    },
    "reporting_codes": {
      "description": "a list of reporting codes associated with this purchase order line",
      "id": "reporting_codes",
      "type": "array",
      "items": {
        "description": "UUID of the reporting code",
        "type": "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}$"
      }
    },
    "requester": {
      "description": "who requested this purchase order line",
      "type": "string"
    },
    "rush": {
      "description": "whether or not this is a rush order",
      "type": "boolean"
    },
    "selector": {
      "description": "who selected this material",
      "type": "string"
    },
    "source": {
      "description": "UUID of the source record",
      "type": "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}$"
    },
    "tags": {
      "description": "arbitrary tags associated with this purchase order line",
      "id": "tags",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "title": {
      "description": "title of the material",
      "type": "string"
    },
    "vendor_detail": {
      "description": "UUID of the vendor detail record",
      "type": "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}$"
    }
  },
  "additionalProperties": false
}

Example:

{
  "acquisition_method": "Purchase At Vendor System",
  "created": "2010-10-08T03:53:00.000Z",
  "created_by": "55bac7fc-fed8-11e8-8eb2-f2801f1b9fd1",
  "edition": "First edition",
  "checkin_items": false,
  "instance_id": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
  "agreement_id": "bdc75fea-fed8-11e8-8eb2-f2801f1b9fd1",
  "adjustment": "1363467f-eb47-4e09-9e28-e25aa464adb7",
  "alerts": [
    "9a665b22-9fe5-4c95-b4ee-837a5433c95d"
  ],
  "cancellation_restriction": false,
  "cancellation_restriction_note": "ABCDEFGHIJKLMNOPQRSTUVW",
  "claims": [
    "f7d7d4e4-255e-46dc-9f08-b953fb1e872d"
  ],
  "collection": false,
  "contributors": [
    {
      "contributor": "Ed Mashburn",
      "contributor_type": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": "e047212b-c94f-4cb1-84b0-367848381494",
  "description": "ABCDEFGH",
  "details": "349d9438-12bd-4e2e-9eb6-dfa830ab99a4",
  "donor": "ABCDEFGHIJKLM",
  "eresource": "468b679c-378b-4009-9a17-a6711cefc85f",
  "fund_distribution": [
    "d10879e8-8c2d-4850-bcb9-0ec8e2e10021"
  ],
  "location": "a4e65e03-99a4-4b39-8e6a-ae666ac52bea",
  "order_format": "Physical Resource",
  "owner": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
  "payment_status": "Awaiting Payment",
  "physical": "5ee243f9-72e5-4464-bdbc-43a21873d648",
  "po_line_description": "ABCDEFGHIJKLMNOPQRSTUVWXY",
  "po_line_number": "268758-03",
  "po_line_workflow_status": "Open",
  "publication_date": "2017",
  "publisher": "Schiffer Publishing",
  "purchase_order_id": "d79b0bcc-DcAD-1E4E-Abb7-DbFcaD5BB3bb",
  "receipt_date": "2018-10-09T00:00:00.000Z",
  "receipt_status": "Awaiting Receipt",
  "renewal": "8e414baa-8cf2-4916-a90f-d1da4009e06e",
  "reporting_codes": [
    "5926dcd7-85f5-4504-8283-712595ebc38b",
    "fa316c04-8101-4e72-8aaf-01281bac718f",
    "ea68b696-3125-4940-bf91-1d128323473e"
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": "024b6f41-c5c6-4280-858e-33fba452a334",
  "tags": [
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFG",
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFGHIJKLMNO"
  ],
  "title": "Kayak Fishing in the Northern Gulf Coast",
  "vendor_detail": "d5065f0d-fb88-4d23-b0c1-57e754fba40e"

}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"po_line 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

DELETE /po_line/{id}

Delete po_line item with given {po_lineId}

DELETE /po_line/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Response 204

Item deleted successfully

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 delete po_line -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"po_line 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

PUT /po_line/{id}

Update po_line item with given {po_lineId}

PUT /po_line/{id}
URI Parameters
  • id: required (string)
Query Parameters
  • lang: (string - default: en - pattern: [a-zA-Z]{2})

    Requested language. Optional. [lang=en]

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "purchase order line",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID identifying this purchase order line",
      "type": "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}$"
    },
    "created": {
      "description": "date/time when this purchase order line was created",
      "type": "string",
      "format": "date-time"
    },
    "created_by": {
      "description": "UUID of the user this purchase order line was created by",
      "type": "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}$"
    },
    "edition": {
      "description": "edition of the material",
      "type": "string"
    },
    "checkin_items": {
      "description": "if true this will toggle the Check-in workflow for details associated with this PO line",
      "type": "boolean"
    },
    "instance_id": {
      "description": "UUID of the instance record this purchase order line is related to",
      "type": "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}$"
    },
    "agreement_id": {
      "description": "UUID of the agreement this purchase order line is related to",
      "type": "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}$"
    },
    "acquisition_method": {
      "description": "the acquisition method for this purchase order line",
      "type": "string",
      "enum": [
        "Approval Plan",
        "Demand Driven Acquisitions (DDA)",
        "Depository",
        "Evidence Based Acquisitions (EBA)",
        "Exchange",
        "Gift",
        "Purchase At Vendor System",
        "Purchase",
        "Technical"
      ]
    },
    "adjustment": {
      "description": "UUID of the adjustment record associated with this purchase order line",
      "type": "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}$"
    },
    "alerts": {
      "description": "an array of alert record IDs",
      "id": "alerts",
      "type": "array",
      "items": {
        "description": "UUID of an alert record",
        "type": "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}$"
      }
    },
    "cancellation_restriction": {
      "description": "whether or not there are cancellation restrictions for this purchase order line",
      "type": "boolean"
    },
    "cancellation_restriction_note": {
      "description": "free-form notes related to cancellation restrictions",
      "type": "string"
    },
    "claims": {
      "description": "an array of claim record IDs",
      "id": "claims",
      "type": "array",
      "items": {
        "description": "UUID of a claim record",
        "type": "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}$"
      }
    },
    "collection": {
      "description": "whether or not this purchase order line is for a collection",
      "type": "boolean"
    },
    "contributors": {
      "description": "list of contributors to the material",
      "id": "contributors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "contributor": {
            "description": "the name of a contributor to the material",
            "type": "string"
          },
          "contributor_type": {
            "description": "UUID of the contributor type",
            "type": "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}$"
          }
        }
      }
    },
    "cost": {
      "description": "UUID of the cost record",
      "type": "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}$"
    },
    "description": {
      "description": "description of the material",
      "type": "string"
    },
    "details": {
      "description": "UUID of the details record",
      "type": "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}$"
    },
    "donor": {
      "description": "the donor contributing to this purchase order line",
      "type": "string"
    },
    "eresource": {
      "description": "UUID of the eresource record",
      "type": "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}$"
    },
    "fund_distribution": {
      "description": "the UUIDs of the fund distribution records for this purchase order line",
      "id": "fund_distribution",
      "type": "array",
      "items": {
        "description": "UUID of a fund distribution record",
        "type": "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}$"
      }
    },
    "location": {
      "description": "UUID of the location record",
      "type": "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}$"
    },
    "order_format": {
      "description": "The purchase order line format",
      "type": "string",
      "enum": [
        "Container",
        "Electronic Resource",
        "P/E Mix",
        "Physical Resource",
        "Service"
      ]
    },
    "owner": {
      "description": "the owner of this purchase order line",
      "type": "string"
    },
    "payment_status": {
      "description": "The purchase order line payment status",
      "type": "string",
      "enum": [
        "Awaiting Payment",
        "Cancelled",
        "Fully Paid",
        "Partially Paid",
        "Payment Not Required",
        "Pending"
      ]
    },
    "physical": {
      "description": "UUID of the physical (details) record",
      "type": "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}$"
    },
    "po_line_description": {
      "description": "purchase order line description",
      "type": "string"
    },
    "po_line_number": {
      "description": "A human readable number assigned to this PO line",
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{5,16}-[0-9]{1,3}$"
    },
    "po_line_workflow_status": {
      "description": "The status of this purchase order line",
      "type": "string",
      "enum": [
        "Closed",
        "Open",
        "Pending"
      ]
    },
    "publication_date": {
      "description": "date (year) of the material's publication",
      "type": "string",
      "pattern": "^[0-9]{4}$"
    },
    "publisher": {
      "description": "publisher of the material",
      "type": "string"
    },
    "purchase_order_id": {
      "description": "UUID of the purchase order",
      "type": "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}$"
    },
    "receipt_date": {
      "description": "date the purchase order line was received",
      "type": [
        "null",
        "string"
      ],
      "format": "date-time"
    },
    "receipt_status": {
      "description": "The purchase order line receipt status",
      "type": "string",
      "enum": [
        "Awaiting Receipt",
        "Cancelled",
        "Fully Received",
        "Partially Received",
        "Pending",
        "Receipt Not Required"
      ]
    },
    "renewal": {
      "description": "UUID of the renewal record",
      "type": "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}$"
    },
    "reporting_codes": {
      "description": "a list of reporting codes associated with this purchase order line",
      "id": "reporting_codes",
      "type": "array",
      "items": {
        "description": "UUID of the reporting code",
        "type": "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}$"
      }
    },
    "requester": {
      "description": "who requested this purchase order line",
      "type": "string"
    },
    "rush": {
      "description": "whether or not this is a rush order",
      "type": "boolean"
    },
    "selector": {
      "description": "who selected this material",
      "type": "string"
    },
    "source": {
      "description": "UUID of the source record",
      "type": "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}$"
    },
    "tags": {
      "description": "arbitrary tags associated with this purchase order line",
      "id": "tags",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "title": {
      "description": "title of the material",
      "type": "string"
    },
    "vendor_detail": {
      "description": "UUID of the vendor detail record",
      "type": "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}$"
    }
  },
  "additionalProperties": false
}

Example:

{
  "acquisition_method": "Purchase At Vendor System",
  "created": "2010-10-08T03:53:00.000Z",
  "created_by": "55bac7fc-fed8-11e8-8eb2-f2801f1b9fd1",
  "edition": "First edition",
  "checkin_items": false,
  "instance_id": "8343e5a0-fed8-11e8-8eb2-f2801f1b9fd1",
  "agreement_id": "bdc75fea-fed8-11e8-8eb2-f2801f1b9fd1",
  "adjustment": "1363467f-eb47-4e09-9e28-e25aa464adb7",
  "alerts": [
    "9a665b22-9fe5-4c95-b4ee-837a5433c95d"
  ],
  "cancellation_restriction": false,
  "cancellation_restriction_note": "ABCDEFGHIJKLMNOPQRSTUVW",
  "claims": [
    "f7d7d4e4-255e-46dc-9f08-b953fb1e872d"
  ],
  "collection": false,
  "contributors": [
    {
      "contributor": "Ed Mashburn",
      "contributor_type": "fbdd42a8-e47d-4694-b448-cc571d1b44c3"
    }
  ],
  "cost": "e047212b-c94f-4cb1-84b0-367848381494",
  "description": "ABCDEFGH",
  "details": "349d9438-12bd-4e2e-9eb6-dfa830ab99a4",
  "donor": "ABCDEFGHIJKLM",
  "eresource": "468b679c-378b-4009-9a17-a6711cefc85f",
  "fund_distribution": [
    "d10879e8-8c2d-4850-bcb9-0ec8e2e10021"
  ],
  "location": "a4e65e03-99a4-4b39-8e6a-ae666ac52bea",
  "order_format": "Physical Resource",
  "owner": "ABCDEFGHIJKLMNOPQRSTUVWXYZABC",
  "payment_status": "Awaiting Payment",
  "physical": "5ee243f9-72e5-4464-bdbc-43a21873d648",
  "po_line_description": "ABCDEFGHIJKLMNOPQRSTUVWXY",
  "po_line_number": "268758-03",
  "po_line_workflow_status": "Open",
  "publication_date": "2017",
  "publisher": "Schiffer Publishing",
  "purchase_order_id": "d79b0bcc-DcAD-1E4E-Abb7-DbFcaD5BB3bb",
  "receipt_date": "2018-10-09T00:00:00.000Z",
  "receipt_status": "Awaiting Receipt",
  "renewal": "8e414baa-8cf2-4916-a90f-d1da4009e06e",
  "reporting_codes": [
    "5926dcd7-85f5-4504-8283-712595ebc38b",
    "fa316c04-8101-4e72-8aaf-01281bac718f",
    "ea68b696-3125-4940-bf91-1d128323473e"
  ],
  "requester": "Leo Bulero",
  "rush": true,
  "selector": "ABCD",
  "source": "024b6f41-c5c6-4280-858e-33fba452a334",
  "tags": [
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFG",
    "ABCDEFGHIJKLMNOPQRSTU",
    "ABCDEFGHIJKLMNO"
  ],
  "title": "Kayak Fishing in the Northern Gulf Coast",
  "vendor_detail": "d5065f0d-fb88-4d23-b0c1-57e754fba40e"

}

Response 204

Item successfully updated

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 update po_line -- malformed JSON at 13:4"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"po_line 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