foliolib.folio.api.marccat.Marccat

class foliolib.folio.api.marccat.Marccat(tenant: str, okapi: Optional[foliolib.okapi.okapiClient.OkapiClient] = None)

Bases: foliolib.folio.FolioApi

MARCcat API

This documents the API calls for interacting with an marc authority or bibliographic record

Parameters

tenant (str) – Tenant id
okapi (OkapiClient, optional) – Instance of OkapiClient. Defaults to None.

Methods

`delete_authorityRecords`()	Delete authorityRecord item with given {authorityRecordId}
`delete_searchAuths`()	Delete searchAuth item with given {searchAuthId}
`delete_searchVerticals`()	Delete searchVertical item with given {searchVerticalId}
`delete_searches`()	Delete search item with given {searchId}
`get_authFixedFieldsCodeGroups`()	Get authority record template
`get_authHeaderTypes`()	Get the value for the header type of 008 authority tag
`get_authorityRecord`(idRecord)	Retrieve a list of authorityRecord items.
`get_authorityRecords`(**kwargs)	Return a list of marc authority records and search metadata
`get_fixedFieldDisplayValues`()	Get authority record template
`get_fromTemplate`(idTemplate)	Get authority record template
`get_mergedSearches`(**kwargs)	Return a list of marc records and search metadata
`get_searchAuths`(**kwargs)	Return a list of marc authority records and search metadata
`get_searchVerticals`(**kwargs)	Return a list of marc records in text formats
`get_searches`(**kwargs)	Return a list of marc records and search metadata
`modify_authorityRecord`(authorityRecord)	Update authorityRecord item with given {authorityRecordId}
`modify_search`(search)	Update search item with given {searchId}
`modify_searchAuth`(searchAuth)	Update searchAuth item with given {searchAuthId}
`modify_searchVertical`(searchVertical)	Update searchVertical item with given {searchVerticalId}
`set_authFixedFieldsCodeGroup`()	`POST /marccat/auth-fixed-fields-code-groups`
`set_authHeaderType`()	`POST /marccat/auth-header-types`
`set_authorityRecord`()	`POST /marccat/authority-record`
`set_authorityRecord_for_idRecord`(idRecord)	`POST /marccat/authority-record/{idRecord}`
`set_fixedFieldDisplayValue`()	`POST /marccat/authority-record/fixed-field-display-value`
`set_fromTemplate`(idTemplate)	`POST /marccat/authority-record/from-template/{idTemplate}`
`set_mergedSearch`(mergedSearch)	Create a new mergedSearch item.

delete_authorityRecords()

Delete authorityRecord item with given {authorityRecordId}

DELETE /marccat/authority-record

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

delete_searchAuths()

Delete searchAuth item with given {searchAuthId}

DELETE /marccat/searchAuth

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

delete_searchVerticals()

Delete searchVertical item with given {searchVerticalId}

DELETE /marccat/searchVertical

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

delete_searches()

Delete search item with given {searchId}

DELETE /marccat/search

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

get_authFixedFieldsCodeGroups()

Get authority record template

