Inventory API (v1)

Inventory API

instances

Retrieve inventory instance by id from folio mod-inventory

path Parameters

instanceId

required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...

Inventory Instance's UUID

query Parameters

lang	string[a-zA-Z]{2} Default: "en" Example: lang=en Requested language

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
404
500

Content type

application/json

"string"

authorities

Retrieve authority by id from folio mod-entities-links

path Parameters

authorityId

required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...

Authority's UUID

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
404
500

Content type

application/json

"string"

holdings

Return a list of holdings associated with the keyword query from folio mod-inventory

Return a list of holdings by query

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

identifierTypes

Retrieve invetory instance identifier types by query

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
500

Content type

application/json

"string"

locations

Retrieve collection of location items.

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

Retrieve location information by id.

path Parameters

locationId

required

string

Location id

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
404
500

Content type

application/json

"string"

Retrieve institution information by id.

path Parameters

institutionId

required

string

Location institution id

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
404
500

Content type

application/json

"string"

Retrieve library information by id.

path Parameters

libraryId

required

string

Location library id

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
404
500

Content type

application/json

"string"

Retrieve campus information by id.

path Parameters

campusId

required

string

Library campus id

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
404
500

Content type

application/json

"string"

servicePoints

Retrieve collection of service points.

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

natureOfContentTerms

Return a list of nature-of-content terms

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

modesOfIssuance

Return a list of modes of issuance

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

instanceFormats

Return a list of instance formats

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

items

Retrieve collection of items.

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

instanceTypes

Retrieve collection of instance types.

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

inventoryViewInstances

Retrieve collection of inventory-view instances.

query Parameters

	object (RequestQueryParameters) Request query parameters(query, limit, offset and etc.) as object.
withBoundedItems	boolean Default: false Retrieve bounded items when value is true

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

alternativeTitleTypes

Retrieve collection of alternative-title-type items.

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

library

sourceRecords

Retrieve source records by id from folio mod-source-record-storage

path Parameters

instanceId

required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...

Inventory Instance's UUID

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
404
500

Content type

application/json

"string"

authoritySourceRecords

Retrieve authority source records by id from folio mod-source-record-storage

path Parameters

authorityId

required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...

Authority's UUID

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
404
500

Content type

application/json

"string"

subjectSources

Retrieve collection of subject sources.

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

subjectTypes

Retrieve collection of subject types.

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

Retrieve inventory instances associated with the keyword query from folio mod-inventory

Retrieve inventory instances associated with the keyword query

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
500

Content type

application/json

"string"

Retrieve authorities associated with the keyword query from folio mod-entities-links

Retrieve authorities associated with the keyword query

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
500

Content type

application/json

"string"

downloadAuthorityById

Download single authority record by id in specified format

path Parameters

authorityId

required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...

Authority's UUID

query Parameters

utf	boolean Default: true Specify whether to encode the file in UTF-8.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

404
500

Content type

application/json

{"code": 404,
"errorMessage": "Record by given id not found"
}

downloadInstanceById

Download single instance record by id in specified format

path Parameters

instanceId

required

string^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...

Inventory Instance's UUID

query Parameters

utf	boolean Default: true Specify whether to encode the file in UTF-8.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

404
500

Content type

application/json

{"code": 404,
"errorMessage": "Record by given id not found"
}

classificationTypes

Retrieve inventory instance classification types by query

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
500

Content type

application/json

"string"

contributorTypes

Retrieve inventory contributor types by query

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
500

Content type

application/json

"string"

contributorNameTypes

Retrieve inventory contributor name types by query

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
500

Content type

application/json

"string"

instanceNoteTypes

Retrieve collection of instance note types

Retrieve collection of instance note types.

query Parameters

object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
400
401
500

Content type

application/json

"string"

materialTypes

Retrieve material type information by id.

path Parameters

materialTypeId

required

string

Material type id

header Parameters

x-okapi-tenant	string x-okapi-tenant header value
x-okapi-token	string x-okapi-token header value

Responses

Response samples

200
404
500

Content type

application/json

"string"