quickMARC Record Editor (6.0)

API for creating, editing, and managing MARC records in the quickMARC editor

records-editor

Operations for managing MARC records

Get MARC record by external ID

Retrieves a MARC record associated with the provided external entity UUID

query Parameters

externalId

required

string <uuid>

Example: externalId=b9a5f035-de63-4e2c-92c2-07240c89b817

UUID of the external entity that is related to the MARC record

Responses

Response samples

200
400
404
500

Content type

application/json

{"parsedRecordId": "c9db5d7a-e1d4-11e8-9f32-f2801f1b9fd1",
"parsedRecordDtoId": "c56b70ce-4ef6-47ef-8bc3-c470bafa0b8c",
"externalId": "b9a5f035-de63-4e2c-92c2-07240c89b817",
"externalHrid": "in00000000001",
"marcFormat": "BIBLIOGRAPHIC",
"leader": "01587ccm a2200361   4500",
"fields": [{"tag": "100",
"content": {"$a": "Mozart, Wolfgang Amadeus,",
"$d": "1756-1791."
},
"indicators": ["1",
" "
]
},
{"tag": "245",
"content": {"$a": "Test Title"
},
"indicators": ["1",
"0"
]
}
]
}

Create new MARC record

Creates a new MARC record with the provided data

Request Body schema: application/json
required

MARC record data to create

leader

required

string

MARC record's leader

required

Array of objects (fieldItem)

MARC record's fields

Array

tag required	string^[0-9]{3}$ Field's tag
content required	object Field's content (string for control fields, object with subfields for data fields)
indicators	Array of strings [ 0 .. 2 ] items [ items = 1 characters ] Field's indicators
	object (linkDetails) Link-related fields

suppressDiscovery

boolean

Default: false

Flag indicates if the record is displayed during a search

marcFormat

required

string (marcFormat)

Enum: "BIBLIOGRAPHIC" "HOLDINGS" "AUTHORITY"

MARC Format

sourceVersion

integer

Default: -1

Version of the source record

Responses

Request samples

Payload

Content type

application/json

{"leader": "string",
"fields": [{"tag": "100",
"content": {"$a": "393893",
"$b": "Mike"
},
"indicators": ["1",
"2"
],
"isProtected": true
}
],
"suppressDiscovery": false,
"marcFormat": "BIBLIOGRAPHIC",
"sourceVersion": 1
}

Response samples

201
400
422
500

Content type

application/json

{"leader": "string",
"fields": [{"tag": "100",
"content": {"$a": "393893",
"$b": "Mike"
},
"indicators": ["1",
"2"
],
"isProtected": true
}
],
"suppressDiscovery": false,
"marcFormat": "BIBLIOGRAPHIC",
"sourceVersion": 1,
"parsedRecordId": "941d5c40-a69b-4b32-ae80-33c0ab9d819f",
"parsedRecordDtoId": "afa9406a-498d-4f12-9077-2cd08aed49da",
"externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
"externalHrid": "string",
"updateInfo": {"recordState": "ACTUAL",
"updateDate": "2019-08-24T14:15:22Z",
"updatedBy": {"userId": "c56b70ce-4ef6-47ef-8bc3-c470bafa0b8c",
"username": "john-doe",
"lastName": "Doe",
"firstName": "John",
"middleName": "X."
}
}
}

Update MARC record

Updates an existing MARC record with the provided data

path Parameters

id

required

string <uuid>

Example: c9db5d7a-e1d4-11e8-9f32-f2801f1b9fd1

The UUID of the MARC record

Request Body schema: application/json
required

MARC record data to update

leader

required

string

MARC record's leader

required

Array of objects (fieldItem)

MARC record's fields

Array

tag required	string^[0-9]{3}$ Field's tag
content required	object Field's content (string for control fields, object with subfields for data fields)
indicators	Array of strings [ 0 .. 2 ] items [ items = 1 characters ] Field's indicators
	object (linkDetails) Link-related fields

suppressDiscovery

boolean

Default: false

Flag indicates if the record is displayed during a search

marcFormat

required

string (marcFormat)

Enum: "BIBLIOGRAPHIC" "HOLDINGS" "AUTHORITY"

MARC Format

sourceVersion

integer

Default: -1

Version of the source record

parsedRecordId

required

string <uuid>

MARC record Id

parsedRecordDtoId

required

string <uuid>

ParsedRecordDto identifier

externalId

required

string <uuid>

Identifier of external entity

externalHrid

required

string

HRID of external entity

Responses

Request samples

Payload

Content type

application/json

{"leader": "string",
"fields": [{"tag": "100",
"content": {"$a": "393893",
"$b": "Mike"
},
"indicators": ["1",
"2"
],
"isProtected": true
}
],
"suppressDiscovery": false,
"marcFormat": "BIBLIOGRAPHIC",
"sourceVersion": 1,
"parsedRecordId": "941d5c40-a69b-4b32-ae80-33c0ab9d819f",
"parsedRecordDtoId": "afa9406a-498d-4f12-9077-2cd08aed49da",
"externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
"externalHrid": "string"
}