GET /marccat/auth-fixed-fields-code-groups

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "authority schema",
  "type": "object",
  "description": "authority metadata",
  "properties": {
    "id": {
      "type": "integer",
      "description": "authority id"
    },
    "canadianContentIndicator": {
      "type": "string",
      "description": "MARC organization codes: 0-LOC, 1-Canadian"
    },
    "verificationLevel": {
      "type": "string",
      "description": "verification level"
    },
    "leader": {
      "type": "object",
      "description": "marc leader of the record",
      "properties": {
        "code": {
          "type": "string",
          "description": "marc leader code (000)"
        },
        "value": {
          "type": "string",
          "description": "marc leader value"
        }
      },
      "required": [
        "code",
        "value"
      ]
    },
    "fields": {
      "description": "fields of record",
      "type": "array",
      "items": [
        {
          "type": "object",
          "description": "tag description",
          "properties": {
            "code": {
              "type": "string",
              "description": "marc tag"
            },
            "mandatory": {
              "type": "boolean",
              "description": "tag mandatory or not"
            },
            "fieldStatus": {
              "type": "string",
              "description": "status of the tag: unchanged, changed, new, deleted"
            },
            "fixedField": {
              "type": "object",
              "description": "control field values",
              "$ref": "fixedField.json"
            },
            "variableField": {
              "type": "object",
              "description": "variable field values",
              "$ref": "variableField.json"
            },
            "added": {
              "type": "boolean",
              "description": "tag is new or not"
            }
          },
          "required": [
            "code",
            "mandatory",
            "fieldStatus",
            "added"
          ]
        }
      ]
    },
    "recordView": {
      "type": "integer",
      "description": "view of the record"
    }
  },
  "required": [
    "id",
    "canadianContentIndicator",
    "verificationLevel",
    "leader",
    "fields",
    "recordView"
  ]
}

get_authHeaderTypes()

Get the value for the header type of 008 authority tag

GET /marccat/auth-header-types

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "authority header type for 008 tag",
  "type": "object",
  "description": "the values for header type for the code 008 tag",
  "properties": {
    "headingTypes": {
      "type": "array",
      "description": "list of heading types values",
      "items": [
        {
          "type": "object",
          "description": "heading types for 008 tag",
          "properties": {
            "value": {
              "type": "integer",
              "description": "the header type value"
            },
            "label": {
              "type": "string",
              "description": "the header type label"
            }
          },
          "required": [
            "value",
            "label"
          ]
        }
      ]
    }
  },
  "required": [
    "headingTypes"
  ]
}

get_authorityRecord(idRecord: str)

Retrieve a list of authorityRecord items.

GET /marccat/authority-record/{idRecord}

Parameters

idRecord (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "authority schema",
  "type": "object",
  "description": "authority metadata",
  "properties": {
    "id": {
      "type": "integer",
      "description": "authority id"
    },
    "canadianContentIndicator": {
      "type": "string",
      "description": "MARC organization codes: 0-LOC, 1-Canadian"
    },
    "verificationLevel": {
      "type": "string",
      "description": "verification level"
    },
    "leader": {
      "type": "object",
      "description": "marc leader of the record",
      "properties": {
        "code": {
          "type": "string",
          "description": "marc leader code (000)"
        },
        "value": {
          "type": "string",
          "description": "marc leader value"
        }
      },
      "required": [
        "code",
        "value"
      ]
    },
    "fields": {
      "description": "fields of record",
      "type": "array",
      "items": [
        {
          "type": "object",
          "description": "tag description",
          "properties": {
            "code": {
              "type": "string",
              "description": "marc tag"
            },
            "mandatory": {
              "type": "boolean",
              "description": "tag mandatory or not"
            },
            "fieldStatus": {
              "type": "string",
              "description": "status of the tag: unchanged, changed, new, deleted"
            },
            "fixedField": {
              "type": "object",
              "description": "control field values",
              "$ref": "fixedField.json"
            },
            "variableField": {
              "type": "object",
              "description": "variable field values",
              "$ref": "variableField.json"
            },
            "added": {
              "type": "boolean",
              "description": "tag is new or not"
            }
          },
          "required": [
            "code",
            "mandatory",
            "fieldStatus",
            "added"
          ]
        }
      ]
    },
    "recordView": {
      "type": "integer",
      "description": "view of the record"
    }
  },
  "required": [
    "id",
    "canadianContentIndicator",
    "verificationLevel",
    "leader",
    "fields",
    "recordView"
  ]
}

get_authorityRecords(**kwargs)

Return a list of marc authority records and search metadata

GET /marccat/authority-record

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10
query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

