foliolib.folio.api.innReach.Settings
- class foliolib.folio.api.innReach.Settings(tenant: str)
Bases:
foliolib.folio.FolioApiINN-Reach Settings API
Base class of the Folio API
- Parameters
tenant (str) – Tenant id
Methods
Authenticate InnReach local server key/secret pair
createconfiguration(centralServerId, ...)Add new Visible Patron Field Configuration associated with the central server
Add new item contribution options configuration associated with the central server
Add new MARC Transformation Options Settings associated with the central server
Add new User Custom Field Mapping associated with the central server
deletecentralserver(centralServerId)Delete central server
deletecriteria(centralServerId)Delete Contribution Criteria Configuration
deletelocation(locationId)Delete InnReach location
Delete Marc Transformation Options Settings
deletematerialtypemapping(centralServerId, id_)Delete material type mapping
getagencymappingsbyserverid(centralServerId)Get a list of Inn-Reach Agency to FOLIO location mappings for the given central server
getallmarctransformationoptionssettings(**kwargs)Get a list of Marc Transformation Options Settings
Get list of Paging Slip Templates
Get a list of Central Patron Type Mappings
getcentralserverbyid(centralServerId)Get central server by id
getcentralserverrecalluser(centralServerId)Get Inn-Reach Central server recall user
getcentralservers(**kwargs)Get a list of central servers
Get Visible Patron Field Configuration by Central Server id
getcriteriabyserverid(centralServerId)Get Contribution Criteria by Central Server id
Get Item Contribution Options Configuration by id
Get a list of Item Type Mappings
Get a list of library to Inn-Reach location mappings for the given central server
getlocationbyid(locationId)Get InnReach location by id
Get a list of library location to Inn-Reach location mappings for the given central server
Get a list of libraries locations to Inn-Reach location mappings for the given central server
getlocations(**kwargs)Get a list of InnReach locations
Get MARC Transformation Options Settings by id
getmaterialtypemappingbyid(centralServerId, id_)Get material type mapping by id
Get a list of material type mappings for the given central server
getpagingsliptemplate(centralServerId)Get Paging Slip Template
Get a list of Patron Type Mappings
getusercustomfieldmapping(centralServerId)Get a User Custom Field Mapping
postcentralserver(centralServerDTO)Add new central server
postcontributioncriteria(centralServerId, ...)Create new contribution criteria for Central Server
postinnreachlocation(innReachLocationDTO)Add new InnReach location
postmaterialtypemapping(centralServerId, ...)Add new material type mapping associated with the central server
putagencymappings(centralServerId, ...)Update (add) INN-Reach Agency to FOLIO location mappings associated with the central server
putlibrarymappings(centralServerId, ...)Update (replace) the entire collection of library to Inn-Reach location mappings associated with the central server
putlocationmappings(centralServerId, ...)Update (replace) the entire collection of library location to Inn-Reach location mappings associated with the central server
saveinnreachrecalluser(centralServerId, ...)Add new Inn-Reach recall user to central server
transformmarcrecord(centralServerId, ...)Transform MARC record by Id according to CentralServer settings
Update Central Patron Type Mappings
updatecentralserver(centralServerDTO, ...)Update central server
Update Inn-Reach Central server recall user
updateconfiguration(centralServerId, ...)Update Visible Patron Field Configuration
updatecriteria(centralServerId, ...)Update Contribution Criteria Configuration
Update Item Contribution Options Configuration
updateitemtypemappings(centralServerId, ...)Update Item Type Mappings
updatelocation(innReachLocationDTO, locationId)Update InnReach location
Update MARC Transformation Options Settings
updatematerialtypemapping(centralServerId, ...)Update material type mapping
updatematerialtypemappings(centralServerId, ...)Update (replace) the entire collection of material type mappings associated with the central server
updatepagingsliptemplate(centralServerId, ...)Update Paging Slip Template
updatepatrontypemappings(centralServerId, ...)Update Patron Type Mappings
Update User Custom Field Mapping
- authenticatelocalserverkeysecret(authenticationRequest)
Authenticate InnReach local server key/secret pair
POST /inn-reach/authentication- Parameters
authenticationRequest (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestUnauthorized – Unauthorized
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Authentication request", "type": "object", "properties": { "key": { "description": "key", "type": "string", "format": "UUID" }, "secret": { "description": "secret", "type": "string", "format": "UUID" } }, "additionalProperties": false, "required": [ "key", "secret" ] }
- createconfiguration(centralServerId, visiblePatronFieldConfigurationDTO)
Add new Visible Patron Field Configuration associated with the central server
POST /inn-reach/central-servers/{centralServerId}/visible-patron-field-configuration- Parameters
centralServerId (str) – (format: uuid)
visiblePatronFieldConfigurationDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Visible Patron Field Configuration", "type": "object", "properties": { "id": { "description": "Visible Patron Field Configuration id", "type": "string", "format": "UUID" }, "fields": { "description": "An array of Visible Patron Fields", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Visible Patron Field enum", "description": "Visible Patron Field enum", "type": "string", "additionalProperties": false, "enum": [ "BARCODE", "EXTERNAL_SYSTEM_ID", "FOLIO_RECORD_NUMBER", "USERNAME", "USER_CUSTOM_FIELDS" ] } }, "userCustomFields": { "description": "An array of User Custom Fields refIds", "type": "array", "items": { "type": "string" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- createitemcontributionoptionsconfiguration(centralServerId, itemContributionOptionsConfigurationDTO)
Add new item contribution options configuration associated with the central server
POST /inn-reach/central-servers/{centralServerId}/item-contribution-options- Parameters
centralServerId (str) – (format: uuid)
itemContributionOptionsConfigurationDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Item Contribution Options", "type": "object", "properties": { "id": { "description": "Item Contribution Options Configuration id", "type": "string", "format": "UUID" }, "notAvailableItemStatuses": { "description": "A list of FOLIO item states that should be considered \"Not available\"", "type": "array", "items": { "type": "string" } }, "nonLendableLoanTypes": { "description": "A list of FOLIO loan types that should be considered non-lendable", "type": "array", "items": { "type": "string", "format": "UUID" } }, "nonLendableLocations": { "description": "A list of FOLIO locations whose items should be considered non-lendable", "type": "array", "items": { "type": "string", "format": "UUID" } }, "nonLendableMaterialTypes": { "description": "A list of FOLIO material types that should be considered non-lendable", "type": "array", "items": { "type": "string", "format": "UUID" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- createmarctransformationoptionssettings(centralServerId, mARCTransformationOptionsSettingsDTO)
Add new MARC Transformation Options Settings associated with the central server
POST /inn-reach/central-servers/{centralServerId}/marc-transformation-options- Parameters
centralServerId (str) – (format: uuid)
mARCTransformationOptionsSettingsDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request
OkapiRequestFatalError – Internal server error
Schema
{ "description": "MARC Transformation Options Settings", "type": "object", "properties": { "id": { "description": "MARC Transformation Options Settings id", "type": "string", "format": "UUID" }, "configIsActive": { "description": "A Boolean indicating whether the configuration is active", "type": "boolean" }, "modifiedFieldsForContributedRecords": { "description": "An ordered array of field configurations", "type": "array", "items": { "description": "Field Configuration", "type": "object", "properties": { "id": { "description": "Field configuration id", "type": "string", "format": "UUID" }, "resourceIdentifierTypeId": { "description": "Resource identifier type id", "type": "string", "format": "UUID" }, "stripPrefix": { "description": "Strip prefix", "type": "boolean" }, "ignorePrefixes": { "description": "Array of strings that if present as prefixes will cause the identifier to be ignored", "type": "array", "items": { "type": "string" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false } }, "excludedMARCFields": { "description": "An array of MARC fields/subfields to exclude from transformed MARC records", "type": "array", "items": { "type": "string" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- createusercustomfieldmapping(centralServerId, userCustomFieldMappingDTO)
Add new User Custom Field Mapping associated with the central server
POST /inn-reach/central-servers/{centralServerId}/user-custom-field-mappings- Parameters
centralServerId (str) – (format: uuid)
userCustomFieldMappingDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "User custom field mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "customFieldId": { "description": "Custom field refId", "type": "string" }, "configuredOptions": { "type": "object", "description": "Map of the option ids for the custom field and local agency codes", "additionalProperties": { "type": "string", "properties": { "agencyCode": { "description": "Agency code", "type": "string", "maxLength": 5 }, "customFieldValue": { "description": "Custom field option id", "type": "string" } } } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "customFieldId", "configuredOptions" ] }
- deletecentralserver(centralServerId)
Delete central server
DELETE /inn-reach/central-servers/{centralServerId}- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
- deletecriteria(centralServerId)
Delete Contribution Criteria Configuration
DELETE /inn-reach/central-servers/{centralServerId}/contribution-criteria- Parameters
centralServerId (str) – (format: uuid)
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
- deletelocation(locationId)
Delete InnReach location
DELETE /inn-reach/locations/{locationId}- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
- deletemarctransformationoptionssettings(centralServerId)
Delete Marc Transformation Options Settings
DELETE /inn-reach/central-servers/{centralServerId}/marc-transformation-options- Parameters
centralServerId (str) – (format: uuid)
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
- deletematerialtypemapping(centralServerId, id_)
Delete material type mapping
DELETE /inn-reach/central-servers/{centralServerId}/material-type-mappings/{id}- Parameters
centralServerId (str) – (format: uuid)
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
- getagencymappingsbyserverid(centralServerId)
Get a list of Inn-Reach Agency to FOLIO location mappings for the given central server
GET /inn-reach/central-servers/{centralServerId}/agency-mappings- Parameters
centralServerId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request, e.g. malformed query parameter.
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "INN-Reach Agency to FOLIO locations mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "locationId": { "description": "Location id", "type": "string", "format": "uuid" }, "libraryId": { "description": "Location id", "type": "string", "format": "uuid" }, "localServers": { "description": "Local server mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "INN-Reach Agency to FOLIO location mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "localCode": { "description": "Local server code", "type": "string", "maxLength": 5 }, "locationId": { "description": "Location id", "type": "string", "format": "uuid" }, "libraryId": { "description": "Location id", "type": "string", "format": "uuid" }, "agencyCodeMappings": { "description": "Agency code mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "INN-Reach Agency to FOLIO location mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "agencyCode": { "description": "Agency code", "type": "string", "maxLength": 5 }, "locationId": { "description": "Location id", "type": "string", "format": "uuid" }, "libraryId": { "description": "Library id", "type": "string", "format": "uuid" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "agencyCode" ] } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "localCode" ] } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "locationId", "libraryId" ] }
- getallmarctransformationoptionssettings(**kwargs)
Get a list of Marc Transformation Options Settings
GET /inn-reach/central-servers/marc-transformation-options- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query (default: 0, minimum: 0, maximum: 2147483647)
limit (int) – Limit the number of elements returned in the response (default: 10, minimum: 0, maximum: 2147483647)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "description": "MARC Transformation Options Settings collection", "type": "object", "properties": { "totalRecords": { "description": "Total records", "type": "integer" }, "MARCTransformOptSetList": { "description": "List of MARC Transformation Options Settings", "type": "array", "items": { "description": "MARC Transformation Options Settings", "type": "object", "properties": { "id": { "description": "MARC Transformation Options Settings id", "type": "string", "format": "UUID" }, "configIsActive": { "description": "A Boolean indicating whether the configuration is active", "type": "boolean" }, "modifiedFieldsForContributedRecords": { "description": "An ordered array of field configurations", "type": "array", "items": { "description": "Field Configuration", "type": "object", "properties": { "id": { "description": "Field configuration id", "type": "string", "format": "UUID" }, "resourceIdentifierTypeId": { "description": "Resource identifier type id", "type": "string", "format": "UUID" }, "stripPrefix": { "description": "Strip prefix", "type": "boolean" }, "ignorePrefixes": { "description": "Array of strings that if present as prefixes will cause the identifier to be ignored", "type": "array", "items": { "type": "string" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false } }, "excludedMARCFields": { "description": "An array of MARC fields/subfields to exclude from transformed MARC records", "type": "array", "items": { "type": "string" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false } } }, "additionalProperties": false, "required": [ "MARCTransformOptSetList" ] }
- getallpagingsliptemplates()
Get list of Paging Slip Templates
GET /inn-reach/central-servers/paging-slip-template- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "INN-Reach paging slip templates collection", "type": "object", "properties": { "totalRecords": { "description": "Total records", "type": "integer", "default": 0 }, "pagingSlipTemplates": { "description": "List of INN-Reach paging slip templates", "type": "array", "items": { "description": "Paging Slip Template", "type": "object", "properties": { "id": { "description": "Paging Slip Template id", "type": "string", "format": "UUID" }, "centralServerId": { "description": "Central server id", "type": "string", "format": "UUID" }, "description": { "description": "Paging Slip Template description", "type": "string" }, "template": { "description": "Paging Slip Template template", "type": "string" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false } } }, "additionalProperties": false, "required": [ "pagingSlipTemplates" ] }
- getcentralpatrontypemappings(centralServerId, **kwargs)
Get a list of Central Patron Type Mappings
GET /inn-reach/central-servers/{centralServerId}/central-patron-type-mappings- Parameters
centralServerId (str) – (format: uuid)
- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query (default: 0, minimum: 0, maximum: 2147483647)
limit (int) – Limit the number of elements returned in the response (default: 10, minimum: 0, maximum: 2147483647)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Central patron type mapping collection", "type": "object", "properties": { "centralPatronTypeMappings": { "description": "List of central patron type mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Central patron type mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "barcode": { "description": "Folio user barcode", "type": "string" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "centralPatronType", "barcode" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "centralPatronTypeMappings" ] }
- getcentralserverbyid(centralServerId)
Get central server by id
GET /inn-reach/central-servers/{centralServerId}- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Central server", "type": "object", "properties": { "id": { "description": "Central server id", "type": "string", "format": "UUID" }, "name": { "description": "Central server name", "type": "string" }, "description": { "description": "Central server description", "type": "string" }, "localServerCode": { "description": "Server code", "type": "string", "maxLength": 5 }, "centralServerCode": { "description": "Central server code", "type": "string", "maxLength": 5 }, "centralServerAddress": { "description": "Central server http address", "type": "string" }, "loanTypeId": { "description": "Loan type id", "type": "string", "format": "UUID" }, "localAgencies": { "description": "Local agencies", "type": "array", "items": { "description": "Local agency", "type": "object", "properties": { "id": { "description": "Local agency id", "type": "string", "format": "UUID" }, "code": { "description": "Local agency code", "type": "string", "maxLength": 5 }, "folioLibraryIds": { "description": "Folio libraries ids", "type": "array", "items": { "type": "string", "format": "UUID" } } }, "additionalProperties": false, "required": [ "code", "folioLibraryIds" ] } }, "centralServerKey": { "description": "Central server key", "type": "string" }, "centralServerSecret": { "description": "Central server secret", "type": "string" }, "localServerKey": { "description": "Local server key", "type": "string" }, "localServerSecret": { "description": "Local server secret", "type": "string" }, "checkPickupLocation": { "description": "Indicates whether to look up pickup locations for INN-Reach item hold requests based on transaction pickupLocation", "type": "boolean", "default": false }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "name", "localServerCode", "centralServerCode", "centralServerAddress", "loanTypeId", "localAgencies", "centralServerKey", "centralServerSecret" ] }
- getcentralserverrecalluser(centralServerId)
Get Inn-Reach Central server recall user
GET /inn-reach/central-servers/{centralServerId}/inn-reach-recall-user- Parameters
centralServerId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "description": "InnReach recall user", "type": "object", "properties": { "userId": { "description": "User id", "type": "string", "format": "uuid" } }, "additionalProperties": false, "required": [ "userId" ] }
- getcentralservers(**kwargs)
Get a list of central servers
GET /inn-reach/central-servers- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query (default: 0, minimum: 0, maximum: 2147483647)
limit (int) – Limit the number of elements returned in the response (default: 10, minimum: 0, maximum: 2147483647)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Central servers collection", "type": "object", "properties": { "totalRecords": { "description": "Total records", "type": "integer" }, "centralServers": { "description": "List of INN-Reach Central servers", "type": "array", "items": { "description": "Central server", "type": "object", "properties": { "id": { "description": "Central server id", "type": "string", "format": "UUID" }, "name": { "description": "Central server name", "type": "string" }, "description": { "description": "Central server description", "type": "string" }, "localServerCode": { "description": "Server code", "type": "string", "maxLength": 5 }, "centralServerCode": { "description": "Central server code", "type": "string", "maxLength": 5 }, "centralServerAddress": { "description": "Central server http address", "type": "string" }, "loanTypeId": { "description": "Loan type id", "type": "string", "format": "UUID" }, "localAgencies": { "description": "Local agencies", "type": "array", "items": { "description": "Local agency", "type": "object", "properties": { "id": { "description": "Local agency id", "type": "string", "format": "UUID" }, "code": { "description": "Local agency code", "type": "string", "maxLength": 5 }, "folioLibraryIds": { "description": "Folio libraries ids", "type": "array", "items": { "type": "string", "format": "UUID" } } }, "additionalProperties": false, "required": [ "code", "folioLibraryIds" ] } }, "centralServerKey": { "description": "Central server key", "type": "string" }, "centralServerSecret": { "description": "Central server secret", "type": "string" }, "localServerKey": { "description": "Local server key", "type": "string" }, "localServerSecret": { "description": "Local server secret", "type": "string" }, "checkPickupLocation": { "description": "Indicates whether to look up pickup locations for INN-Reach item hold requests based on transaction pickupLocation", "type": "boolean", "default": false }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "name", "localServerCode", "centralServerCode", "centralServerAddress", "loanTypeId", "localAgencies", "centralServerKey", "centralServerSecret" ] } } }, "additionalProperties": false, "required": [ "centralServers" ] }
- getconfigurationbycentralserverid(centralServerId)
Get Visible Patron Field Configuration by Central Server id
GET /inn-reach/central-servers/{centralServerId}/visible-patron-field-configuration- Parameters
centralServerId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Visible Patron Field Configuration", "type": "object", "properties": { "id": { "description": "Visible Patron Field Configuration id", "type": "string", "format": "UUID" }, "fields": { "description": "An array of Visible Patron Fields", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Visible Patron Field enum", "description": "Visible Patron Field enum", "type": "string", "additionalProperties": false, "enum": [ "BARCODE", "EXTERNAL_SYSTEM_ID", "FOLIO_RECORD_NUMBER", "USERNAME", "USER_CUSTOM_FIELDS" ] } }, "userCustomFields": { "description": "An array of User Custom Fields refIds", "type": "array", "items": { "type": "string" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- getcriteriabyserverid(centralServerId)
Get Contribution Criteria by Central Server id
GET /inn-reach/central-servers/{centralServerId}/contribution-criteria- Parameters
centralServerId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Contribution Criteria Configuration", "type": "object", "properties": { "id": { "description": "Contribution criteria id", "type": "string", "format": "UUID" }, "locationIds": { "description": "Locations excluded from contribution process", "type": "array", "items": { "type": "string", "format": "UUID" } }, "contributeButSuppressId": { "description": "Contribute but suppress statistical code id", "type": "string", "format": "UUID" }, "doNotContributeId": { "description": "Do not contribute statistical code id", "type": "string", "format": "UUID" }, "contributeAsSystemOwnedId": { "description": "Contribute as system owner statistical code id", "type": "string", "format": "UUID" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- getitemcontributionoptionsconfigurationbyid(centralServerId)
Get Item Contribution Options Configuration by id
GET /inn-reach/central-servers/{centralServerId}/item-contribution-options- Parameters
centralServerId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Item Contribution Options", "type": "object", "properties": { "id": { "description": "Item Contribution Options Configuration id", "type": "string", "format": "UUID" }, "notAvailableItemStatuses": { "description": "A list of FOLIO item states that should be considered \"Not available\"", "type": "array", "items": { "type": "string" } }, "nonLendableLoanTypes": { "description": "A list of FOLIO loan types that should be considered non-lendable", "type": "array", "items": { "type": "string", "format": "UUID" } }, "nonLendableLocations": { "description": "A list of FOLIO locations whose items should be considered non-lendable", "type": "array", "items": { "type": "string", "format": "UUID" } }, "nonLendableMaterialTypes": { "description": "A list of FOLIO material types that should be considered non-lendable", "type": "array", "items": { "type": "string", "format": "UUID" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- getitemtypemappingsbyserverid(centralServerId, **kwargs)
Get a list of Item Type Mappings
GET /inn-reach/central-servers/{centralServerId}/item-type-mappings- Parameters
centralServerId (str) – (format: uuid)
- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query (default: 0, minimum: 0, maximum: 2147483647)
limit (int) – Limit the number of elements returned in the response (default: 10, minimum: 0, maximum: 2147483647)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Item type mapping collection", "type": "object", "properties": { "itemTypeMappings": { "description": "List of item type mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Item type mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "materialTypeId": { "description": "Material type id", "type": "string", "format": "uuid" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "centralItemType", "materialTypeId" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "itemTypeMappings" ] }
- getlibrarymappingsbyserverid(centralServerId, **kwargs)
Get a list of library to Inn-Reach location mappings for the given central server
GET /inn-reach/central-servers/{centralServerId}/libraries/location-mappings- Parameters
centralServerId (str) – (format: uuid)
- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query (default: 0, minimum: 0, maximum: 2147483647)
limit (int) – Limit the number of elements returned in the response (default: 10, minimum: 0, maximum: 2147483647)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request, e.g. malformed query parameter.
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Library mapping collection", "type": "object", "properties": { "libraryMappings": { "description": "List of library mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Library mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "libraryId": { "description": "Library id", "type": "string", "format": "uuid" }, "innReachLocationId": { "description": "Inn-Reach location id", "type": "string", "format": "uuid" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "libraryId", "innReachLocationId" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "libraryMappings" ] }
- getlocationbyid(locationId)
Get InnReach location by id
GET /inn-reach/locations/{locationId}- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "InnReach location", "type": "object", "properties": { "id": { "description": "location id", "type": "string", "format": "UUID" }, "code": { "description": "location code", "type": "string", "maxLength": 5 }, "description": { "description": "location description", "type": "string", "maxLength": 255 }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "code" ] }
- getlocationmappingsbyserverid(centralServerId, libraryId, **kwargs)
Get a list of library location to Inn-Reach location mappings for the given central server
GET /inn-reach/central-servers/{centralServerId}/libraries/{libraryId}/locations/location-mappings- Parameters
centralServerId (str) – (format: uuid)
libraryId (str) – (format: uuid)
- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query (default: 0, minimum: 0, maximum: 2147483647)
limit (int) – Limit the number of elements returned in the response (default: 10, minimum: 0, maximum: 2147483647)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request, e.g. malformed query parameter.
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Location mapping collection", "type": "object", "properties": { "locationMappings": { "description": "List of location mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Location mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "locationId": { "description": "Location id", "type": "string", "format": "uuid" }, "innReachLocationId": { "description": "Inn-Reach location id", "type": "string", "format": "uuid" }, "libraryId": { "description": "Library id", "type": "string", "format": "uuid" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "locationId" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "locationMappings" ] }
- getlocationmappingsforalllibrariesbyserverid(centralServerId)
Get a list of libraries locations to Inn-Reach location mappings for the given central server
GET /inn-reach/central-servers/{centralServerId}/libraries/locations/location-mappings- Parameters
centralServerId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request, e.g. malformed query parameter.
OkapiRequestFatalError – Internal server error
Schema
{ "type": "array", "items": { "$ref": "#/components/schemas/locationMappingDTO" } }
- getlocations(**kwargs)
Get a list of InnReach locations
GET /inn-reach/locations- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query (default: 0, minimum: 0, maximum: 2147483647)
limit (int) – Limit the number of elements returned in the response (default: 10, minimum: 0, maximum: 2147483647)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "description": "InnReach locations collection", "type": "object", "properties": { "totalRecords": { "description": "Total records", "type": "integer" }, "locations": { "description": "List of INN-Reach locations", "type": "array", "items": { "description": "InnReach location", "type": "object", "properties": { "id": { "description": "location id", "type": "string", "format": "UUID" }, "code": { "description": "location code", "type": "string", "maxLength": 5 }, "description": { "description": "location description", "type": "string", "maxLength": 255 }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "code" ] } } }, "additionalProperties": false, "required": [ "locations" ] }
- getmarctransformationoptionssettingsbyid(centralServerId)
Get MARC Transformation Options Settings by id
GET /inn-reach/central-servers/{centralServerId}/marc-transformation-options- Parameters
centralServerId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "MARC Transformation Options Settings", "type": "object", "properties": { "id": { "description": "MARC Transformation Options Settings id", "type": "string", "format": "UUID" }, "configIsActive": { "description": "A Boolean indicating whether the configuration is active", "type": "boolean" }, "modifiedFieldsForContributedRecords": { "description": "An ordered array of field configurations", "type": "array", "items": { "description": "Field Configuration", "type": "object", "properties": { "id": { "description": "Field configuration id", "type": "string", "format": "UUID" }, "resourceIdentifierTypeId": { "description": "Resource identifier type id", "type": "string", "format": "UUID" }, "stripPrefix": { "description": "Strip prefix", "type": "boolean" }, "ignorePrefixes": { "description": "Array of strings that if present as prefixes will cause the identifier to be ignored", "type": "array", "items": { "type": "string" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false } }, "excludedMARCFields": { "description": "An array of MARC fields/subfields to exclude from transformed MARC records", "type": "array", "items": { "type": "string" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- getmaterialtypemappingbyid(centralServerId, id_)
Get material type mapping by id
GET /inn-reach/central-servers/{centralServerId}/material-type-mappings/{id}- Parameters
centralServerId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Material type mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "materialTypeId": { "description": "Material type id", "type": "string", "format": "uuid" }, "centralItemType": { "description": "Central server item type", "type": "integer" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "materialTypeId", "centralItemType" ] }
- getmaterialtypemappingsbyserverid(centralServerId, **kwargs)
Get a list of material type mappings for the given central server
GET /inn-reach/central-servers/{centralServerId}/material-type-mappings- Parameters
centralServerId (str) – (format: uuid)
- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query (default: 0, minimum: 0, maximum: 2147483647)
limit (int) – Limit the number of elements returned in the response (default: 10, minimum: 0, maximum: 2147483647)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request, e.g. malformed query parameter.
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Material type mapping collection", "type": "object", "properties": { "materialTypeMappings": { "description": "List of material type mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Material type mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "materialTypeId": { "description": "Material type id", "type": "string", "format": "uuid" }, "centralItemType": { "description": "Central server item type", "type": "integer" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "materialTypeId", "centralItemType" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "materialTypeMappings" ] }
- getpagingsliptemplate(centralServerId)
Get Paging Slip Template
GET /inn-reach/central-servers/{centralServerId}/paging-slip-template- Parameters
centralServerId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Paging Slip Template", "type": "object", "properties": { "id": { "description": "Paging Slip Template id", "type": "string", "format": "UUID" }, "centralServerId": { "description": "Central server id", "type": "string", "format": "UUID" }, "description": { "description": "Paging Slip Template description", "type": "string" }, "template": { "description": "Paging Slip Template template", "type": "string" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- getpatrontypemappingsbyserverid(centralServerId, **kwargs)
Get a list of Patron Type Mappings
GET /inn-reach/central-servers/{centralServerId}/patron-type-mappings- Parameters
centralServerId (str) – (format: uuid)
- Keyword Arguments
offset (int) – Skip over a number of elements by specifying an offset value for the query (default: 0, minimum: 0, maximum: 2147483647)
limit (int) – Limit the number of elements returned in the response (default: 10, minimum: 0, maximum: 2147483647)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Patron type mapping collection", "type": "object", "properties": { "patronTypeMappings": { "description": "List of patron type mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Patron type mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "patronGroupId": { "description": "Patron group id", "type": "string", "format": "uuid" }, "patronType": { "description": "Patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "patronGroupId", "patronType" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "patronTypeMappings" ] }
- getusercustomfieldmapping(centralServerId)
Get a User Custom Field Mapping
GET /inn-reach/central-servers/{centralServerId}/user-custom-field-mappings- Parameters
centralServerId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "User custom field mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "customFieldId": { "description": "Custom field refId", "type": "string" }, "configuredOptions": { "type": "object", "description": "Map of the option ids for the custom field and local agency codes", "additionalProperties": { "type": "string", "properties": { "agencyCode": { "description": "Agency code", "type": "string", "maxLength": 5 }, "customFieldValue": { "description": "Custom field option id", "type": "string" } } } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "customFieldId", "configuredOptions" ] }
- postcentralserver(centralServerDTO)
Add new central server
POST /inn-reach/central-servers- Parameters
centralServerDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request
OkapiRequestConflict – Item state conflict
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Central server", "type": "object", "properties": { "id": { "description": "Central server id", "type": "string", "format": "UUID" }, "name": { "description": "Central server name", "type": "string" }, "description": { "description": "Central server description", "type": "string" }, "localServerCode": { "description": "Server code", "type": "string", "maxLength": 5 }, "centralServerCode": { "description": "Central server code", "type": "string", "maxLength": 5 }, "centralServerAddress": { "description": "Central server http address", "type": "string" }, "loanTypeId": { "description": "Loan type id", "type": "string", "format": "UUID" }, "localAgencies": { "description": "Local agencies", "type": "array", "items": { "description": "Local agency", "type": "object", "properties": { "id": { "description": "Local agency id", "type": "string", "format": "UUID" }, "code": { "description": "Local agency code", "type": "string", "maxLength": 5 }, "folioLibraryIds": { "description": "Folio libraries ids", "type": "array", "items": { "type": "string", "format": "UUID" } } }, "additionalProperties": false, "required": [ "code", "folioLibraryIds" ] } }, "centralServerKey": { "description": "Central server key", "type": "string" }, "centralServerSecret": { "description": "Central server secret", "type": "string" }, "localServerKey": { "description": "Local server key", "type": "string" }, "localServerSecret": { "description": "Local server secret", "type": "string" }, "checkPickupLocation": { "description": "Indicates whether to look up pickup locations for INN-Reach item hold requests based on transaction pickupLocation", "type": "boolean", "default": false }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "name", "localServerCode", "centralServerCode", "centralServerAddress", "loanTypeId", "localAgencies", "centralServerKey", "centralServerSecret" ] }
- postcontributioncriteria(centralServerId, contributionCriteriaDTO)
Create new contribution criteria for Central Server
POST /inn-reach/central-servers/{centralServerId}/contribution-criteria- Parameters
centralServerId (str) – (format: uuid)
contributionCriteriaDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request
OkapiRequestConflict – Item state conflict
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Contribution Criteria Configuration", "type": "object", "properties": { "id": { "description": "Contribution criteria id", "type": "string", "format": "UUID" }, "locationIds": { "description": "Locations excluded from contribution process", "type": "array", "items": { "type": "string", "format": "UUID" } }, "contributeButSuppressId": { "description": "Contribute but suppress statistical code id", "type": "string", "format": "UUID" }, "doNotContributeId": { "description": "Do not contribute statistical code id", "type": "string", "format": "UUID" }, "contributeAsSystemOwnedId": { "description": "Contribute as system owner statistical code id", "type": "string", "format": "UUID" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- postinnreachlocation(innReachLocationDTO)
Add new InnReach location
POST /inn-reach/locations- Parameters
innReachLocationDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request
OkapiRequestFatalError – Internal server error
Schema
{ "description": "InnReach location", "type": "object", "properties": { "id": { "description": "location id", "type": "string", "format": "UUID" }, "code": { "description": "location code", "type": "string", "maxLength": 5 }, "description": { "description": "location description", "type": "string", "maxLength": 255 }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "code" ] }
- postmaterialtypemapping(centralServerId, materialTypeMappingDTO)
Add new material type mapping associated with the central server
POST /inn-reach/central-servers/{centralServerId}/material-type-mappings- Parameters
centralServerId (str) – (format: uuid)
materialTypeMappingDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request
OkapiRequestConflict – Item state conflict
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Material type mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "materialTypeId": { "description": "Material type id", "type": "string", "format": "uuid" }, "centralItemType": { "description": "Central server item type", "type": "integer" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "materialTypeId", "centralItemType" ] }
- putagencymappings(centralServerId, agencyLocationMappingDTO)
Update (add) INN-Reach Agency to FOLIO location mappings associated with the central server
PUT /inn-reach/central-servers/{centralServerId}/agency-mappings- Parameters
centralServerId (str) – (format: uuid)
agencyLocationMappingDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestConflict – Item state conflict
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "INN-Reach Agency to FOLIO locations mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "locationId": { "description": "Location id", "type": "string", "format": "uuid" }, "libraryId": { "description": "Location id", "type": "string", "format": "uuid" }, "localServers": { "description": "Local server mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "INN-Reach Agency to FOLIO location mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "localCode": { "description": "Local server code", "type": "string", "maxLength": 5 }, "locationId": { "description": "Location id", "type": "string", "format": "uuid" }, "libraryId": { "description": "Location id", "type": "string", "format": "uuid" }, "agencyCodeMappings": { "description": "Agency code mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "INN-Reach Agency to FOLIO location mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "agencyCode": { "description": "Agency code", "type": "string", "maxLength": 5 }, "locationId": { "description": "Location id", "type": "string", "format": "uuid" }, "libraryId": { "description": "Library id", "type": "string", "format": "uuid" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "agencyCode" ] } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "localCode" ] } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "locationId", "libraryId" ] }
- putlibrarymappings(centralServerId, libraryMappingsDTO)
Update (replace) the entire collection of library to Inn-Reach location mappings associated with the central server
PUT /inn-reach/central-servers/{centralServerId}/libraries/location-mappings- Parameters
centralServerId (str) – (format: uuid)
libraryMappingsDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestConflict – Item state conflict
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Library mapping collection", "type": "object", "properties": { "libraryMappings": { "description": "List of library mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Library mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "libraryId": { "description": "Library id", "type": "string", "format": "uuid" }, "innReachLocationId": { "description": "Inn-Reach location id", "type": "string", "format": "uuid" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "libraryId", "innReachLocationId" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "libraryMappings" ] }
- putlocationmappings(centralServerId, libraryId, locationMappingsDTO)
Update (replace) the entire collection of library location to Inn-Reach location mappings associated with the central server
PUT /inn-reach/central-servers/{centralServerId}/libraries/{libraryId}/locations/location-mappings- Parameters
centralServerId (str) – (format: uuid)
libraryId (str) – (format: uuid)
locationMappingsDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestConflict – Item state conflict
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Location mapping collection", "type": "object", "properties": { "locationMappings": { "description": "List of location mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Location mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "locationId": { "description": "Location id", "type": "string", "format": "uuid" }, "innReachLocationId": { "description": "Inn-Reach location id", "type": "string", "format": "uuid" }, "libraryId": { "description": "Library id", "type": "string", "format": "uuid" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "locationId" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "locationMappings" ] }
- saveinnreachrecalluser(centralServerId, innReachRecallUserDTO)
Add new Inn-Reach recall user to central server
POST /inn-reach/central-servers/{centralServerId}/inn-reach-recall-user- Parameters
centralServerId (str) – (format: uuid)
innReachRecallUserDTO (dict) – See Schema below.
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request
OkapiRequestFatalError – Internal server error
Schema
{ "description": "InnReach recall user", "type": "object", "properties": { "userId": { "description": "User id", "type": "string", "format": "uuid" } }, "additionalProperties": false, "required": [ "userId" ] }
- transformmarcrecord(centralServerId, inventoryInstanceId)
Transform MARC record by Id according to CentralServer settings
GET /inn-reach/central-servers/{centralServerId}/marc-record-transformation/{inventoryInstanceId}- Parameters
centralServerId (str) – (format: uuid)
inventoryInstanceId (str) – (format: uuid)
- Returns
See Schema below.
- Return type
dict
- Raises
OkapiRequestError – Bad request
OkapiRequestFatalError – Internal server error
Schema
{ "description": "SRS MARC record", "type": "object", "properties": { "id": { "description": "MARC record id", "type": "string", "format": "UUID" }, "content": { "description": "Formatted content", "type": "string" }, "base64rawContent": { "description": "Base64 encoded raw content", "type": "string" } }, "additionalProperties": false, "required": [ "id", "content", "base64rawContent" ] }
- updatecentralpatrontypemappings(centralServerId, centralPatronTypeMappingsDTO)
Update Central Patron Type Mappings
PUT /inn-reach/central-servers/{centralServerId}/central-patron-type-mappings- Parameters
centralServerId (str) – (format: uuid)
centralPatronTypeMappingsDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Central patron type mapping collection", "type": "object", "properties": { "centralPatronTypeMappings": { "description": "List of central patron type mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Central patron type mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "centralPatronType": { "description": "Central patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "barcode": { "description": "Folio user barcode", "type": "string" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "centralPatronType", "barcode" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "centralPatronTypeMappings" ] }
- updatecentralserver(centralServerDTO, centralServerId)
Update central server
PUT /inn-reach/central-servers/{centralServerId}- Parameters
centralServerDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Central server", "type": "object", "properties": { "id": { "description": "Central server id", "type": "string", "format": "UUID" }, "name": { "description": "Central server name", "type": "string" }, "description": { "description": "Central server description", "type": "string" }, "localServerCode": { "description": "Server code", "type": "string", "maxLength": 5 }, "centralServerCode": { "description": "Central server code", "type": "string", "maxLength": 5 }, "centralServerAddress": { "description": "Central server http address", "type": "string" }, "loanTypeId": { "description": "Loan type id", "type": "string", "format": "UUID" }, "localAgencies": { "description": "Local agencies", "type": "array", "items": { "description": "Local agency", "type": "object", "properties": { "id": { "description": "Local agency id", "type": "string", "format": "UUID" }, "code": { "description": "Local agency code", "type": "string", "maxLength": 5 }, "folioLibraryIds": { "description": "Folio libraries ids", "type": "array", "items": { "type": "string", "format": "UUID" } } }, "additionalProperties": false, "required": [ "code", "folioLibraryIds" ] } }, "centralServerKey": { "description": "Central server key", "type": "string" }, "centralServerSecret": { "description": "Central server secret", "type": "string" }, "localServerKey": { "description": "Local server key", "type": "string" }, "localServerSecret": { "description": "Local server secret", "type": "string" }, "checkPickupLocation": { "description": "Indicates whether to look up pickup locations for INN-Reach item hold requests based on transaction pickupLocation", "type": "boolean", "default": false }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "name", "localServerCode", "centralServerCode", "centralServerAddress", "loanTypeId", "localAgencies", "centralServerKey", "centralServerSecret" ] }
- updatecentralserverrecalluser(centralServerId, innReachRecallUserDTO)
Update Inn-Reach Central server recall user
PUT /inn-reach/central-servers/{centralServerId}/inn-reach-recall-user- Parameters
centralServerId (str) – (format: uuid)
innReachRecallUserDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "InnReach recall user", "type": "object", "properties": { "userId": { "description": "User id", "type": "string", "format": "uuid" } }, "additionalProperties": false, "required": [ "userId" ] }
- updateconfiguration(centralServerId, visiblePatronFieldConfigurationDTO)
Update Visible Patron Field Configuration
PUT /inn-reach/central-servers/{centralServerId}/visible-patron-field-configuration- Parameters
centralServerId (str) – (format: uuid)
visiblePatronFieldConfigurationDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Visible Patron Field Configuration", "type": "object", "properties": { "id": { "description": "Visible Patron Field Configuration id", "type": "string", "format": "UUID" }, "fields": { "description": "An array of Visible Patron Fields", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "title": "Visible Patron Field enum", "description": "Visible Patron Field enum", "type": "string", "additionalProperties": false, "enum": [ "BARCODE", "EXTERNAL_SYSTEM_ID", "FOLIO_RECORD_NUMBER", "USERNAME", "USER_CUSTOM_FIELDS" ] } }, "userCustomFields": { "description": "An array of User Custom Fields refIds", "type": "array", "items": { "type": "string" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- updatecriteria(centralServerId, contributionCriteriaDTO)
Update Contribution Criteria Configuration
PUT /inn-reach/central-servers/{centralServerId}/contribution-criteria- Parameters
centralServerId (str) – (format: uuid)
contributionCriteriaDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestConflict – Item state conflict
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Contribution Criteria Configuration", "type": "object", "properties": { "id": { "description": "Contribution criteria id", "type": "string", "format": "UUID" }, "locationIds": { "description": "Locations excluded from contribution process", "type": "array", "items": { "type": "string", "format": "UUID" } }, "contributeButSuppressId": { "description": "Contribute but suppress statistical code id", "type": "string", "format": "UUID" }, "doNotContributeId": { "description": "Do not contribute statistical code id", "type": "string", "format": "UUID" }, "contributeAsSystemOwnedId": { "description": "Contribute as system owner statistical code id", "type": "string", "format": "UUID" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- updateitemcontributionoptionsconfiguration(centralServerId, itemContributionOptionsConfigurationDTO)
Update Item Contribution Options Configuration
PUT /inn-reach/central-servers/{centralServerId}/item-contribution-options- Parameters
centralServerId (str) – (format: uuid)
itemContributionOptionsConfigurationDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Item Contribution Options", "type": "object", "properties": { "id": { "description": "Item Contribution Options Configuration id", "type": "string", "format": "UUID" }, "notAvailableItemStatuses": { "description": "A list of FOLIO item states that should be considered \"Not available\"", "type": "array", "items": { "type": "string" } }, "nonLendableLoanTypes": { "description": "A list of FOLIO loan types that should be considered non-lendable", "type": "array", "items": { "type": "string", "format": "UUID" } }, "nonLendableLocations": { "description": "A list of FOLIO locations whose items should be considered non-lendable", "type": "array", "items": { "type": "string", "format": "UUID" } }, "nonLendableMaterialTypes": { "description": "A list of FOLIO material types that should be considered non-lendable", "type": "array", "items": { "type": "string", "format": "UUID" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- updateitemtypemappings(centralServerId, itemTypeMappingsDTO)
Update Item Type Mappings
PUT /inn-reach/central-servers/{centralServerId}/item-type-mappings- Parameters
centralServerId (str) – (format: uuid)
itemTypeMappingsDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Item type mapping collection", "type": "object", "properties": { "itemTypeMappings": { "description": "List of item type mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Item type mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "centralItemType": { "description": "Central item type", "type": "integer", "minimum": 0, "maximum": 255 }, "materialTypeId": { "description": "Material type id", "type": "string", "format": "uuid" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "centralItemType", "materialTypeId" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "itemTypeMappings" ] }
- updatelocation(innReachLocationDTO, locationId)
Update InnReach location
PUT /inn-reach/locations/{locationId}- Parameters
innReachLocationDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "InnReach location", "type": "object", "properties": { "id": { "description": "location id", "type": "string", "format": "UUID" }, "code": { "description": "location code", "type": "string", "maxLength": 5 }, "description": { "description": "location description", "type": "string", "maxLength": 255 }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "code" ] }
- updatemarctransformationoptionssettings(centralServerId, mARCTransformationOptionsSettingsDTO)
Update MARC Transformation Options Settings
PUT /inn-reach/central-servers/{centralServerId}/marc-transformation-options- Parameters
centralServerId (str) – (format: uuid)
mARCTransformationOptionsSettingsDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "MARC Transformation Options Settings", "type": "object", "properties": { "id": { "description": "MARC Transformation Options Settings id", "type": "string", "format": "UUID" }, "configIsActive": { "description": "A Boolean indicating whether the configuration is active", "type": "boolean" }, "modifiedFieldsForContributedRecords": { "description": "An ordered array of field configurations", "type": "array", "items": { "description": "Field Configuration", "type": "object", "properties": { "id": { "description": "Field configuration id", "type": "string", "format": "UUID" }, "resourceIdentifierTypeId": { "description": "Resource identifier type id", "type": "string", "format": "UUID" }, "stripPrefix": { "description": "Strip prefix", "type": "boolean" }, "ignorePrefixes": { "description": "Array of strings that if present as prefixes will cause the identifier to be ignored", "type": "array", "items": { "type": "string" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false } }, "excludedMARCFields": { "description": "An array of MARC fields/subfields to exclude from transformed MARC records", "type": "array", "items": { "type": "string" } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- updatematerialtypemapping(centralServerId, materialTypeMappingDTO, id_)
Update material type mapping
PUT /inn-reach/central-servers/{centralServerId}/material-type-mappings/{id}- Parameters
centralServerId (str) – (format: uuid)
materialTypeMappingDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Material type mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "materialTypeId": { "description": "Material type id", "type": "string", "format": "uuid" }, "centralItemType": { "description": "Central server item type", "type": "integer" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "materialTypeId", "centralItemType" ] }
- updatematerialtypemappings(centralServerId, materialTypeMappingsDTO)
Update (replace) the entire collection of material type mappings associated with the central server
PUT /inn-reach/central-servers/{centralServerId}/material-type-mappings- Parameters
centralServerId (str) – (format: uuid)
materialTypeMappingsDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestConflict – Item state conflict
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Material type mapping collection", "type": "object", "properties": { "materialTypeMappings": { "description": "List of material type mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Material type mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "materialTypeId": { "description": "Material type id", "type": "string", "format": "uuid" }, "centralItemType": { "description": "Central server item type", "type": "integer" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "materialTypeId", "centralItemType" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "materialTypeMappings" ] }
- updatepagingsliptemplate(centralServerId, pagingSlipTemplateDTO)
Update Paging Slip Template
PUT /inn-reach/central-servers/{centralServerId}/paging-slip-template- Parameters
centralServerId (str) – (format: uuid)
pagingSlipTemplateDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "description": "Paging Slip Template", "type": "object", "properties": { "id": { "description": "Paging Slip Template id", "type": "string", "format": "UUID" }, "centralServerId": { "description": "Central server id", "type": "string", "format": "UUID" }, "description": { "description": "Paging Slip Template description", "type": "string" }, "template": { "description": "Paging Slip Template template", "type": "string" }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false }
- updatepatrontypemappings(centralServerId, patronTypeMappingsDTO)
Update Patron Type Mappings
PUT /inn-reach/central-servers/{centralServerId}/patron-type-mappings- Parameters
centralServerId (str) – (format: uuid)
patronTypeMappingsDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "Patron type mapping collection", "type": "object", "properties": { "patronTypeMappings": { "description": "List of patron type mappings", "type": "array", "items": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "Patron type mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "patronGroupId": { "description": "Patron group id", "type": "string", "format": "uuid" }, "patronType": { "description": "Patron type", "type": "integer", "minimum": 0, "maximum": 255 }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "patronGroupId", "patronType" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "patronTypeMappings" ] }
- updateusercustomfieldmapping(centralServerId, userCustomFieldMappingDTO)
Update User Custom Field Mapping
PUT /inn-reach/central-servers/{centralServerId}/user-custom-field-mappings- Parameters
centralServerId (str) – (format: uuid)
userCustomFieldMappingDTO (dict) – See Schema below.
- Raises
OkapiRequestError – Bad request
OkapiRequestNotFound – Item not found
OkapiRequestFatalError – Internal server error
Schema
{ "$schema": "http://json-schema.org/draft-04/schema#", "description": "User custom field mapping", "type": "object", "properties": { "id": { "description": "Mapping id", "type": "string", "format": "uuid" }, "customFieldId": { "description": "Custom field refId", "type": "string" }, "configuredOptions": { "type": "object", "description": "Map of the option ids for the custom field and local agency codes", "additionalProperties": { "type": "string", "properties": { "agencyCode": { "description": "Agency code", "type": "string", "maxLength": 5 }, "customFieldValue": { "description": "Custom field option id", "type": "string" } } } }, "metadata": { "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "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}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "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}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "customFieldId", "configuredOptions" ] }