Linked Data API (v1)

Linked Data service API

reindex

Start the process of reindexing of resources in the database

query Parameters

full	boolean Reindex all records if true, otherwise only not indexed

Responses

Response samples

400
500

Content type

application/json

"examples/validationErrorResponse.sample"

resource

createResource

Create a Resource

Request Body schema: application/json

id

integer <int64>

ID of the resource

InstanceField (object) or WorkField (object) (resourceRequestField)

Resource request. Contains either an Instance or a Work request.

One of

object (InstanceRequest)

Instance request DTO

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"resource": {"Instance": {"profileId": 0,
"title": [{"PrimaryTitle": {"partName": ["string"
],
"partNumber": ["string"
],
"mainTitle": ["string"
],
"subTitle": ["string"
],
"nonSortNum": ["string"
]
}
}
],
"production": [{"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"publication": [{"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"distribution": [{"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"manufacture": [{"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"map": [{"Lccn": {"value": ["string"
],
"status": [{"link": ["string"
],
"value": ["string"
]
}
],
"qualifier": ["string"
]
}
}
],
"supplementaryContent": [{"link": ["string"
],
"name": ["string"
]
}
],
"accessLocation": [{"link": ["string"
],
"note": ["string"
]
}
],
"media": [{"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"carrier": [{"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"edition": ["string"
],
"copyright": [{"date": ["string"
]
}
],
"extent": [{"label": ["string"
],
"materialsSpec": ["string"
],
"note": ["string"
]
}
],
"dimensions": ["string"
],
"projectProvisionDate": ["string"
],
"issuance": ["string"
],
"statementOfResponsibility": ["string"
],
"bookFormat": [{"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"publicationFrequency": [{"label": ["string"
],
"link": ["string"
]
}
],
"adminMetadata": [{"transcribingAgency": ["string"
],
"catalogingAgency": ["string"
],
"modifyingAgency": ["string"
],
"createdDate": ["string"
],
"controlNumber": ["string"
],
"catalogingLanguage": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
]
}
]
}
],
"_notes": [{"value": ["string"
],
"type": ["string"
]
}
],
"_workReference": [{"id": "string"
}
]
}
}
}

Response samples

200
400
500

Content type

application/json

{"resource": {"Instance": {"id": "string",
"profileId": 0,
"title": [{"PrimaryTitle": {"id": "string",
"partName": ["string"
],
"partNumber": ["string"
],
"mainTitle": ["string"
],
"subTitle": ["string"
],
"nonSortNum": ["string"
]
}
}
],
"production": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"publication": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"distribution": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"manufacture": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"map": [{"Lccn": {"id": "string",
"value": ["string"
],
"status": [{"id": "string",
"link": ["string"
],
"value": ["string"
]
}
],
"qualifier": ["string"
]
}
}
],
"supplementaryContent": [{"id": "string",
"link": ["string"
],
"name": ["string"
]
}
],
"accessLocation": [{"id": "string",
"link": ["string"
],
"note": ["string"
]
}
],
"media": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"carrier": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"edition": ["string"
],
"copyright": [{"id": "string",
"date": ["string"
]
}
],
"extent": [{"id": "string",
"label": ["string"
],
"materialsSpec": ["string"
],
"note": ["string"
]
}
],
"dimensions": ["string"
],
"projectProvisionDate": ["string"
],
"issuance": ["string"
],
"statementOfResponsibility": ["string"
],
"bookFormat": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"publicationFrequency": [{"id": "string",
"label": ["string"
],
"link": ["string"
],
"code": ["string"
]
}
],
"adminMetadata": [{"transcribingAgency": ["string"
],
"catalogingAgency": ["string"
],
"modifyingAgency": ["string"
],
"createdDate": ["string"
],
"controlNumber": ["string"
],
"catalogingLanguage": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
]
}
]
}
],
"_notes": [{"value": ["string"
],
"type": ["string"
]
}
],
"_workReference": [{"id": "string",
"profileId": 0,
"title": [{"PrimaryTitle": {"id": "string",
"partName": ["string"
],
"partNumber": ["string"
],
"mainTitle": ["string"
],
"subTitle": ["string"
],
"nonSortNum": ["string"
]
}
}
],
"targetAudience": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"tableOfContents": ["string"
],
"summary": ["string"
],
"_languages": [{"types": ["string"
],
"codes": [{"id": "string",
"code": [null
],
"term": [null
],
"link": [null
]
}
]
}
],
"_notes": [{"value": ["string"
],
"type": ["string"
]
}
],
"subjects": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"classification": [{"id": "string",
"code": ["string"
],
"source": ["string"
],
"itemNumber": ["string"
],
"editionNumber": ["string"
],
"edition": ["string"
],
"status": [{"id": "string",
"link": [null
],
"value": [null
]
}
],
"_assigningSourceReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
]
}
],
"_creatorReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true,
"type": "string",
"roles": ["string"
]
}
],
"_contributorReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true,
"type": "string",
"roles": ["string"
]
}
],
"content": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"_instanceReference": [null
],
"_geographicCoverageReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"_genreReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"dateStart": ["string"
],
"dateEnd": ["string"
],
"governmentPublication": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"originPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
],
"dissertation": [{"id": "string",
"label": ["string"
],
"degree": ["string"
],
"dissertationYear": ["string"
],
"dissertationNote": ["string"
],
"dissertationID": ["string"
],
"_grantingInstitutionReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
]
}
],
"illustrations": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"supplementaryContent": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"partOfSeries": [{"name": ["string"
],
"issn": ["string"
],
"volume": ["string"
]
}
],
"characteristic": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
]
}
],
"folioMetadata": {"source": "MARC",
"inventoryId": "string",
"srsId": "string"
}
}
}
}