using CCL query in q parameter

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- q=na “giannini”

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error
OkapiRequestError – Bad Request

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "authority schema",
  "type": "object",
  "description": "authority metadata",
  "properties": {
    "id": {
      "type": "integer",
      "description": "authority id"
    },
    "canadianContentIndicator": {
      "type": "string",
      "description": "MARC organization codes: 0-LOC, 1-Canadian"
    },
    "verificationLevel": {
      "type": "string",
      "description": "verification level"
    },
    "leader": {
      "type": "object",
      "description": "marc leader of the record",
      "properties": {
        "code": {
          "type": "string",
          "description": "marc leader code (000)"
        },
        "value": {
          "type": "string",
          "description": "marc leader value"
        }
      },
      "required": [
        "code",
        "value"
      ]
    },
    "fields": {
      "description": "fields of record",
      "type": "array",
      "items": [
        {
          "type": "object",
          "description": "tag description",
          "properties": {
            "code": {
              "type": "string",
              "description": "marc tag"
            },
            "mandatory": {
              "type": "boolean",
              "description": "tag mandatory or not"
            },
            "fieldStatus": {
              "type": "string",
              "description": "status of the tag: unchanged, changed, new, deleted"
            },
            "fixedField": {
              "type": "object",
              "description": "control field values",
              "$ref": "fixedField.json"
            },
            "variableField": {
              "type": "object",
              "description": "variable field values",
              "$ref": "variableField.json"
            },
            "added": {
              "type": "boolean",
              "description": "tag is new or not"
            }
          },
          "required": [
            "code",
            "mandatory",
            "fieldStatus",
            "added"
          ]
        }
      ]
    },
    "recordView": {
      "type": "integer",
      "description": "view of the record"
    }
  },
  "required": [
    "id",
    "canadianContentIndicator",
    "verificationLevel",
    "leader",
    "fields",
    "recordView"
  ]
}

get_fixedFieldDisplayValues()

Get authority record template

GET /marccat/authority-record/fixed-field-display-value

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "authority schema",
  "type": "object",
  "description": "authority metadata",
  "properties": {
    "id": {
      "type": "integer",
      "description": "authority id"
    },
    "canadianContentIndicator": {
      "type": "string",
      "description": "MARC organization codes: 0-LOC, 1-Canadian"
    },
    "verificationLevel": {
      "type": "string",
      "description": "verification level"
    },
    "leader": {
      "type": "object",
      "description": "marc leader of the record",
      "properties": {
        "code": {
          "type": "string",
          "description": "marc leader code (000)"
        },
        "value": {
          "type": "string",
          "description": "marc leader value"
        }
      },
      "required": [
        "code",
        "value"
      ]
    },
    "fields": {
      "description": "fields of record",
      "type": "array",
      "items": [
        {
          "type": "object",
          "description": "tag description",
          "properties": {
            "code": {
              "type": "string",
              "description": "marc tag"
            },
            "mandatory": {
              "type": "boolean",
              "description": "tag mandatory or not"
            },
            "fieldStatus": {
              "type": "string",
              "description": "status of the tag: unchanged, changed, new, deleted"
            },
            "fixedField": {
              "type": "object",
              "description": "control field values",
              "$ref": "fixedField.json"
            },
            "variableField": {
              "type": "object",
              "description": "variable field values",
              "$ref": "variableField.json"
            },
            "added": {
              "type": "boolean",
              "description": "tag is new or not"
            }
          },
          "required": [
            "code",
            "mandatory",
            "fieldStatus",
            "added"
          ]
        }
      ]
    },
    "recordView": {
      "type": "integer",
      "description": "view of the record"
    }
  },
  "required": [
    "id",
    "canadianContentIndicator",
    "verificationLevel",
    "leader",
    "fields",
    "recordView"
  ]
}

get_fromTemplate(idTemplate: str)

Get authority record template

GET /marccat/authority-record/from-template/{idTemplate}

Parameters

