foliolib.folio.api.inventoryStorage.ShelfLocation

class foliolib.folio.api.inventoryStorage.ShelfLocation(tenant: str)

Bases: foliolib.folio.FolioApi

DEPRECATED Shelf Locations API (forth-level location unit)

DEPRECATED - Can report the name and id of a (shelf) location, the forth-level location unit. This is a read-only proxy to the new locations interface at /locations that should be used instead.

Base class of the Folio API

Parameters: tenant (str) – Tenant id

Methods

`delete_shelfLocation`(shelfLocationsId)	Delete shelfLocation item with given {shelfLocationId}
`delete_shelfLocations`()	`DELETE /shelf-locations`
`get_shelfLocation`(shelfLocationsId)	Retrieve shelfLocation item with given {shelfLocationId}
`get_shelfLocations`(**kwargs)	DEPRECATED - return a list of (shelf) locations, the forth-level location unit.
`modify_shelfLocation`(shelfLocationsId, ...)	Update shelfLocation item with given {shelfLocationId}
`set_shelfLocation`(shelfLocation)	DEPRECATED and NOT IMPLEMENTED - Create a new shelf location

delete_shelfLocation(shelfLocationsId: str)

Delete shelfLocation item with given {shelfLocationId}

DELETE /shelf-locations/{shelfLocationsId}

Parameters

shelfLocationsId (str) –

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiRequestFatalError – Server Error
OkapiRequestFatalError – Server Error

delete_shelfLocations(): DELETE /shelf-locations

get_shelfLocation(shelfLocationsId: str)

Retrieve shelfLocation item with given {shelfLocationId}

GET /shelf-locations/{shelfLocationsId}

Parameters

shelfLocationsId (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiRequestFatalError – Server Error
OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "DEPRECATED: The name and id of a (shelf) location, the forth-level location unit. This is a read-only proxy to the new locations interface at /locations that should be used instead.",
  "properties": {
    "id": {
      "description": "UUID of the (shelf) location",
      "type": "string"
    },
    "name": {
      "description": "Name of the (shelf) location",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

get_shelfLocations(**kwargs)

DEPRECATED - return a list of (shelf) locations, the forth-level location unit. This is a read-only proxy to the new locations interface at /locations that should be used instead.

GET /shelf-locations

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://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

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- name=aaa
totalRecords (str) –
(default=auto) How to calculate the totalRecords property. “exact” for the correct number, “estimated” for an estimation, “auto” to automatically select “exact” or “estimated”, “none” for suppressing the totalRecords property. For details see https://github.com/folio-org/raml-module-builder#estimated-totalrecords

Example
- none
offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "DEPRECATED: A collection of (shelf) locations, the forth-level location unit. This is a read-only proxy to the new locations interface at /locations that should be used instead.",
  "properties": {
    "shelflocations": {
      "id": "shelflocations",
      "description": "DEPRECATED: List of (shelf) locations, the forth-level location unit. This is a read-only proxy to the new locations interface at /locations that should be used instead.",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "shelflocation.json"
      }
    },
    "totalRecords": {
      "description": "Estimated or exact total number of records",
      "type": "integer"
    }
  },
  "required": [
    "shelflocations",
    "totalRecords"
  ]
}

modify_shelfLocation(shelfLocationsId: str, shelfLocation: dict)

Update shelfLocation item with given {shelfLocationId}

PUT /shelf-locations/{shelfLocationsId}

Parameters

shelfLocationsId (str) –
shelfLocation (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiRequestConflict – Conflict
OkapiRequestFatalError – Server Error
OkapiRequestFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "DEPRECATED: The name and id of a (shelf) location, the forth-level location unit. This is a read-only proxy to the new locations interface at /locations that should be used instead.",
  "properties": {
    "id": {
      "description": "UUID of the (shelf) location",
      "type": "string"
    },
    "name": {
      "description": "Name of the (shelf) location",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}

set_shelfLocation(shelfLocation: dict)

DEPRECATED and NOT IMPLEMENTED - Create a new shelf location

POST /shelf-locations

Parameters

shelfLocation (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiRequestFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

Location - URI to the created shelfLocation item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "DEPRECATED: The name and id of a (shelf) location, the forth-level location unit. This is a read-only proxy to the new locations interface at /locations that should be used instead.",
  "properties": {
    "id": {
      "description": "UUID of the (shelf) location",
      "type": "string"
    },
    "name": {
      "description": "Name of the (shelf) location",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "name"
  ]
}