quickMARC Record Editor (5.5)

records-editor

getRecordByExternalId

Get MARC record by externalId

query Parameters

externalId required	string <uuid> (uuid) UUID of the external that is related to the MARC record
lang	string[a-zA-Z]{2} Default: "en" Requested language. Optional. [lang=en]

Responses

Response samples

200
400
404
500

Content type

application/json

Example

view

{"leader": "string",
"fields": [{"tag": 100,
"content": "$a 393893 $b Mike",
"indicators": [1,
2
],
"isProtected": true
}
],
"suppressDiscovery": false,
"marcFormat": "BIBLIOGRAPHIC",
"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."
}
},
"_actionType": "view"
}

createNewRecord

Request Body schema: application/json
required

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
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

parsedRecordId

string <uuid> (uuid)

parsedRecordDtoId

string <uuid> (uuid)

externalId

string <uuid> (uuid)

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

Example

view

{"leader": "string",
"fields": [{"tag": 100,
"content": "$a 393893 $b Mike",
"indicators": [1,
2
],
"isProtected": true
}
],
"suppressDiscovery": false,
"marcFormat": "BIBLIOGRAPHIC",
"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."
}
},
"_actionType": "view"
}

Response samples

201
400
422
500

Content type

application/json

{"qmRecordId": "c9db5d7a-e1d4-11e8-9f32-f2801f1b9fd1",
"externalId": "c56b70ce-4ef6-47ef-8bc3-c470bafa0b8c",
"marcId": "55a76b7b-841d-45b9-9e64-d0827b9e2480",
"jobExecutionId": "c56b70ce-4ef6-47ef-8bc3-c470bafa0b8c",
"status": "CREATED",
"errorMessage": "Failed to create instance",
"metadata": {"createdAt": "2020-07-14T12:20:10.000",
"updatedAt": "2020-07-14T12:20:10.000"
}
}

getRecordCreationStatus

Get status of MARC bibliographic record creation

query Parameters

qmRecordId

required

string <uuid> (uuid)

UUID of ParsedRecord to be created

Responses

Response samples

200
400
404
500

Content type

application/json

{"qmRecordId": "c9db5d7a-e1d4-11e8-9f32-f2801f1b9fd1",
"externalId": "c56b70ce-4ef6-47ef-8bc3-c470bafa0b8c",
"marcId": "55a76b7b-841d-45b9-9e64-d0827b9e2480",
"jobExecutionId": "c56b70ce-4ef6-47ef-8bc3-c470bafa0b8c",
"status": "CREATED",
"errorMessage": "Failed to create instance",
"metadata": {"createdAt": "2020-07-14T12:20:10.000",
"updatedAt": "2020-07-14T12:20:10.000"
}
}

/links/suggestion

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

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
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

parsedRecordId

string <uuid> (uuid)

parsedRecordDtoId

string <uuid> (uuid)

externalId

string <uuid> (uuid)

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

Example

view

{"leader": "string",
"fields": [{"tag": 100,
"content": "$a 393893 $b Mike",
"indicators": [1,
2
],
"isProtected": true
}
],
"suppressDiscovery": false,
"marcFormat": "BIBLIOGRAPHIC",
"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."
}
},
"_actionType": "view"
}

Response samples

201
400
500

Content type

application/json

Example

view

{"leader": "string",
"fields": [{"tag": 100,
"content": "$a 393893 $b Mike",
"indicators": [1,
2
],
"isProtected": true
}
],
"suppressDiscovery": false,
"marcFormat": "BIBLIOGRAPHIC",
"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."
}
},
"_actionType": "view"
}

records-validator

/validate

Request Body schema: application/json
required

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 (5.5)

records-editor

getRecordByExternalId

query Parameters

Responses

Response samples

createNewRecord

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

getRecordCreationStatus

query Parameters

Responses

Response samples

/links/suggestion

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

records-validator

/validate

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