foliolib.folio.api.circulationStorage.FixedDueDateSchedule

class foliolib.folio.api.circulationStorage.FixedDueDateSchedule(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

Fixed Due Date Schedule Storage API

Storage for fixed due date schedules

Parameters

• tenant (str) – Tenant id

• okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

delete_fixedDueDateSchedule(...)	Delete fixedDueDateSchedule item with given {fixedDueDateScheduleId}
delete_fixedDueDateSchedules()	DELETE /fixed-due-date-schedule-storage/fixed-due-date-schedules
get_fixedDueDateSchedule(fixedDueDateScheduleId)	Retrieve fixedDueDateSchedule item with given {fixedDueDateScheduleId}
get_fixedDueDateSchedules(**kwargs)	Retrieve a list of fixedDueDateSchedule items.
modify_fixedDueDateSchedule(...)	Update fixedDueDateSchedule item with given {fixedDueDateScheduleId}
set_fixedDueDateSchedule(fixedDueDateSchedule)	Create a new fixedDueDateSchedule item.

delete_fixedDueDateSchedule(fixedDueDateScheduleId: str)

Delete fixedDueDateSchedule item with given {fixedDueDateScheduleId}

DELETE /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}

Parameters

fixedDueDateScheduleId (str) –

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiFatalError – Server Error

• OkapiFatalError – Server Error

delete_fixedDueDateSchedules()

DELETE /fixed-due-date-schedule-storage/fixed-due-date-schedules

get_fixedDueDateSchedule(fixedDueDateScheduleId: str)

Retrieve fixedDueDateSchedule item with given {fixedDueDateScheduleId}

GET /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}

Parameters

fixedDueDateScheduleId (str) –

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestNotFound – Not Found

• OkapiFatalError – Server Error

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "A set of date ranges for materials checkout and their associated due dates.",
  "properties": {
    "id": {
      "description": "Unique ID (generated UUID)",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "schedules": {
      "id": "schedules",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "schedule.json"
      }
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

get_fixedDueDateSchedules(**kwargs)

Retrieve a list of fixedDueDateSchedule items.

GET /fixed-due-date-schedule-storage/fixed-due-date-schedules

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

• 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

• 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=semester

Returns

See Schema below

Return type

dict

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of fixedDueDateSchedules",
  "type": "object",
  "properties": {
    "fixedDueDateSchedules": {
      "description": "List of items",
      "id": "fixedDueDateSchedules",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "fixed-due-date-schedule.json"
      }
    },
    "totalRecords": {
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "fixedDueDateSchedules",
    "totalRecords"
  ]
}

modify_fixedDueDateSchedule(fixedDueDateScheduleId: str, fixedDueDateSchedule: dict)

Update fixedDueDateSchedule item with given {fixedDueDateScheduleId}

PUT /fixed-due-date-schedule-storage/fixed-due-date-schedules/{fixedDueDateScheduleId}

Parameters

• fixedDueDateScheduleId (str) –

• fixedDueDateSchedule (dict) – See Schema below

Raises

• OkapiRequestNotFound – Not Found

• OkapiRequestError – Bad Request

• OkapiRequestConflict – Conflict

• OkapiFatalError – Server Error

• OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "A set of date ranges for materials checkout and their associated due dates.",
  "properties": {
    "id": {
      "description": "Unique ID (generated UUID)",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "schedules": {
      "id": "schedules",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "schedule.json"
      }
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

set_fixedDueDateSchedule(fixedDueDateSchedule: dict)

Create a new fixedDueDateSchedule item.

POST /fixed-due-date-schedule-storage/fixed-due-date-schedules

Parameters

fixedDueDateSchedule (dict) – See Schema below

Raises

• OkapiRequestError – Bad Request

• OkapiRequestUnauthorized – Authentication is required

• OkapiFatalError – Server Error

• OkapiFatalError – Server Error

• OkapiRequestUnprocessableEntity – Unprocessable Entity

Headers

• Location - URI to the created fixedDueDateSchedule item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "description": "A set of date ranges for materials checkout and their associated due dates.",
  "properties": {
    "id": {
      "description": "Unique ID (generated UUID)",
      "type": "string",
      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "schedules": {
      "id": "schedules",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "schedule.json"
      }
    },
    "metadata": {
      "$ref": "raml-util/schemas/metadata.schema",
      "readonly": true
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}