API docs by Redocly

INN-Reach Settings API (v1)

central-servers

postCentralServer

Add new central server

Request Body schema: application/json
required
id
string <UUID>

Central server id

name
required
string

Central server name

description
string

Central server description

localServerCode
required
string <= 5 characters

Server code

centralServerCode
required
string <= 5 characters

Central server code

centralServerAddress
required
string

Central server http address

loanTypeId
required
string <UUID>

Loan type id

required
Array of objects (localAgencyDTO)

Local agencies

Array
id
string <UUID>

Local agency id

code
required
string <= 5 characters

Local agency code

folioLibraryIds
required
Array of strings <UUID> [ items <UUID > ]

Folio libraries ids

centralServerKey
required
string

Central server key

centralServerSecret
required
string

Central server secret

localServerKey
string <UUID>

Local server key

localServerSecret
string

Local server secret; UUID on write, then it will be hashed and salted

checkPickupLocation
boolean
Default: false

Indicates whether to look up pickup locations for INN-Reach item hold requests based on transaction pickupLocation

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "localServerCode": "strin",
  • "centralServerCode": "strin",
  • "centralServerAddress": "string",
  • "loanTypeId": "string",
  • "localAgencies": [
    ],
  • "centralServerKey": "string",
  • "centralServerSecret": "string",
  • "localServerKey": "string",
  • "localServerSecret": "string",
  • "checkPickupLocation": false,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "localServerCode": "strin",
  • "centralServerCode": "strin",
  • "centralServerAddress": "string",
  • "loanTypeId": "string",
  • "localAgencies": [
    ],
  • "centralServerKey": "string",
  • "centralServerSecret": "string",
  • "localServerKey": "string",
  • "localServerSecret": "string",
  • "checkPickupLocation": false,
  • "metadata": {
    }
}

getCentralServers

Get a list of central servers

query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 0,
  • "centralServers": [
    ]
}

getCentralServerById

Get central server by id

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "localServerCode": "strin",
  • "centralServerCode": "strin",
  • "centralServerAddress": "string",
  • "loanTypeId": "string",
  • "localAgencies": [
    ],
  • "centralServerKey": "string",
  • "centralServerSecret": "string",
  • "localServerKey": "string",
  • "localServerSecret": "string",
  • "checkPickupLocation": false,
  • "metadata": {
    }
}

updateCentralServer

Update central server

path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
id
string <UUID>

Central server id

name
required
string

Central server name

description
string

Central server description

localServerCode
required
string <= 5 characters

Server code

centralServerCode
required
string <= 5 characters

Central server code

centralServerAddress
required
string

Central server http address

loanTypeId
required
string <UUID>

Loan type id

required
Array of objects (localAgencyDTO)

Local agencies

Array
id
string <UUID>

Local agency id

code
required
string <= 5 characters

Local agency code

folioLibraryIds
required
Array of strings <UUID> [ items <UUID > ]

Folio libraries ids

centralServerKey
required
string

Central server key

centralServerSecret
required
string

Central server secret

localServerKey
string <UUID>

Local server key

localServerSecret
string

Local server secret; UUID on write, then it will be hashed and salted

checkPickupLocation
boolean
Default: false

Indicates whether to look up pickup locations for INN-Reach item hold requests based on transaction pickupLocation

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "localServerCode": "strin",
  • "centralServerCode": "strin",
  • "centralServerAddress": "string",
  • "loanTypeId": "string",
  • "localAgencies": [
    ],
  • "centralServerKey": "string",
  • "centralServerSecret": "string",
  • "localServerKey": "string",
  • "localServerSecret": "string",
  • "checkPickupLocation": false,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

deleteCentralServer

Delete central server

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string"
}

material-type-mappings

getMaterialTypeMappingsByServerId

Get a list of material type mappings for the given central server

path Parameters
centralServerId
required
string <uuid>
query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "materialTypeMappings": [
    ],
  • "totalRecords": 0
}

postMaterialTypeMapping

Add new material type mapping associated with the central server

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>

Mapping id

materialTypeId
required
string <uuid>

Material type id

centralItemType
required
integer

Central server item type

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "materialTypeId": "ea15724a-f02d-46d6-b3b4-5871810a5e3f",
  • "centralItemType": 0,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "materialTypeId": "ea15724a-f02d-46d6-b3b4-5871810a5e3f",
  • "centralItemType": 0,
  • "metadata": {
    }
}