idTemplate (str) –

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiFatalError – Server Error
OkapiRequestUnprocessableEntity – Unprocessable Entity

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "authority schema",
  "type": "object",
  "description": "authority metadata",
  "properties": {
    "id": {
      "type": "integer",
      "description": "authority id"
    },
    "canadianContentIndicator": {
      "type": "string",
      "description": "MARC organization codes: 0-LOC, 1-Canadian"
    },
    "verificationLevel": {
      "type": "string",
      "description": "verification level"
    },
    "leader": {
      "type": "object",
      "description": "marc leader of the record",
      "properties": {
        "code": {
          "type": "string",
          "description": "marc leader code (000)"
        },
        "value": {
          "type": "string",
          "description": "marc leader value"
        }
      },
      "required": [
        "code",
        "value"
      ]
    },
    "fields": {
      "description": "fields of record",
      "type": "array",
      "items": [
        {
          "type": "object",
          "description": "tag description",
          "properties": {
            "code": {
              "type": "string",
              "description": "marc tag"
            },
            "mandatory": {
              "type": "boolean",
              "description": "tag mandatory or not"
            },
            "fieldStatus": {
              "type": "string",
              "description": "status of the tag: unchanged, changed, new, deleted"
            },
            "fixedField": {
              "type": "object",
              "description": "control field values",
              "$ref": "fixedField.json"
            },
            "variableField": {
              "type": "object",
              "description": "variable field values",
              "$ref": "variableField.json"
            },
            "added": {
              "type": "boolean",
              "description": "tag is new or not"
            }
          },
          "required": [
            "code",
            "mandatory",
            "fieldStatus",
            "added"
          ]
        }
      ]
    },
    "recordView": {
      "type": "integer",
      "description": "view of the record"
    }
  },
  "required": [
    "id",
    "canadianContentIndicator",
    "verificationLevel",
    "leader",
    "fields",
    "recordView"
  ]
}

get_mergedSearches(**kwargs)

Return a list of marc records and search metadata

GET /marccat/mergedSearch

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10
query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

using CCL query in q parameter

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- q=na “manzoni, alessandro”

Returns

See Schema below

Return type

dict

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "description": "collection of search results",
  "items": {
    "type": "object",
    "$ref": "searchResult.json"
  }
}

get_searchAuths(**kwargs)

Return a list of marc authority records and search metadata

GET /marccat/searchAuth

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10
query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

using CCL query in q parameter

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- q=na “giannini”

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error
OkapiRequestError – Bad Request

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Search result",
  "type": "object",
  "description": "search metadata and result list",
  "additionalProperties": false,
  "properties": {
    "searchingView": {
      "description": "Type of record inside the result list. 1 for Bibliographic records, -1 for authority",
      "type": "integer"
    },
    "displayQuery": {
      "description": "query that produced result list",
      "type": "string"
    },
    "from": {
      "description": "Specifies an offset into a query\u2019s result set to begin displaying results from this offset",
      "type": "integer"
    },
    "to": {
      "description": "Pagination properties. Specifies the end of offset into a query\u2019s result set to stop displaying results",
      "type": "integer"
    },
    "numFound": {
      "description": "count of result founded",
      "type": "integer"
    },
    "docs": {
      "description": "result list",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "recordView": {
            "description": "record type. 1 for Bibliographic records, -1 for authority",
            "type": "integer",
            "pattern": "/[1,-1]{1}/"
          },
          "countDoc": {
            "description": "count of bibliographic records associated to the current record",
            "type": "integer"
          },
          "queryForAssociatedDoc": {
            "description": "query to retrieve records associated to the current one",
            "type": "string"
          }
        },
        "tagHighlighted": {
          "description": "list of tag in which query terms are present",
          "type": "string"
        },
        "data": {
          "description": "marc record",
          "type": "object",
          "properties": {
            "leader": {
              "description": "marc leader of the record",
              "type": "string"
            },
            "fields": {
              "description": "fields of record",
              "type": "array",
              "items": {
                "type": "object",
                "$ref": "field.json"
              }
            }
          }
        }
      }
    }
  },
  "metadata": {
    "description": "Metadata about creation and changes to marc record, provided by the server (client should not provide)",
    "type": "object",
    "$ref": "../raml-storage/raml-util/schemas/metadata.schema"
  }
}