getResourceById

Get a resource by id

path Parameters

id

required

integer <int64>

Linked Data resource id

Responses

Response samples

200
400
500

Content type

application/json

{"resource": {"Instance": {"id": "string",
"profileId": 0,
"title": [{"PrimaryTitle": {"id": "string",
"partName": ["string"
],
"partNumber": ["string"
],
"mainTitle": ["string"
],
"subTitle": ["string"
],
"nonSortNum": ["string"
]
}
}
],
"production": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"publication": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"distribution": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"manufacture": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"map": [{"Lccn": {"id": "string",
"value": ["string"
],
"status": [{"id": "string",
"link": ["string"
],
"value": ["string"
]
}
],
"qualifier": ["string"
]
}
}
],
"supplementaryContent": [{"id": "string",
"link": ["string"
],
"name": ["string"
]
}
],
"accessLocation": [{"id": "string",
"link": ["string"
],
"note": ["string"
]
}
],
"media": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"carrier": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"edition": ["string"
],
"copyright": [{"id": "string",
"date": ["string"
]
}
],
"extent": [{"id": "string",
"label": ["string"
],
"materialsSpec": ["string"
],
"note": ["string"
]
}
],
"dimensions": ["string"
],
"projectProvisionDate": ["string"
],
"issuance": ["string"
],
"statementOfResponsibility": ["string"
],
"bookFormat": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"publicationFrequency": [{"id": "string",
"label": ["string"
],
"link": ["string"
],
"code": ["string"
]
}
],
"adminMetadata": [{"transcribingAgency": ["string"
],
"catalogingAgency": ["string"
],
"modifyingAgency": ["string"
],
"createdDate": ["string"
],
"controlNumber": ["string"
],
"catalogingLanguage": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
]
}
]
}
],
"_notes": [{"value": ["string"
],
"type": ["string"
]
}
],
"_workReference": [{"id": "string",
"profileId": 0,
"title": [{"PrimaryTitle": {"id": "string",
"partName": ["string"
],
"partNumber": ["string"
],
"mainTitle": ["string"
],
"subTitle": ["string"
],
"nonSortNum": ["string"
]
}
}
],
"targetAudience": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"tableOfContents": ["string"
],
"summary": ["string"
],
"_languages": [{"types": ["string"
],
"codes": [{"id": "string",
"code": [null
],
"term": [null
],
"link": [null
]
}
]
}
],
"_notes": [{"value": ["string"
],
"type": ["string"
]
}
],
"subjects": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"classification": [{"id": "string",
"code": ["string"
],
"source": ["string"
],
"itemNumber": ["string"
],
"editionNumber": ["string"
],
"edition": ["string"
],
"status": [{"id": "string",
"link": [null
],
"value": [null
]
}
],
"_assigningSourceReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
]
}
],
"_creatorReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true,
"type": "string",
"roles": ["string"
]
}
],
"_contributorReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true,
"type": "string",
"roles": ["string"
]
}
],
"content": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"_instanceReference": [null
],
"_geographicCoverageReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"_genreReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"dateStart": ["string"
],
"dateEnd": ["string"
],
"governmentPublication": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"originPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
],
"dissertation": [{"id": "string",
"label": ["string"
],
"degree": ["string"
],
"dissertationYear": ["string"
],
"dissertationNote": ["string"
],
"dissertationID": ["string"
],
"_grantingInstitutionReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
]
}
],
"illustrations": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"supplementaryContent": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"partOfSeries": [{"name": ["string"
],
"issn": ["string"
],
"volume": ["string"
]
}
],
"characteristic": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
]
}
],
"folioMetadata": {"source": "MARC",
"inventoryId": "string",
"srsId": "string"
}
}
}
}