Response samples

400
409
422
500

Content type

application/json

{"message": "may not be null",
"type": "1",
"code": "-1",
"parameters": [{"key": "moduleTo",
"value": "null"
}
]
}

Suggest links for MARC record

Analyzes MARC record and suggests authority links based on the specified search parameter

query Parameters

authoritySearchParameter	string (authoritySearchParameter) Default: "NATURAL_ID" Enum: "ID" "NATURAL_ID" Authority field to search by
ignoreAutoLinkingEnabled	boolean Default: false Indicates if we need to ignore autoLinkingEnabled flag when filtering the fields for suggestions

Request Body schema: application/json
required

MARC record to analyze for link suggestions

leader

required

string

MARC record's leader

required

Array of objects (fieldItem)

MARC record's fields

Array

tag required	string^[0-9]{3}$ Field's tag
content required	object Field's content (string for control fields, object with subfields for data fields)
indicators	Array of strings [ 0 .. 2 ] items [ items = 1 characters ] Field's indicators
	object (linkDetails) Link-related fields

suppressDiscovery

boolean

Default: false

Flag indicates if the record is displayed during a search

marcFormat

required

string (marcFormat)

Enum: "BIBLIOGRAPHIC" "HOLDINGS" "AUTHORITY"

MARC Format

sourceVersion

integer

Default: -1

Version of the source record

parsedRecordId

string <uuid>

MARC record Id

parsedRecordDtoId

string <uuid>

ParsedRecordDto identifier

externalId

string <uuid>

Identifier of external entity

externalHrid

string

HRID of external entity

object (updateInfo)

Record metadata

recordState	string (recordState) Enum: "ACTUAL" "IN_PROGRESS" "ERROR" State of source record
updateDate	string <date-time> Date and time of last successful update of the record
	object (userInfo) User Display Information

Responses

Request samples

Payload

Content type

application/json

{"leader": "string",
"fields": [{"tag": "100",
"content": {"$a": "393893",
"$b": "Mike"
},
"indicators": ["1",
"2"
],
"isProtected": true
}
],
"suppressDiscovery": false,
"marcFormat": "BIBLIOGRAPHIC",
"sourceVersion": 1,
"parsedRecordId": "941d5c40-a69b-4b32-ae80-33c0ab9d819f",
"parsedRecordDtoId": "afa9406a-498d-4f12-9077-2cd08aed49da",
"externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
"externalHrid": "string",
"updateInfo": {"recordState": "ACTUAL",
"updateDate": "2019-08-24T14:15:22Z",
"updatedBy": {"userId": "c56b70ce-4ef6-47ef-8bc3-c470bafa0b8c",
"username": "john-doe",
"lastName": "Doe",
"firstName": "John",
"middleName": "X."
}
}
}

Response samples

201
400
500

Content type

application/json

{"leader": "string",
"fields": [{"tag": "100",
"content": {"$a": "393893",
"$b": "Mike"
},
"indicators": ["1",
"2"
],
"isProtected": true
}
],
"suppressDiscovery": false,
"marcFormat": "BIBLIOGRAPHIC",
"sourceVersion": 1,
"parsedRecordId": "941d5c40-a69b-4b32-ae80-33c0ab9d819f",
"parsedRecordDtoId": "afa9406a-498d-4f12-9077-2cd08aed49da",
"externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
"externalHrid": "string",
"updateInfo": {"recordState": "ACTUAL",
"updateDate": "2019-08-24T14:15:22Z",
"updatedBy": {"userId": "c56b70ce-4ef6-47ef-8bc3-c470bafa0b8c",
"username": "john-doe",
"lastName": "Doe",
"firstName": "John",
"middleName": "X."
}
}
}

Validate MARC record

Validates a MARC record against defined rules and specifications

Request Body schema: application/json
required

MARC record data to validate

leader

string

MARC record's leader

Array of objects

MARC record's fields

Array

tag	string Field's tag
content	object Field's content
indicators	Array of strings Field's indicators

marcFormat

required

string (marcFormat)

Enum: "BIBLIOGRAPHIC" "HOLDINGS" "AUTHORITY"

MARC Format

Responses

Request samples

Payload

Content type

application/json

{"leader": "string",
"fields": [{"tag": "string",
"content": { },
"indicators": ["string"
]
}
],
"marcFormat": "BIBLIOGRAPHIC"
}

Response samples

200
400
500

Content type

application/json

{"issues": [{"tag": "string",
"severity": "string",
"definitionType": "string",
"helpUrl": "string",
"message": "string"
}
]
}

quickMARC Record Editor (6.0)

records-editor

Get MARC record by external ID

query Parameters

Responses

Response samples

Create new MARC record

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Update MARC record

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Suggest links for MARC record

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Validate MARC record

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required