updateMaterialTypeMappings

Update (replace) the entire collection of material type mappings associated with the central server

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (materialTypeMappingDTO)

List of material type mappings

Array
id
string <uuid>

Mapping id

materialTypeId
required
string <uuid>

Material type id

centralItemType
required
integer

Central server item type

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

totalRecords
integer

Responses

Request samples

Content type
application/json
{
  • "materialTypeMappings": [
    ],
  • "totalRecords": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

getMaterialTypeMappingById

Get material type mapping by id

path Parameters
centralServerId
required
string <uuid>
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "materialTypeId": "ea15724a-f02d-46d6-b3b4-5871810a5e3f",
  • "centralItemType": 0,
  • "metadata": {
    }
}

updateMaterialTypeMapping

Update material type mapping

path Parameters
centralServerId
required
string <uuid>
id
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>

Mapping id

materialTypeId
required
string <uuid>

Material type id

centralItemType
required
integer

Central server item type

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "materialTypeId": "ea15724a-f02d-46d6-b3b4-5871810a5e3f",
  • "centralItemType": 0,
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

deleteMaterialTypeMapping

Delete material type mapping

path Parameters
centralServerId
required
string <uuid>
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string"
}

locations

postInnReachLocation

Add new InnReach location

Request Body schema: application/json
required
id
string <UUID>

location id

code
required
string <= 5 characters

location code

description
string <= 255 characters

location description

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "code": "strin",
  • "description": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "code": "strin",
  • "description": "string",
  • "metadata": {
    }
}

getLocations

Get a list of InnReach locations

query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 0,
  • "locations": [
    ]
}

getLocationById

Get InnReach location by id

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "code": "strin",
  • "description": "string",
  • "metadata": {
    }
}

updateLocation

Update InnReach location

path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
id
string <UUID>

location id

code
required
string <= 5 characters

location code

description
string <= 255 characters

location description

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "code": "strin",
  • "description": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

deleteLocation

Delete InnReach location

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string"
}

library-mappings

getLibraryMappingsByServerId

Get a list of library to Inn-Reach location mappings for the given central server

path Parameters
centralServerId
required
string <uuid>
query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "libraryMappings": [
    ],
  • "totalRecords": 0
}

putLibraryMappings

Update (replace) the entire collection of library to Inn-Reach location mappings associated with the central server

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (libraryMappingDTO)

List of library mappings

Array
id
string <uuid>

Mapping id

libraryId
required
string <uuid>

Library id

innReachLocationId
required
string <uuid>

Inn-Reach location id

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

totalRecords
integer

Responses

Request samples

Content type
application/json
{
  • "libraryMappings": [
    ],
  • "totalRecords": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

location-mappings

getLocationMappingsByServerId

Get a list of library location to Inn-Reach location mappings for the given central server

path Parameters
centralServerId
required
string <uuid>
libraryId
required
string <uuid> (UUID)
query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "locationMappings": [
    ],
  • "totalRecords": 0
}

putLocationMappings

Update (replace) the entire collection of library location to Inn-Reach location mappings associated with the central server

path Parameters
centralServerId
required
string <uuid>
libraryId
required
string <uuid> (UUID)
Request Body schema: application/json
required
required
Array of objects (locationMappingDTO)

List of location mappings

Array
id
string <uuid>

Mapping id

locationId
required
string <uuid>

Location id

innReachLocationId
string <uuid>

Inn-Reach location id

libraryId
string <uuid>

Library id

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

totalRecords
integer

Responses

Request samples

Content type
application/json
{
  • "locationMappings": [
    ],
  • "totalRecords": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

getLocationMappingsForAllLibrariesByServerId

Get a list of libraries locations to Inn-Reach location mappings for the given central server

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

contribution-criteria

getCriteriaByServerId

Get Contribution Criteria by Central Server id

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "locationIds": [
    ],
  • "contributeButSuppressId": "string",
  • "doNotContributeId": "string",
  • "contributeAsSystemOwnedId": "string",
  • "metadata": {
    }
}

postContributionCriteria

Create new contribution criteria for Central Server

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
id
string <UUID>

Contribution criteria id

locationIds
Array of strings <UUID> [ items <UUID > ]

Locations excluded from contribution process

contributeButSuppressId
string <UUID>

Contribute but suppress statistical code id

