Holdings Storage (v3.0)

http://localhost

Holdings Records Storage API
/holdings-storage

Holdings Records Storage API

Storage for holdings in the inventory

/holdings-storage

GET /holdings-storage/holdings

Retrieve a list of holding items.

GET /holdings-storage/holdings

Query Parameters

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
```
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.
by instance ID (using CQL)
Example:
```
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode

instanceId="2b94c631-fca9-4892-a730-03ee529ffe2a"
```
lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

Response 200

Returns a list of holding items

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of holdings records",
  "type": "object",
  "properties": {
    "holdingsRecords": {
      "description": "List of holdings records",
      "id": "holdingsRecord",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "holdingsrecord.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "required": [
    "holdingsRecords",
    "totalRecords"
  ]
}

Example:

{
  "holdingsRecords": [
    {
      "id": "65cb2bf0-d4c2-4886-8ad0-b76f1ba75d61",
      "instanceId": "cd28da0f-a3e4-465c-82f1-acade4e8e170",
      "permanentLocationId": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
      "holdingsStatements": [
        {
          "statement": "Line 1",
          "note": "Note to line 1"
        },
        {
          "statement": "Line 2",
          "note": "Note to line2"
        }
      ]
    },
    {
      "id": "807084d2-1b6c-4448-a566-d3d9ebfd1c08",
      "instanceId": "601a8dc4-dee7-48eb-b03f-d02fdf0debd0",
      "permanentLocationId": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
      "holdingsStatements": [
        {
          "statement": "Line 1",
          "note": "Note to line 1"
        },
        {
          "statement": "Line 2",
          "note": "Note to line2"
        }
      ]
    }
  ],
  "totalRecords": 2
}

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 holdings -- 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 holdings -- 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 /holdings-storage/holdings

Create a new holding item.

POST /holdings-storage/holdings

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": "A holdings record",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "the system assigned unique ID of the holdings record; UUID"
    },
    "hrid": {
      "type": "string",
      "description": "the human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
    },
    "holdingsTypeId": {
      "type": "string",
      "description": "unique ID for the type of this holdings record, a UUID"
    },
    "formerIds": {
      "type": "array",
      "description": "Previous ID(s) assigned to the holdings record",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "instanceId": {
      "type": "string"
    },
    "permanentLocationId": {
      "type": "string"
    },
    "temporaryLocationId": {
      "type": "string"
    },
    "electronicAccess": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uri": {
            "type": "string",
            "description": "uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources"
          },
          "linkText": {
            "type": "string",
            "description": "the value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated"
          },
          "materialsSpecification": {
            "type": "string",
            "description": "materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
          },
          "publicNote": {
            "type": "string",
            "description": "URL public note to be displayed in the discovery"
          },
          "relationshipId": {
            "type": "string",
            "description": "relationship between the electronic resource at the location identified and the item described in the record as a whole"
          }
        },
        "additionalProperties": false,
        "required": [
          "uri"
        ]
      }
    },
    "callNumberTypeId": {
      "type": "string",
      "description": "unique ID for the type of call number on a holdings record, a UUID" 
    },
    "callNumberPrefix": {
      "type": "string"
    },
    "callNumber": {
      "type": "string"
    },
    "callNumberSuffix": {
      "type": "string"
    },
    "shelvingTitle": {
      "type": "string"
    },
    "acquisitionFormat": {
      "type": "string"
    },
    "acquisitionMethod": {
      "type": "string"
    },
    "receiptStatus": {
      "type": "string"
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "holdingsNoteTypeId": {
            "type": "string"
          },
          "note": {
            "type": "string"
          },
          "staffOnly": {
            "type": "boolean",
            "default": false
          }
        }
      }
    },
    "illPolicyId": {
      "type": "string",
      "description": "unique ID for an ILL policy, a UUID"
    },
    "retentionPolicy": {
      "type": "string"
    },
    "digitizationPolicy": {
      "type": "string"
    },
    "holdingsStatements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "statement": {
            "type": "string",
            "description": "Textual description of the holdings"
          },
          "note": {
            "type": "string",
            "description": "Note attached to a holdings statement"
          }
        }
      }
    },
    "holdingsStatementsForIndexes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "statement": {
            "type": "string",
            "description": "Textual description of the holdings of indexes"
          },
          "note": {
            "type": "string",
            "description": "Note attached to a holdings statement"
          }
        }
      }
    },
    "holdingsStatementsForSupplements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "statement": {
            "type": "string",
            "description": "textual description of the holdings of supplementary material"
          },
          "note": {
            "type": "string",
            "description": "note attached to a holdings statement"
          }
        }
      }
    },
    "copyNumber": {
      "type": "string"
    },
    "numberOfItems": {
      "type": "string"
    },
    "receivingHistory": {
      "type": "object",
      "properties": {
        "displayType": {
          "type": "string",
          "description": "Display hint. 1: Display fields separately. 2: Display fields concatenated"
        },
        "entries": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "publicDisplay": {
                "type": "boolean"
              },
              "enumeration": {
                "type": "string"
              },
              "chronology": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "discoverySuppress": {
      "type": "boolean",
      "description": "records the fact that the record should not be displayed in a discovery system"
    },
    "statisticalCodeIds": {
      "type": "array",
      "description": "List of statistical code IDs",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "holdingsItems": {
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "item.json"
      },
      "readonly": true,
      "folio:isVirtual": true,
      "folio:linkBase": "inventory/items",
      "folio:linkFromField": "id",
      "folio:linkToField": "holdingsRecordId",
      "folio:includedElement": "items"
    },
    "holdingsInstance": {
      "type": "object",
      "folio:$ref": "instance.json",
      "readonly": true,
      "folio:isVirtual": true,
      "folio:linkBase": "inventory/instances",
      "folio:linkFromField": "instanceId",
      "folio:linkToField": "id",
      "folio:includedElement": "instances.0"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "instanceId"
  ]
}

Example:

{
  "id": "65cb2bf0-d4c2-4886-8ad0-b76f1ba75d61",
  "instanceId": "cd28da0f-a3e4-465c-82f1-acade4e8e170",
  "permanentLocationId": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "holdingsStatements": [
    {
      "statement": "Line 1",
      "note": "Note to line 1"
    },
    {
      "statement": "Line 2",
      "note": "Note to line2"
    }
  ]
}

Response 201

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

Headers

Location: required (string)
URI to the created holding item

Body

Media type: application/json

Type: any

Example:

{
  "id": "65cb2bf0-d4c2-4886-8ad0-b76f1ba75d61",
  "instanceId": "cd28da0f-a3e4-465c-82f1-acade4e8e170",
  "permanentLocationId": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "holdingsStatements": [
    {
      "statement": "Line 1",
      "note": "Note to line 1"
    },
    {
      "statement": "Line 2",
      "note": "Note to line2"
    }
  ]
}

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

Response 401

Not authorized to perform requested action

Body

Media type: text/plain

Type: any

Example:

unable to create holdings -- unauthorized

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

DELETE /holdings-storage/holdings

DELETE /holdings-storage/holdings

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

Response 204

All holdings deleted

Response 500

Internal server error, e.g. due to misconfiguration

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator

GET /holdings-storage/holdings/{holdingsRecordId}

Retrieve holding item with given {holdingId}

GET /holdings-storage/holdings/{holdingsRecordId}

URI Parameters

holdingsRecordId: required (string)

Query Parameters

lang: (string - default: en - pattern: [a-zA-Z]{2})
Requested language. Optional. [lang=en]

Response 200

Get Holdings Record by holdingsRecordId

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A holdings record",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "the system assigned unique ID of the holdings record; UUID"
    },
    "hrid": {
      "type": "string",
      "description": "the human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
    },
    "holdingsTypeId": {
      "type": "string",
      "description": "unique ID for the type of this holdings record, a UUID"
    },
    "formerIds": {
      "type": "array",
      "description": "Previous ID(s) assigned to the holdings record",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "instanceId": {
      "type": "string"
    },
    "permanentLocationId": {
      "type": "string"
    },
    "temporaryLocationId": {
      "type": "string"
    },
    "electronicAccess": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uri": {
            "type": "string",
            "description": "uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources"
          },
          "linkText": {
            "type": "string",
            "description": "the value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated"
          },
          "materialsSpecification": {
            "type": "string",
            "description": "materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
          },
          "publicNote": {
            "type": "string",
            "description": "URL public note to be displayed in the discovery"
          },
          "relationshipId": {
            "type": "string",
            "description": "relationship between the electronic resource at the location identified and the item described in the record as a whole"
          }
        },
        "additionalProperties": false,
        "required": [
          "uri"
        ]
      }
    },
    "callNumberTypeId": {
      "type": "string",
      "description": "unique ID for the type of call number on a holdings record, a UUID" 
    },
    "callNumberPrefix": {
      "type": "string"
    },
    "callNumber": {
      "type": "string"
    },
    "callNumberSuffix": {
      "type": "string"
    },
    "shelvingTitle": {
      "type": "string"
    },
    "acquisitionFormat": {
      "type": "string"
    },
    "acquisitionMethod": {
      "type": "string"
    },
    "receiptStatus": {
      "type": "string"
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "holdingsNoteTypeId": {
            "type": "string"
          },
          "note": {
            "type": "string"
          },
          "staffOnly": {
            "type": "boolean",
            "default": false
          }
        }
      }
    },
    "illPolicyId": {
      "type": "string",
      "description": "unique ID for an ILL policy, a UUID"
    },
    "retentionPolicy": {
      "type": "string"
    },
    "digitizationPolicy": {
      "type": "string"
    },
    "holdingsStatements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "statement": {
            "type": "string",
            "description": "Textual description of the holdings"
          },
          "note": {
            "type": "string",
            "description": "Note attached to a holdings statement"
          }
        }
      }
    },
    "holdingsStatementsForIndexes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "statement": {
            "type": "string",
            "description": "Textual description of the holdings of indexes"
          },
          "note": {
            "type": "string",
            "description": "Note attached to a holdings statement"
          }
        }
      }
    },
    "holdingsStatementsForSupplements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "statement": {
            "type": "string",
            "description": "textual description of the holdings of supplementary material"
          },
          "note": {
            "type": "string",
            "description": "note attached to a holdings statement"
          }
        }
      }
    },
    "copyNumber": {
      "type": "string"
    },
    "numberOfItems": {
      "type": "string"
    },
    "receivingHistory": {
      "type": "object",
      "properties": {
        "displayType": {
          "type": "string",
          "description": "Display hint. 1: Display fields separately. 2: Display fields concatenated"
        },
        "entries": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "publicDisplay": {
                "type": "boolean"
              },
              "enumeration": {
                "type": "string"
              },
              "chronology": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "discoverySuppress": {
      "type": "boolean",
      "description": "records the fact that the record should not be displayed in a discovery system"
    },
    "statisticalCodeIds": {
      "type": "array",
      "description": "List of statistical code IDs",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "holdingsItems": {
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "item.json"
      },
      "readonly": true,
      "folio:isVirtual": true,
      "folio:linkBase": "inventory/items",
      "folio:linkFromField": "id",
      "folio:linkToField": "holdingsRecordId",
      "folio:includedElement": "items"
    },
    "holdingsInstance": {
      "type": "object",
      "folio:$ref": "instance.json",
      "readonly": true,
      "folio:isVirtual": true,
      "folio:linkBase": "inventory/instances",
      "folio:linkFromField": "instanceId",
      "folio:linkToField": "id",
      "folio:includedElement": "instances.0"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "instanceId"
  ]
}

Example:

{
  "id": "65cb2bf0-d4c2-4886-8ad0-b76f1ba75d61",
  "instanceId": "cd28da0f-a3e4-465c-82f1-acade4e8e170",
  "permanentLocationId": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "holdingsStatements": [
    {
      "statement": "Line 1",
      "note": "Note to line 1"
    },
    {
      "statement": "Line 2",
      "note": "Note to line2"
    }
  ]
}

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"holding 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 /holdings-storage/holdings/{holdingsRecordId}

Delete holding item with given {holdingId}

DELETE /holdings-storage/holdings/{holdingsRecordId}

URI Parameters

holdingsRecordId: 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 holding -- constraint violation"

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

"holding 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 /holdings-storage/holdings/{holdingsRecordId}

Update holding item with given {holdingId}

PUT /holdings-storage/holdings/{holdingsRecordId}

URI Parameters

holdingsRecordId: 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": "A holdings record",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "the system assigned unique ID of the holdings record; UUID"
    },
    "hrid": {
      "type": "string",
      "description": "the human readable ID, also called eye readable ID. A system-assigned sequential ID which maps to the Instance ID"
    },
    "holdingsTypeId": {
      "type": "string",
      "description": "unique ID for the type of this holdings record, a UUID"
    },
    "formerIds": {
      "type": "array",
      "description": "Previous ID(s) assigned to the holdings record",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "instanceId": {
      "type": "string"
    },
    "permanentLocationId": {
      "type": "string"
    },
    "temporaryLocationId": {
      "type": "string"
    },
    "electronicAccess": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "uri": {
            "type": "string",
            "description": "uniform resource identifier (URI) is a string of characters designed for unambiguous identification of resources"
          },
          "linkText": {
            "type": "string",
            "description": "the value of the MARC tag field 856 2nd indicator, where the values are: no information provided, resource, version of resource, related resource, no display constant generated"
          },
          "materialsSpecification": {
            "type": "string",
            "description": "materials specified is used to specify to what portion or aspect of the resource the electronic location and access information applies (e.g. a portion or subset of the item is electronic, or a related electronic resource is being linked to the record)"
          },
          "publicNote": {
            "type": "string",
            "description": "URL public note to be displayed in the discovery"
          },
          "relationshipId": {
            "type": "string",
            "description": "relationship between the electronic resource at the location identified and the item described in the record as a whole"
          }
        },
        "additionalProperties": false,
        "required": [
          "uri"
        ]
      }
    },
    "callNumberTypeId": {
      "type": "string",
      "description": "unique ID for the type of call number on a holdings record, a UUID" 
    },
    "callNumberPrefix": {
      "type": "string"
    },
    "callNumber": {
      "type": "string"
    },
    "callNumberSuffix": {
      "type": "string"
    },
    "shelvingTitle": {
      "type": "string"
    },
    "acquisitionFormat": {
      "type": "string"
    },
    "acquisitionMethod": {
      "type": "string"
    },
    "receiptStatus": {
      "type": "string"
    },
    "notes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "holdingsNoteTypeId": {
            "type": "string"
          },
          "note": {
            "type": "string"
          },
          "staffOnly": {
            "type": "boolean",
            "default": false
          }
        }
      }
    },
    "illPolicyId": {
      "type": "string",
      "description": "unique ID for an ILL policy, a UUID"
    },
    "retentionPolicy": {
      "type": "string"
    },
    "digitizationPolicy": {
      "type": "string"
    },
    "holdingsStatements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "statement": {
            "type": "string",
            "description": "Textual description of the holdings"
          },
          "note": {
            "type": "string",
            "description": "Note attached to a holdings statement"
          }
        }
      }
    },
    "holdingsStatementsForIndexes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "statement": {
            "type": "string",
            "description": "Textual description of the holdings of indexes"
          },
          "note": {
            "type": "string",
            "description": "Note attached to a holdings statement"
          }
        }
      }
    },
    "holdingsStatementsForSupplements": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "statement": {
            "type": "string",
            "description": "textual description of the holdings of supplementary material"
          },
          "note": {
            "type": "string",
            "description": "note attached to a holdings statement"
          }
        }
      }
    },
    "copyNumber": {
      "type": "string"
    },
    "numberOfItems": {
      "type": "string"
    },
    "receivingHistory": {
      "type": "object",
      "properties": {
        "displayType": {
          "type": "string",
          "description": "Display hint. 1: Display fields separately. 2: Display fields concatenated"
        },
        "entries": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "publicDisplay": {
                "type": "boolean"
              },
              "enumeration": {
                "type": "string"
              },
              "chronology": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "discoverySuppress": {
      "type": "boolean",
      "description": "records the fact that the record should not be displayed in a discovery system"
    },
    "statisticalCodeIds": {
      "type": "array",
      "description": "List of statistical code IDs",
      "items": {
        "type": "string"
      },
      "uniqueItems": true
    },
    "holdingsItems": {
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "item.json"
      },
      "readonly": true,
      "folio:isVirtual": true,
      "folio:linkBase": "inventory/items",
      "folio:linkFromField": "id",
      "folio:linkToField": "holdingsRecordId",
      "folio:includedElement": "items"
    },
    "holdingsInstance": {
      "type": "object",
      "folio:$ref": "instance.json",
      "readonly": true,
      "folio:isVirtual": true,
      "folio:linkBase": "inventory/instances",
      "folio:linkFromField": "instanceId",
      "folio:linkToField": "id",
      "folio:includedElement": "instances.0"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "additionalProperties": false,
  "required": [
    "instanceId"
  ]
}

Example:

{
  "id": "65cb2bf0-d4c2-4886-8ad0-b76f1ba75d61",
  "instanceId": "cd28da0f-a3e4-465c-82f1-acade4e8e170",
  "permanentLocationId": "d9cd0bed-1b49-4b5e-a7bd-064b8d177231",
  "holdingsStatements": [
    {
      "statement": "Line 1",
      "note": "Note to line 1"
    },
    {
      "statement": "Line 2",
      "note": "Note to line2"
    }
  ]
}

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

Response 404

Item with a given ID not found

Body

Media type: text/plain

Type: any

Example:

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

Holdings Storage (v3.0)

Table of contents

Holdings Records Storage API

/holdings-storage

GET /holdings-storage/holdings

Query Parameters

Response 200

Response 400

Response 401

Response 500

POST /holdings-storage/holdings

Query Parameters

Response 201

Headers

Response 400

Response 401

Response 500

DELETE /holdings-storage/holdings

Query Parameters

Response 204

Response 500

GET /holdings-storage/holdings/{holdingsRecordId}

URI Parameters

Query Parameters

Response 200

Response 404

Response 500

DELETE /holdings-storage/holdings/{holdingsRecordId}

URI Parameters

Query Parameters

Response 204

Response 400

Response 404

Response 500

PUT /holdings-storage/holdings/{holdingsRecordId}

URI Parameters

Query Parameters

Response 204

Response 400

Response 404

Response 500