get_searchVerticals(**kwargs)

Return a list of marc records in text formats

GET /marccat/searchVertical

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10
query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

using CCL query in q parameter and choosing authority or bibliographic in view parameter

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- q=na “manzoni, alessandro”&view=1

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error
OkapiRequestError – Bad Request

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Search result in marc text",
  "type": "object",
  "description": "search metadata and result list",
  "additionalProperties": false,
  "properties": {
    "searchingView": {
      "description": "Type of record inside the result list. 1 for Bibliographic records, -1 for authority",
      "type": "integer"
    },
    "displayQuery": {
      "description": "query that produced result list",
      "type": "string"
    },
    "from": {
      "description": "Specifies an offset into a query\u2019s result set to begin displaying results from this offset",
      "type": "integer"
    },
    "to": {
      "description": "Pagination properties. Specifies the end of offset into a query\u2019s result set to stop displaying results",
      "type": "integer"
    },
    "numFound": {
      "description": "count of result founded",
      "type": "integer"
    },
    "docs": {
      "description": "result list",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "recordView": {
            "description": "record type. 1 for Bibliographic records, -1 for authority",
            "type": "integer",
            "pattern": "/[1,-1]{1}/"
          },
          "countDoc": {
            "description": "count of bibliographic records associated to the current record",
            "type": "integer"
          },
          "queryForAssociatedDoc": {
            "description": "query to retrieve records associated to the current one",
            "type": "string"
          }
        },
        "tagHighlighted": {
          "description": "list of tag in which query terms are present",
          "type": "string"
        },
        "data": {
          "description": "marc record in text form",
          "type": "string"
        }
      }
    }
  },
  "metadata": {
    "description": "Metadata about creation and changes to marc record, provided by the server (client should not provide)",
    "type": "object",
    "$ref": "../raml-storage/raml-util/schemas/metadata.schema"
  }
}

get_searches(**kwargs)

Return a list of marc records and search metadata

GET /marccat/search

Parameters

**kwargs (properties) – Keyword Arguments

Keyword Arguments

offset (int) –
(default=0) Skip over a number of elements by specifying an offset value for the query

Example
- 0
limit (int) –
(default=10) Limit the number of elements returned in the response

Example
- 10
query (str) –
A query expressed as a CQL string (see [dev.folio.org/reference/glossary#cql](https://dev.folio.org/reference/glossary#cql)) using valid searchable fields. The first example below shows the general form of a full CQL query, but those fields might not be relevant in this context.

using CCL query in q parameter and choosing authority or bibliographic in view parameter

Example
- (username==”ab*” or personal.firstName==”ab*” or personal.lastName==”ab*”) and active==”true” sortby personal.lastName personal.firstName barcode
- q=na “manzoni, alessandro”&view=1

Returns

See Schema below

Return type

dict

Raises

OkapiRequestNotFound – Not Found
OkapiFatalError – Server Error
OkapiRequestError – Bad Request

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Search result",
  "type": "object",
  "description": "search metadata and result list",
  "additionalProperties": false,
  "properties": {
    "searchingView": {
      "description": "Type of record inside the result list. 1 for Bibliographic records, -1 for authority",
      "type": "integer"
    },
    "displayQuery": {
      "description": "query that produced result list",
      "type": "string"
    },
    "from": {
      "description": "Specifies an offset into a query\u2019s result set to begin displaying results from this offset",
      "type": "integer"
    },
    "to": {
      "description": "Pagination properties. Specifies the end of offset into a query\u2019s result set to stop displaying results",
      "type": "integer"
    },
    "numFound": {
      "description": "count of result founded",
      "type": "integer"
    },
    "docs": {
      "description": "result list",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "recordView": {
            "description": "record type. 1 for Bibliographic records, -1 for authority",
            "type": "integer",
            "pattern": "/[1,-1]{1}/"
          },
          "countDoc": {
            "description": "count of bibliographic records associated to the current record",
            "type": "integer"
          },
          "queryForAssociatedDoc": {
            "description": "query to retrieve records associated to the current one",
            "type": "string"
          }
        },
        "tagHighlighted": {
          "description": "list of tag in which query terms are present",
          "type": "string"
        },
        "data": {
          "description": "marc record",
          "type": "object",
          "properties": {
            "leader": {
              "description": "marc leader of the record",
              "type": "string"
            },
            "fields": {
              "description": "fields of record",
              "type": "array",
              "items": {
                "type": "object",
                "$ref": "field.json"
              }
            }
          }
        }
      }
    }
  },
  "metadata": {
    "description": "Metadata about creation and changes to marc record, provided by the server (client should not provide)",
    "type": "object",
    "$ref": "../raml-storage/raml-util/schemas/metadata.schema"
  }
}