doNotContributeId
string <UUID>

Do not contribute statistical code id

contributeAsSystemOwnedId
string <UUID>

Contribute as system owner statistical code id

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "locationIds": [
    ],
  • "contributeButSuppressId": "string",
  • "doNotContributeId": "string",
  • "contributeAsSystemOwnedId": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "locationIds": [
    ],
  • "contributeButSuppressId": "string",
  • "doNotContributeId": "string",
  • "contributeAsSystemOwnedId": "string",
  • "metadata": {
    }
}

deleteCriteria

Delete Contribution Criteria Configuration

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string"
}

updateCriteria

Update Contribution Criteria Configuration

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
id
string <UUID>

Contribution criteria id

locationIds
Array of strings <UUID> [ items <UUID > ]

Locations excluded from contribution process

contributeButSuppressId
string <UUID>

Contribute but suppress statistical code id

doNotContributeId
string <UUID>

Do not contribute statistical code id

contributeAsSystemOwnedId
string <UUID>

Contribute as system owner statistical code id

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "locationIds": [
    ],
  • "contributeButSuppressId": "string",
  • "doNotContributeId": "string",
  • "contributeAsSystemOwnedId": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

authentication

authenticateLocalServerKeySecret

Authenticate InnReach local server key/secret pair

Request Body schema: application/json
required
key
required
string <UUID>

key

secret
required
string <UUID>

secret

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "secret": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

item-contribution-options-configuration

getItemContributionOptionsConfigurationById

Get Item Contribution Options Configuration by id

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "notAvailableItemStatuses": [
    ],
  • "nonLendableLoanTypes": [
    ],
  • "nonLendableLocations": [
    ],
  • "nonLendableMaterialTypes": [
    ],
  • "metadata": {
    }
}

updateItemContributionOptionsConfiguration

Update Item Contribution Options Configuration

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
id
string <UUID>

Item Contribution Options Configuration id

notAvailableItemStatuses
Array of strings

A list of FOLIO item states that should be considered "Not available"

nonLendableLoanTypes
Array of strings <UUID> [ items <UUID > ]

A list of FOLIO loan types that should be considered non-lendable

nonLendableLocations
Array of strings <UUID> [ items <UUID > ]

A list of FOLIO locations whose items should be considered non-lendable

nonLendableMaterialTypes
Array of strings <UUID> [ items <UUID > ]

A list of FOLIO material types that should be considered non-lendable

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "notAvailableItemStatuses": [
    ],
  • "nonLendableLoanTypes": [
    ],
  • "nonLendableLocations": [
    ],
  • "nonLendableMaterialTypes": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

createItemContributionOptionsConfiguration

Add new item contribution options configuration associated with the central server

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
id
string <UUID>

Item Contribution Options Configuration id

notAvailableItemStatuses
Array of strings

A list of FOLIO item states that should be considered "Not available"

nonLendableLoanTypes
Array of strings <UUID> [ items <UUID > ]

A list of FOLIO loan types that should be considered non-lendable

nonLendableLocations
Array of strings <UUID> [ items <UUID > ]

A list of FOLIO locations whose items should be considered non-lendable

nonLendableMaterialTypes
Array of strings <UUID> [ items <UUID > ]

A list of FOLIO material types that should be considered non-lendable

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "notAvailableItemStatuses": [
    ],
  • "nonLendableLoanTypes": [
    ],
  • "nonLendableLocations": [
    ],
  • "nonLendableMaterialTypes": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "notAvailableItemStatuses": [
    ],
  • "nonLendableLoanTypes": [
    ],
  • "nonLendableLocations": [
    ],
  • "nonLendableMaterialTypes": [
    ],
  • "metadata": {
    }
}

agency-mappings

getAgencyMappingsByServerId

Get a list of Inn-Reach Agency to FOLIO location mappings for the given central server

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "libraryId": "6780430a-772c-4fd6-a7b1-5dc852e6898f",
  • "localServers": [
    ],
  • "metadata": {
    }
}

putAgencyMappings

Update (add) INN-Reach Agency to FOLIO location mappings associated with the central server

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>

Mapping id

locationId
required
string <uuid>

Location id

libraryId
required
string <uuid>

Location id

Array of objects (agencyLocationLscMappingDTO)

Local server mappings

Array
id
string <uuid>

Mapping id

localCode
required
string <= 5 characters

