foliolib.folio.api.ordersStorage.ReportingCode

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

Bases: foliolib.folio.FolioApi

Reporting Code

CRUD APIs used to manage reporting codes.

Parameters

  • tenant (str) – Tenant id

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

Methods

delete_reportingCode(reportingCodesId)

Delete reportingCode item with given {reportingCodeId}

get_reportingCode(reportingCodesId)

Retrieve reportingCode item with given {reportingCodeId}

get_reportingCodes(**kwargs)

Get list of reporting Codes

modify_reportingCode(reportingCodesId, ...)

Update reportingCode item with given {reportingCodeId}

set_reportingCode(reportingCode)

Create a new reportingCode item.
delete_reportingCode(reportingCodesId: str)

Delete reportingCode item with given {reportingCodeId}

DELETE /orders-storage/reporting-codes/{reportingCodesId}

Parameters

reportingCodesId (str) –

Raises

  • OkapiRequestNotFound – Not Found

  • OkapiRequestError – Bad Request

  • OkapiFatalError – Server Error

get_reportingCode(reportingCodesId: str)

Retrieve reportingCode item with given {reportingCodeId}

GET /orders-storage/reporting-codes/{reportingCodesId}

Parameters

reportingCodesId (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": "purchase order line reporting code",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this reporting code record",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "code": {
      "description": "a reporting code",
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{4}[a-zA-Z0-9]*$"
    },
    "description": {
      "description": "description of this reporting code",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "code"
  ]
}
get_reportingCodes(**kwargs)

Get list of reporting Codes

GET /orders-storage/reporting-codes

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: for example code

    Example

    • (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode

    • [“code”, “MEDGRANT”, “=”]

  • 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

  • OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "collection of reporting code records",
  "type": "object",
  "properties": {
    "reportingCodes": {
      "description": "collection of reporting code records",
      "type": "array",
      "id": "reportingCodes",
      "items": {
        "type": "object",
        "$ref": "reporting_code.json"
      }
    },
    "totalRecords": {
      "description": "The number of objects contained in this collection",
      "type": "integer"
    }
  },
  "additionalProperties": false,
  "required": [
    "reportingCodes",
    "totalRecords"
  ]
}
modify_reportingCode(reportingCodesId: str, reportingCode: dict)

Update reportingCode item with given {reportingCodeId}

PUT /orders-storage/reporting-codes/{reportingCodesId}

Parameters

  • reportingCodesId (str) –

  • reportingCode (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": "purchase order line reporting code",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this reporting code record",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "code": {
      "description": "a reporting code",
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{4}[a-zA-Z0-9]*$"
    },
    "description": {
      "description": "description of this reporting code",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "code"
  ]
}
set_reportingCode(reportingCode: dict)

Create a new reportingCode item.

POST /orders-storage/reporting-codes

Parameters

reportingCode (dict) – See Schema below

Raises

  • OkapiRequestError – Bad Request

  • OkapiRequestUnauthorized – Authentication is required

  • OkapiFatalError – Server Error

Headers

  • Location - URI to the created reportingCode item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "purchase order line reporting code",
  "type": "object",
  "properties": {
    "id": {
      "description": "UUID of this reporting code record",
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
    },
    "code": {
      "description": "a reporting code",
      "type": "string",
      "pattern": "^[a-zA-Z0-9]{4}[a-zA-Z0-9]*$"
    },
    "description": {
      "description": "description of this reporting code",
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "code"
  ]
}