modify_authorityRecord(authorityRecord: dict)

Update authorityRecord item with given {authorityRecordId}

PUT /marccat/authority-record

Parameters

authorityRecord (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "authority schema",
  "type": "object",
  "description": "authority metadata",
  "properties": {
    "id": {
      "type": "integer",
      "description": "authority id"
    },
    "canadianContentIndicator": {
      "type": "string",
      "description": "MARC organization codes: 0-LOC, 1-Canadian"
    },
    "verificationLevel": {
      "type": "string",
      "description": "verification level"
    },
    "leader": {
      "type": "object",
      "description": "marc leader of the record",
      "properties": {
        "code": {
          "type": "string",
          "description": "marc leader code (000)"
        },
        "value": {
          "type": "string",
          "description": "marc leader value"
        }
      },
      "required": [
        "code",
        "value"
      ]
    },
    "fields": {
      "description": "fields of record",
      "type": "array",
      "items": [
        {
          "type": "object",
          "description": "tag description",
          "properties": {
            "code": {
              "type": "string",
              "description": "marc tag"
            },
            "mandatory": {
              "type": "boolean",
              "description": "tag mandatory or not"
            },
            "fieldStatus": {
              "type": "string",
              "description": "status of the tag: unchanged, changed, new, deleted"
            },
            "fixedField": {
              "type": "object",
              "description": "control field values",
              "$ref": "fixedField.json"
            },
            "variableField": {
              "type": "object",
              "description": "variable field values",
              "$ref": "variableField.json"
            },
            "added": {
              "type": "boolean",
              "description": "tag is new or not"
            }
          },
          "required": [
            "code",
            "mandatory",
            "fieldStatus",
            "added"
          ]
        }
      ]
    },
    "recordView": {
      "type": "integer",
      "description": "view of the record"
    }
  },
  "required": [
    "id",
    "canadianContentIndicator",
    "verificationLevel",
    "leader",
    "fields",
    "recordView"
  ]
}

modify_search(search: dict)

Update search item with given {searchId}

PUT /marccat/search

Parameters