updateResource

Update a resource by id

path Parameters

id

required

integer <int64>

Linked Data resource id

Request Body schema: application/json

id

integer <int64>

ID of the resource

InstanceField (object) or WorkField (object) (resourceRequestField)

Resource request. Contains either an Instance or a Work request.

One of

object (InstanceRequest)

Instance request DTO

Responses

Request samples

Payload

Content type

application/json

"example/resourceRequest.sample"

Response samples

200
400
500

Content type

application/json

{"resource": {"Instance": {"id": "string",
"profileId": 0,
"title": [{"PrimaryTitle": {"id": "string",
"partName": ["string"
],
"partNumber": ["string"
],
"mainTitle": ["string"
],
"subTitle": ["string"
],
"nonSortNum": ["string"
]
}
}
],
"production": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"publication": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"distribution": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"manufacture": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"map": [{"Lccn": {"id": "string",
"value": ["string"
],
"status": [{"id": "string",
"link": ["string"
],
"value": ["string"
]
}
],
"qualifier": ["string"
]
}
}
],
"supplementaryContent": [{"id": "string",
"link": ["string"
],
"name": ["string"
]
}
],
"accessLocation": [{"id": "string",
"link": ["string"
],
"note": ["string"
]
}
],
"media": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"carrier": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"edition": ["string"
],
"copyright": [{"id": "string",
"date": ["string"
]
}
],
"extent": [{"id": "string",
"label": ["string"
],
"materialsSpec": ["string"
],
"note": ["string"
]
}
],
"dimensions": ["string"
],
"projectProvisionDate": ["string"
],
"issuance": ["string"
],
"statementOfResponsibility": ["string"
],
"bookFormat": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"publicationFrequency": [{"id": "string",
"label": ["string"
],
"link": ["string"
],
"code": ["string"
]
}
],
"adminMetadata": [{"transcribingAgency": ["string"
],
"catalogingAgency": ["string"
],
"modifyingAgency": ["string"
],
"createdDate": ["string"
],
"controlNumber": ["string"
],
"catalogingLanguage": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
]
}
]
}
],
"_notes": [{"value": ["string"
],
"type": ["string"
]
}
],
"_workReference": [{"id": "string",
"profileId": 0,
"title": [{"PrimaryTitle": {"id": "string",
"partName": ["string"
],
"partNumber": ["string"
],
"mainTitle": ["string"
],
"subTitle": ["string"
],
"nonSortNum": ["string"
]
}
}
],
"targetAudience": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"tableOfContents": ["string"
],
"summary": ["string"
],
"_languages": [{"types": ["string"
],
"codes": [{"id": "string",
"code": [null
],
"term": [null
],
"link": [null
]
}
]
}
],
"_notes": [{"value": ["string"
],
"type": ["string"
]
}
],
"subjects": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"classification": [{"id": "string",
"code": ["string"
],
"source": ["string"
],
"itemNumber": ["string"
],
"editionNumber": ["string"
],
"edition": ["string"
],
"status": [{"id": "string",
"link": [null
],
"value": [null
]
}
],
"_assigningSourceReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
]
}
],
"_creatorReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true,
"type": "string",
"roles": ["string"
]
}
],
"_contributorReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true,
"type": "string",
"roles": ["string"
]
}
],
"content": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"_instanceReference": [null
],
"_geographicCoverageReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"_genreReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"dateStart": ["string"
],
"dateEnd": ["string"
],
"governmentPublication": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"originPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
],
"dissertation": [{"id": "string",
"label": ["string"
],
"degree": ["string"
],
"dissertationYear": ["string"
],
"dissertationNote": ["string"
],
"dissertationID": ["string"
],
"_grantingInstitutionReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
]
}
],
"illustrations": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"supplementaryContent": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"partOfSeries": [{"name": ["string"
],
"issn": ["string"
],
"volume": ["string"
]
}
],
"characteristic": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
]
}
],
"folioMetadata": {"source": "MARC",
"inventoryId": "string",
"srsId": "string"
}
}
}
}

