foliolib.folio.api.inventoryStorage.InstanceStatus

class foliolib.folio.api.inventoryStorage.InstanceStatus(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

Instance status reference API

This documents the API calls that can be made to query and manage instance statuses of the system

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

`delete_instanceStatus`(instanceStatusId)	Delete instanceStatus item with given {instanceStatusId}
`delete_instanceStatuses`()	`DELETE /instance-statuses`
`get_instanceStatus`(instanceStatusId)	Retrieve instanceStatus item with given {instanceStatusId}
`get_instanceStatuses`(**kwargs)	Return a list of instances statuses
`modify_instanceStatus`(instanceStatusId, ...)	Update instanceStatus item with given {instanceStatusId}
`set_instanceStatus`(instanceStatus)	Create a new instance status

delete_instanceStatus(instanceStatusId: str)

Delete instanceStatus item with given {instanceStatusId}

DELETE /instance-statuses/{instanceStatusId}

Parameters

instanceStatusId (str) –

Raises

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

delete_instanceStatuses(): DELETE /instance-statuses

get_instanceStatus(instanceStatusId: str)

Retrieve instanceStatus item with given {instanceStatusId}

GET /instance-statuses/{instanceStatusId}

Parameters

instanceStatusId (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Cataloging status for Instance records",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "code": {
      "description": "distinct code for an instance status",
      "type": "string"
    },
    "name": {
      "description": "label for the instance status",
      "type": "string"
    },
    "source": {
      "description": "origin of an instance status record",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "code",
    "name",
    "source"
  ]
}

get_instanceStatuses(**kwargs)

Return a list of instances statuses

GET /instance-statuses

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
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
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "A collection of instance statuses (controlled vocabulary)",
  "type": "object",
  "properties": {
    "instanceStatuses": {
      "description": "List of instance statuses",
      "id": "instanceStatus",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "instancestatus.json"
      }
    },
    "totalRecords": {
      "description": "Estimated or exact total number of records",
      "type": "integer"
    }
  },
  "required": [
    "instanceStatuses",
    "totalRecords"
  ]
}

modify_instanceStatus(instanceStatusId: str, instanceStatus: dict)

Update instanceStatus item with given {instanceStatusId}

PUT /instance-statuses/{instanceStatusId}

Parameters

instanceStatusId (str) –
instanceStatus (dict) – See Schema below

Raises

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

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Cataloging status for Instance records",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "code": {
      "description": "distinct code for an instance status",
      "type": "string"
    },
    "name": {
      "description": "label for the instance status",
      "type": "string"
    },
    "source": {
      "description": "origin of an instance status record",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "code",
    "name",
    "source"
  ]
}

set_instanceStatus(instanceStatus: dict)

Create a new instance status

POST /instance-statuses

Parameters

instanceStatus (dict) – See Schema below

Raises

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

Headers

Location - URI to the created instanceStatus item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Cataloging status for Instance records",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "code": {
      "description": "distinct code for an instance status",
      "type": "string"
    },
    "name": {
      "description": "label for the instance status",
      "type": "string"
    },
    "source": {
      "description": "origin of an instance status record",
      "type": "string"
    },
    "metadata": {
      "type": "object",
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "code",
    "name",
    "source"
  ]
}