search (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Search result",
  "type": "object",
  "description": "search metadata and result list",
  "additionalProperties": false,
  "properties": {
    "searchingView": {
      "description": "Type of record inside the result list. 1 for Bibliographic records, -1 for authority",
      "type": "integer"
    },
    "displayQuery": {
      "description": "query that produced result list",
      "type": "string"
    },
    "from": {
      "description": "Specifies an offset into a query\u2019s result set to begin displaying results from this offset",
      "type": "integer"
    },
    "to": {
      "description": "Pagination properties. Specifies the end of offset into a query\u2019s result set to stop displaying results",
      "type": "integer"
    },
    "numFound": {
      "description": "count of result founded",
      "type": "integer"
    },
    "docs": {
      "description": "result list",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "recordView": {
            "description": "record type. 1 for Bibliographic records, -1 for authority",
            "type": "integer",
            "pattern": "/[1,-1]{1}/"
          },
          "countDoc": {
            "description": "count of bibliographic records associated to the current record",
            "type": "integer"
          },
          "queryForAssociatedDoc": {
            "description": "query to retrieve records associated to the current one",
            "type": "string"
          }
        },
        "tagHighlighted": {
          "description": "list of tag in which query terms are present",
          "type": "string"
        },
        "data": {
          "description": "marc record",
          "type": "object",
          "properties": {
            "leader": {
              "description": "marc leader of the record",
              "type": "string"
            },
            "fields": {
              "description": "fields of record",
              "type": "array",
              "items": {
                "type": "object",
                "$ref": "field.json"
              }
            }
          }
        }
      }
    }
  },
  "metadata": {
    "description": "Metadata about creation and changes to marc record, provided by the server (client should not provide)",
    "type": "object",
    "$ref": "../raml-storage/raml-util/schemas/metadata.schema"
  }
}

modify_searchAuth(searchAuth: dict)

Update searchAuth item with given {searchAuthId}

PUT /marccat/searchAuth

Parameters

searchAuth (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Search result",
  "type": "object",
  "description": "search metadata and result list",
  "additionalProperties": false,
  "properties": {
    "searchingView": {
      "description": "Type of record inside the result list. 1 for Bibliographic records, -1 for authority",
      "type": "integer"
    },
    "displayQuery": {
      "description": "query that produced result list",
      "type": "string"
    },
    "from": {
      "description": "Specifies an offset into a query\u2019s result set to begin displaying results from this offset",
      "type": "integer"
    },
    "to": {
      "description": "Pagination properties. Specifies the end of offset into a query\u2019s result set to stop displaying results",
      "type": "integer"
    },
    "numFound": {
      "description": "count of result founded",
      "type": "integer"
    },
    "docs": {
      "description": "result list",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "recordView": {
            "description": "record type. 1 for Bibliographic records, -1 for authority",
            "type": "integer",
            "pattern": "/[1,-1]{1}/"
          },
          "countDoc": {
            "description": "count of bibliographic records associated to the current record",
            "type": "integer"
          },
          "queryForAssociatedDoc": {
            "description": "query to retrieve records associated to the current one",
            "type": "string"
          }
        },
        "tagHighlighted": {
          "description": "list of tag in which query terms are present",
          "type": "string"
        },
        "data": {
          "description": "marc record",
          "type": "object",
          "properties": {
            "leader": {
              "description": "marc leader of the record",
              "type": "string"
            },
            "fields": {
              "description": "fields of record",
              "type": "array",
              "items": {
                "type": "object",
                "$ref": "field.json"
              }
            }
          }
        }
      }
    }
  },
  "metadata": {
    "description": "Metadata about creation and changes to marc record, provided by the server (client should not provide)",
    "type": "object",
    "$ref": "../raml-storage/raml-util/schemas/metadata.schema"
  }
}

modify_searchVertical(searchVertical: dict)

Update searchVertical item with given {searchVerticalId}

PUT /marccat/searchVertical

Parameters

searchVertical (dict) – See Schema below

Raises