Local server code

locationId
string <uuid>

Location id

libraryId
string <uuid>

Location id

Array of objects (agencyLocationAcMappingDTO)

Agency code mappings

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
  • "libraryId": "6780430a-772c-4fd6-a7b1-5dc852e6898f",
  • "localServers": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

M-A-R-C-transformation-options-settings

getMARCTransformationOptionsSettingsById

Get MARC Transformation Options Settings by id

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "configIsActive": true,
  • "modifiedFieldsForContributedRecords": [
    ],
  • "excludedMARCFields": [
    ],
  • "metadata": {
    }
}

updateMARCTransformationOptionsSettings

Update MARC Transformation Options Settings

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
id
string <UUID>

MARC Transformation Options Settings id

configIsActive
boolean

A Boolean indicating whether the configuration is active

Array of objects (fieldConfigurationDTO)

An ordered array of field configurations

Array
id
string <UUID>

Field configuration id

resourceIdentifierTypeId
string <UUID>

Resource identifier type id

stripPrefix
boolean

Strip prefix

ignorePrefixes
Array of strings

Array of strings that if present as prefixes will cause the identifier to be ignored

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

excludedMARCFields
Array of strings

An array of MARC fields/subfields to exclude from transformed MARC records

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "configIsActive": true,
  • "modifiedFieldsForContributedRecords": [
    ],
  • "excludedMARCFields": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

createMARCTransformationOptionsSettings

Add new MARC Transformation Options Settings associated with the central server

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
id
string <UUID>

MARC Transformation Options Settings id

configIsActive
boolean

A Boolean indicating whether the configuration is active

Array of objects (fieldConfigurationDTO)

An ordered array of field configurations

Array
id
string <UUID>

Field configuration id

resourceIdentifierTypeId
string <UUID>

Resource identifier type id

stripPrefix
boolean

Strip prefix

ignorePrefixes
Array of strings

Array of strings that if present as prefixes will cause the identifier to be ignored

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

excludedMARCFields
Array of strings

An array of MARC fields/subfields to exclude from transformed MARC records

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "configIsActive": true,
  • "modifiedFieldsForContributedRecords": [
    ],
  • "excludedMARCFields": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "configIsActive": true,
  • "modifiedFieldsForContributedRecords": [
    ],
  • "excludedMARCFields": [
    ],
  • "metadata": {
    }
}

deleteMARCTransformationOptionsSettings

Delete Marc Transformation Options Settings

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string"
}

getAllMARCTransformationOptionsSettings

Get a list of Marc Transformation Options Settings

query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 0,
  • "MARCTransformOptSetList": [
    ]
}

patron-type-mapping

getPatronTypeMappingsByServerId

Get a list of Patron Type Mappings

path Parameters
centralServerId
required
string <uuid>
query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "patronTypeMappings": [
    ],
  • "totalRecords": 0
}

updatePatronTypeMappings

Update Patron Type Mappings

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (patronTypeMappingDTO)

List of patron type mappings

Array
id
string <uuid>

Mapping id

patronGroupId
required
string <uuid>

Patron group id

patronType
required
integer [ 0 .. 255 ]

Patron type

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

totalRecords
integer

Responses

Request samples

Content type
application/json
{
  • "patronTypeMappings": [
    ],
  • "totalRecords": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

M-A-R-C-transformation-records

transformMARCRecord

Transform MARC record by Id according to CentralServer settings

path Parameters
centralServerId
required
string <uuid>
inventoryInstanceId
required
string <uuid> (UUID)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "content": "string",
  • "base64rawContent": "string"
}

item-type-mappings

getItemTypeMappingsByServerId

Get a list of Item Type Mappings

path Parameters
centralServerId
required
string <uuid>
query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "itemTypeMappings": [
    ],
  • "totalRecords": 0
}

updateItemTypeMappings

Update Item Type Mappings

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (itemTypeMappingDTO)

List of item type mappings

Array
id
string <uuid>

Mapping id

centralItemType
required
integer [ 0 .. 255 ]

Central item type

materialTypeId
required
string <uuid>

Material type id

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

totalRecords
integer

Responses

Request samples

Content type
application/json
{
  • "itemTypeMappings": [
    ],
  • "totalRecords": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

user-custom-field-mappings

getUserCustomFieldMapping

Get a User Custom Field Mapping

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customFieldId": "string",
  • "configuredOptions": {
    },
  • "metadata": {
    }
}

