foliolib.folio.api.gobi.GobiMappings

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

Bases: foliolib.folio.FolioApi

GOBI® (Global Online Bibliographic Information) Integration

GOBI® (Global Online Bibliographic Information) is the leading web-based

acquisitions tool for finding, ordering and managing e-books and print books for libraries. This module allows GOBI initiated orders to be fulfilled by FOLIO.

Parameters

• tenant (str) – Tenant id

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

Methods

get_fields()	Get list of Folio fields
get_translators()	Get list of Gobi fields to Folio fields translators
get_types()	Get list of types of the GOBI order

get_fields()

Get list of Folio fields

GET /gobi/orders/mappings/fields

Returns

See Schema below

Return type

dict

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of pairs field name and path in the JSON",
  "type": "object",
  "properties": {
    "fields": {
      "description": "An array of pairs field name and path in the JSON",
      "id": "fields",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "field.json"
      }
    },
    "totalRecords": {
      "description": "total number of records in the array",
      "type": "integer"
    }
  },
  "required": [
    "fields",
    "totalRecords"
  ]
}

get_translators()

Get list of Gobi fields to Folio fields translators

GET /gobi/orders/mappings/translators

Returns

See Schema below

Return type

dict

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Collection of pairs translator Java method name and name of translator",
  "type": "object",
  "properties": {
    "translators": {
      "description": "An array of pairs translator Java method name and name of translator",
      "id": "translators",
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "translator.json"
      }
    },
    "totalRecords": {
      "description": "total number of records in the array",
      "type": "integer"
    }
  },
  "required": [
    "translators",
    "totalRecords"
  ]
}

get_types()

Get list of types of the GOBI order

GET /gobi/orders/mappings/types

Returns

See Schema below

Return type

dict

Schema

string