deleteResource

Delete a resource by id

path Parameters

id

required

integer <int64>

Linked Data resource id

Responses

Response samples

500

Content type

application/json

"example/unknownError.sample"

getResourceMarcViewById

Get a marc view of resource by id

path Parameters

id

required

integer <int64>

Linked Data resource id

Responses

Response samples

200
400
500

Content type

application/json

{"id": "string",
"recordType": "string",
"parsedRecord": {"content": "string"
}
}

exportInstanceToRdf

Export Instance resource to RDF by id

path Parameters

id

required

integer <int64>

Linked Data resource id

Responses

Response samples

200
500

Content type

application/json

"string"

getResourceIdByResourceInventoryId

Get id of a resource by its inventory id

path Parameters

inventoryId

required

string

Inventory ID (999 $i) of the MARC record in SRS

Responses

Response samples

200

Content type

application/json

{"id": "string"
}

checkMarcBibImportableToGraph

Check if marc bibliographic record can be imported into linked data graph.

path Parameters

inventoryId

required

string

Inventory ID (999 $i) of the MARC record in SRS

Responses

Response samples

500

Content type

application/json

"example/unknownError.sample"

getResourcePreviewByInventoryId

Get the preview of a resource

path Parameters

inventoryId

required

string

Inventory ID (999 $i) of the MARC record in SRS

Responses

Response samples

200
500

Content type

application/json

{"resource": {"Instance": {"id": "string",
"profileId": 0,
"title": [{"PrimaryTitle": {"id": "string",
"partName": ["string"
],
"partNumber": ["string"
],
"mainTitle": ["string"
],
"subTitle": ["string"
],
"nonSortNum": ["string"
]
}
}
],
"production": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"publication": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"distribution": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"manufacture": [{"id": "string",
"date": ["string"
],
"name": ["string"
],
"providerDate": ["string"
],
"simplePlace": ["string"
],
"providerPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
]
}
],
"map": [{"Lccn": {"id": "string",
"value": ["string"
],
"status": [{"id": "string",
"link": ["string"
],
"value": ["string"
]
}
],
"qualifier": ["string"
]
}
}
],
"supplementaryContent": [{"id": "string",
"link": ["string"
],
"name": ["string"
]
}
],
"accessLocation": [{"id": "string",
"link": ["string"
],
"note": ["string"
]
}
],
"media": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"carrier": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"edition": ["string"
],
"copyright": [{"id": "string",
"date": ["string"
]
}
],
"extent": [{"id": "string",
"label": ["string"
],
"materialsSpec": ["string"
],
"note": ["string"
]
}
],
"dimensions": ["string"
],
"projectProvisionDate": ["string"
],
"issuance": ["string"
],
"statementOfResponsibility": ["string"
],
"bookFormat": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"publicationFrequency": [{"id": "string",
"label": ["string"
],
"link": ["string"
],
"code": ["string"
]
}
],
"adminMetadata": [{"transcribingAgency": ["string"
],
"catalogingAgency": ["string"
],
"modifyingAgency": ["string"
],
"createdDate": ["string"
],
"controlNumber": ["string"
],
"catalogingLanguage": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
]
}
]
}
],
"_notes": [{"value": ["string"
],
"type": ["string"
]
}
],
"_workReference": [{"id": "string",
"profileId": 0,
"title": [{"PrimaryTitle": {"id": "string",
"partName": ["string"
],
"partNumber": ["string"
],
"mainTitle": ["string"
],
"subTitle": ["string"
],
"nonSortNum": ["string"
]
}
}
],
"targetAudience": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"tableOfContents": ["string"
],
"summary": ["string"
],
"_languages": [{"types": ["string"
],
"codes": [{"id": "string",
"code": [null
],
"term": [null
],
"link": [null
]
}
]
}
],
"_notes": [{"value": ["string"
],
"type": ["string"
]
}
],
"subjects": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"classification": [{"id": "string",
"code": ["string"
],
"source": ["string"
],
"itemNumber": ["string"
],
"editionNumber": ["string"
],
"edition": ["string"
],
"status": [{"id": "string",
"link": [null
],
"value": [null
]
}
],
"_assigningSourceReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
]
}
],
"_creatorReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true,
"type": "string",
"roles": ["string"
]
}
],
"_contributorReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true,
"type": "string",
"roles": ["string"
]
}
],
"content": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"_instanceReference": [null
],
"_geographicCoverageReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"_genreReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
],
"dateStart": ["string"
],
"dateEnd": ["string"
],
"governmentPublication": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"originPlace": [{"id": "string",
"name": ["string"
],
"code": ["string"
],
"label": ["string"
],
"link": ["string"
]
}
],
"dissertation": [{"id": "string",
"label": ["string"
],
"degree": ["string"
],
"dissertationYear": ["string"
],
"dissertationNote": ["string"
],
"dissertationID": ["string"
],
"_grantingInstitutionReference": [{"id": "string",
"label": "string",
"srsId": "string",
"isPreferred": true
}
]
}
],
"illustrations": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"supplementaryContent": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
],
"partOfSeries": [{"name": ["string"
],
"issn": ["string"
],
"volume": ["string"
]
}
],
"characteristic": [{"id": "string",
"code": ["string"
],
"term": ["string"
],
"link": ["string"
],
"source": ["string"
]
}
]
}
],
"folioMetadata": {"source": "MARC",
"inventoryId": "string",
"srsId": "string"
}
}
}
}