OkapiRequestNotFound – Not Found
OkapiRequestError – Bad Request
OkapiFatalError – Server Error

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Search result in marc text",
  "type": "object",
  "description": "search metadata and result list",
  "additionalProperties": false,
  "properties": {
    "searchingView": {
      "description": "Type of record inside the result list. 1 for Bibliographic records, -1 for authority",
      "type": "integer"
    },
    "displayQuery": {
      "description": "query that produced result list",
      "type": "string"
    },
    "from": {
      "description": "Specifies an offset into a query\u2019s result set to begin displaying results from this offset",
      "type": "integer"
    },
    "to": {
      "description": "Pagination properties. Specifies the end of offset into a query\u2019s result set to stop displaying results",
      "type": "integer"
    },
    "numFound": {
      "description": "count of result founded",
      "type": "integer"
    },
    "docs": {
      "description": "result list",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "recordView": {
            "description": "record type. 1 for Bibliographic records, -1 for authority",
            "type": "integer",
            "pattern": "/[1,-1]{1}/"
          },
          "countDoc": {
            "description": "count of bibliographic records associated to the current record",
            "type": "integer"
          },
          "queryForAssociatedDoc": {
            "description": "query to retrieve records associated to the current one",
            "type": "string"
          }
        },
        "tagHighlighted": {
          "description": "list of tag in which query terms are present",
          "type": "string"
        },
        "data": {
          "description": "marc record in text form",
          "type": "string"
        }
      }
    }
  },
  "metadata": {
    "description": "Metadata about creation and changes to marc record, provided by the server (client should not provide)",
    "type": "object",
    "$ref": "../raml-storage/raml-util/schemas/metadata.schema"
  }
}

set_authFixedFieldsCodeGroup(): POST /marccat/auth-fixed-fields-code-groups

set_authHeaderType(): POST /marccat/auth-header-types

set_authorityRecord(): POST /marccat/authority-record

set_authorityRecord_for_idRecord(idRecord: str)

POST /marccat/authority-record/{idRecord}

Parameters: idRecord (str) –

set_fixedFieldDisplayValue(): POST /marccat/authority-record/fixed-field-display-value

set_fromTemplate(idTemplate: str)

POST /marccat/authority-record/from-template/{idTemplate}

Parameters: idTemplate (str) –

set_mergedSearch(mergedSearch: dict)

Create a new mergedSearch item.

POST /marccat/mergedSearch

Parameters

mergedSearch (dict) – See Schema below

Raises

OkapiRequestError – Bad Request
OkapiRequestUnauthorized – Authentication is required
OkapiFatalError – Server Error

Headers

Location - URI to the created mergedSearch item

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Search result",
  "type": "object",
  "description": "search metadata and result list",
  "additionalProperties": false,
  "properties": {
    "searchingView": {
      "description": "Type of record inside the result list. 1 for Bibliographic records, -1 for authority",
      "type": "integer"
    },
    "displayQuery": {
      "description": "query that produced result list",
      "type": "string"
    },
    "from": {
      "description": "Specifies an offset into a query\u2019s result set to begin displaying results from this offset",
      "type": "integer"
    },
    "to": {
      "description": "Pagination properties. Specifies the end of offset into a query\u2019s result set to stop displaying results",
      "type": "integer"
    },
    "numFound": {
      "description": "count of result founded",
      "type": "integer"
    },
    "docs": {
      "description": "result list",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "recordView": {
            "description": "record type. 1 for Bibliographic records, -1 for authority",
            "type": "integer",
            "pattern": "/[1,-1]{1}/"
          },
          "countDoc": {
            "description": "count of bibliographic records associated to the current record",
            "type": "integer"
          },
          "queryForAssociatedDoc": {
            "description": "query to retrieve records associated to the current one",
            "type": "string"
          }
        },
        "tagHighlighted": {
          "description": "list of tag in which query terms are present",
          "type": "string"
        },
        "data": {
          "description": "marc record",
          "type": "object",
          "properties": {
            "leader": {
              "description": "marc leader of the record",
              "type": "string"
            },
            "fields": {
              "description": "fields of record",
              "type": "array",
              "items": {
                "type": "object",
                "$ref": "field.json"
              }
            }
          }
        }
      }
    }
  },
  "metadata": {
    "description": "Metadata about creation and changes to marc record, provided by the server (client should not provide)",
    "type": "object",
    "$ref": "../raml-storage/raml-util/schemas/metadata.schema"
  }
}