updateUserCustomFieldMapping

Update User Custom Field Mapping

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>

Mapping id

customFieldId
required
string

Custom field refId

required
object

Map of the option ids for the custom field and local agency codes

property name*
additional property
string
object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customFieldId": "string",
  • "configuredOptions": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

createUserCustomFieldMapping

Add new User Custom Field Mapping associated with the central server

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>

Mapping id

customFieldId
required
string

Custom field refId

required
object

Map of the option ids for the custom field and local agency codes

property name*
additional property
string
object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customFieldId": "string",
  • "configuredOptions": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customFieldId": "string",
  • "configuredOptions": {
    },
  • "metadata": {
    }
}

central-patron-type-mappings

getCentralPatronTypeMappings

Get a list of Central Patron Type Mappings

path Parameters
centralServerId
required
string <uuid>
query Parameters
offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 10

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "centralPatronTypeMappings": [
    ],
  • "totalRecords": 0
}

updateCentralPatronTypeMappings

Update Central Patron Type Mappings

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
required
Array of objects (centralPatronTypeMappingDTO)

List of central patron type mappings

Array
id
string <uuid>

Mapping id

centralPatronType
required
integer [ 0 .. 255 ]

Central patron type

barcode
required
string

Folio user barcode

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

totalRecords
integer

Responses

Request samples

Content type
application/json
{
  • "centralPatronTypeMappings": [
    ],
  • "totalRecords": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

inn-reach-recall-user

saveInnReachRecallUser

Add new Inn-Reach recall user to central server

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
userId
required
string <uuid>

User id

Responses

Request samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

getCentralServerRecallUser

Get Inn-Reach Central server recall user

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

updateCentralServerRecallUser

Update Inn-Reach Central server recall user

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
userId
required
string <uuid>

User id

Responses

Request samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

visible-patron-field-configuration

getConfigurationByCentralServerId

Get Visible Patron Field Configuration by Central Server id

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ],
  • "userCustomFields": [
    ],
  • "metadata": {
    }
}

updateConfiguration

Update Visible Patron Field Configuration

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
id
string <UUID>

Visible Patron Field Configuration id

fields
Array of strings (Visible Patron Field enum)
Items Enum: "BARCODE" "EXTERNAL_SYSTEM_ID" "FOLIO_RECORD_NUMBER" "USERNAME" "USER_CUSTOM_FIELDS"

An array of Visible Patron Fields

userCustomFields
Array of strings

An array of User Custom Fields refIds

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ],
  • "userCustomFields": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

createConfiguration

Add new Visible Patron Field Configuration associated with the central server

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
required
id
string <UUID>

Visible Patron Field Configuration id

fields
Array of strings (Visible Patron Field enum)
Items Enum: "BARCODE" "EXTERNAL_SYSTEM_ID" "FOLIO_RECORD_NUMBER" "USERNAME" "USER_CUSTOM_FIELDS"

An array of Visible Patron Fields

userCustomFields
Array of strings

An array of User Custom Fields refIds

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ],
  • "userCustomFields": [
    ],
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ],
  • "userCustomFields": [
    ],
  • "metadata": {
    }
}

paging-slip-template

getPagingSlipTemplate

Get Paging Slip Template

path Parameters
centralServerId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "centralServerId": "string",
  • "description": "string",
  • "template": "string",
  • "metadata": {
    }
}

updatePagingSlipTemplate

Update Paging Slip Template

path Parameters
centralServerId
required
string <uuid>
Request Body schema: application/json
id
string <UUID>

Paging Slip Template id

centralServerId
string <UUID>

Central server id

description
string

Paging Slip Template description

template
string

Paging Slip Template template

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who created the record (when available)

createdByUsername
string

Username of the user who created the record (when available)

updatedDate
string <date-time>

Date and time when the record was last updated

updatedByUserId
string^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}...

ID of the user who last updated the record (when available)

updatedByUsername
string

Username of the user who last updated the record (when available)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "centralServerId": "string",
  • "description": "string",
  • "template": "string",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string",
  • "validationErrors": [
    ]
}

getAllPagingSlipTemplates

Get list of Paging Slip Templates

Responses

Response samples

Content type
application/json
{
  • "totalRecords": 0,
  • "pagingSlipTemplates": [
    ]
}