importMarcRecord

Create a Resource derived from MARC record

path Parameters

inventoryId

required

string

Inventory ID (999 $i) of the MARC record in SRS

query Parameters

profileId

integer <int16>

ID of the profile

Responses

Response samples

201
400
500

Content type

application/json

{"id": "string"
}

profile

getProfileById

Get a profile by profileId

path Parameters

profileId

required

integer <int16>

ID of the profile

Responses

Response samples

500

Content type

application/json

"example/unknownError.sample"

getProfileMetadataByResourceType

Get profiles metadata for a resource type

query Parameters

resourceType

required

string

The type of resource for which metadata are requested

Responses

Response samples

200
400
500

Content type

application/json

[{"id": 0,
"name": "string",
"resourceType": "string"
}
]

getPreferredProfileByResourceType

Get the preferred profile for a resource type for the current user

query Parameters

resourceType

string

The type of resource for which preferred profile is requested. If not specified, profiles for all resource types will be returned

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"name": "string",
"resourceType": "string"
}
]

setPreferredProfile

Create or update the preferred profile for a resource type for the current user

Request Body schema: application/json

id required	integer <int16> ID of the profile
resourceType required	string Type of the resource to which the profile applies

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"resourceType": "string"
}

Response samples

400
500

Content type

application/json

"examples/validationErrorResponse.sample"

deletePreferredProfile

Delete preferred profile for current user

query Parameters

resourceType

required

string

The type of resource for which preferred profile has to be deleted.

Responses

Response samples

400
500

Content type

application/json

"examples/validationErrorResponse.sample"

graph

getResourceGraphById

Get a resource graph by id

path Parameters

id

required

integer <int64>

Linked Data resource id

Responses

Response samples

200
400
500

Content type

application/json

{"id": "string",
"types": ["string"
],
"doc": { },
"label": "string",
"outgoingEdges": {"total_elements": 0,
"edges": {"property1": [0
],
"property2": [0
]
}
},
"incomingEdges": {"total_elements": 0,
"edges": {"property1": [0
],
"property2": [0
]
}
},
"indexDate": "string"
}

authority

authority-assignment-check

Checks if authority can be assigned to work

Request Body schema: application/json

rawMarc required	string Raw MARC json
target required	string Enum: "CREATOR_OF_WORK" "SUBJECT_OF_WORK" Target type

Responses

Request samples

Payload

Content type

application/json

{"rawMarc": "string",
"target": "CREATOR_OF_WORK"
}

Response samples

200
400
500

Content type

application/json

{"validAssignment": true,
"invalidAssignmentReason": "UNSUPPORTED_MARC"
}

import

import-file

Imports an uploaded JSON file containing at least one resource

Request Body schema: multipart/form-data

fileName

string <binary>

Responses

Response samples

200
400
500

Content type

application/json

{"resources": ["string"
],
"log": "string"
}