POST /api/.../workflow
This method allows the caller to check headings for an existing bibliographic record. It returns a list of problematic headings if any problems are found. It will create authority records per solutions provided by the caller.
| Name | Type | Required | Description |
|---|---|---|---|
| WorkflowRequest | DtoWorkflowRequest | Yes | Define this parameter in the request body. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| WorkflowRequestType | Int | No | Required. Must set to 38 (CheckHeadingsAssistant). |
| TxnBranchID | Int | No | Transacting branch ID. |
| TxnUserID | Int | No | Transacting Polaris user ID. |
| TxnWorkstationID | Int | No | Transacting workstation ID. |
| RequestExtension | DtoWorkflowRequestExtension | No | An update bibliographic record request requires a DtoAddOrUpdateBibRecordExtensionData object. |
| WorkflowReplies | List of DtoWorkflowReply | Yes | It is possible to pass in a list of replies for automated processing. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| WorkflowRequestExtensionType | Int | No | The extension type must be a 12 (AddOrUpdateBibRecordData) |
| Data | Object | No | The extension data object type must be DtoAddOrUpdateBibRecordExtensionData |
See DtoAddOrUpdateBibRecordExtensionData for detail.
{
"WorkflowRequestType": 38,
"TxnBranchID": "90",
"TxnUserID": "1018",
"TxnWorkstationID": "1164",
"WorkflowReplies": null,
"RequestExtension": {
"WorkflowRequestExtensionType": 12,
"Data": {
"BibRecordID": "1402098",
"IsTemplate": false,
"IsNewRecord": false,
"DisplayInPAC": true,
"DoNotOverlay": false,
"RecordOwnerID": "1",
"RecordStatusID": 1,
"MARC21Collection": {
"records": [
"Record": {
"leader": " cam 222 i 44500",
"controlfields": [
{
"tag": "001",
"data": "1400752",
"position": 1,
"type": "CF"
},
],
"datafields": [
{
"tag": "010",
"ind1": " ",
"ind2": " ",
"subfields": [
{
"code": "a",
"data": "2019018578"
}
],
"position": 5,
"type": "DF"
},
{
"tag": "100",
"ind1": "1",
"ind2": " ",
"subfields": [
{
"code": "a",
"data": "Landau, Elaine."
}
],
"position": 5,
"type": "DF"
},
]
}
]
}
}
}
}
{
"WorkflowRequestGuid": "00000000-0000-0000-0000-000000000000",
"WorkflowRequestType": 38,
"WorkflowStatus": 1,
"Prompt": null,
"InformationMessages": [
{
"Type": 1,
"Title": "",
"Message": "No heading problems were found."
}
],
"AnswerExtension": null,
"CircTranType": 0,
"ReceiptType": 0,
"ReceiptUrl": "",
"FineEReceiptSent": false,
"ErrorCode": null
}
{
"WorkflowRequestGuid": "ae56e49b-084b-423e-b533-ea34c68becaa",
"WorkflowRequestType": 38,
"WorkflowStatus": -3,
"Prompt": {
"WorkflowPromptID": 85,
"Name": null,
"Description": null,
"WorkflowPromptType": 24,
"WorkflowPromptOptions": 6,
"DefaultPromptOption": 0,
"Title": "Check Headings Assistant",
"Message": "The bibliographic headings with no exact authority matches are listed below.",
"AlternateMessage": "",
"AlternateYesText": "",
"AlternateNoText": "",
"AlternateCancelText": "",
"AlternateContinueText": "",
"PromptExtension": {
"WorkflowPromptExtensionType": 28,
"Data": {
"Errors": [
{
"ErrorText": "100 1 ‡aPeng Tester",
"ErrorType": 8,
"Tag": {
"TagID": 0,
"SequenceNumber": 0,
"TagNumber": 100,
"IndicatorOne": "1",
"IndicatorTwo": " ",
"Subfields": [
{
"BibliographicSubfieldID": 0,
"SequenceNumber": 0,
"SubfieldDesignator": "a",
"Data": "Peng Tester",
"AuthorizingRecordID": null,
"NumberOfNonFilingCharacters": 0,
"Status": 3
}
],
"AssociatedAuthorityRecordID": 0,
"EffectiveTagNumber": 0,
"TagStatus": 0,
"BulkAddReportTag": null
},
"TagIndex": 7,
"AssociatedRecordID": 0,
"AssociatedObjectID": 0,
"AssociatedObjectType": 0,
"AuthorityControlError": 1,
"ValidationError": 0,
"DisplayText": "Leave heading unlinked"
}
],
"Warnings": [
{
"ErrorText": "130 ‡aLandau, Elaine",
"ErrorType": 0,
"Tag": {
"TagID": 0,
"SequenceNumber": 0,
"TagNumber": 130,
"IndicatorOne": " ",
"IndicatorTwo": " ",
"Subfields": [
{
"BibliographicSubfieldID": 0,
"SequenceNumber": 0,
"SubfieldDesignator": "a",
"Data": "Landau, Elaine",
"AuthorizingRecordID": null,
"NumberOfNonFilingCharacters": 0,
"Status": 3
}
],
"AssociatedAuthorityRecordID": 0,
"EffectiveTagNumber": 0,
"TagStatus": 0,
"BulkAddReportTag": null
},
"TagIndex": 10,
"AssociatedRecordID": 0,
"AssociatedObjectID": 0,
"AssociatedObjectType": 0,
"AuthorityControlError": 17,
"ValidationError": 0,
"DisplayText": "Indicator one value"
}
],
"Tags": [
{
"TagID": 0,
"SequenceNumber": 0,
"TagNumber": 0,
"IndicatorOne": "\u0000",
"IndicatorTwo": "\u0000",
"Subfields": [
{
"BibliographicSubfieldID": 0,
"SequenceNumber": 0,
"SubfieldDesignator": "\u0000",
"Data": " cam 22 4500",
"AuthorizingRecordID": null,
"NumberOfNonFilingCharacters": 0,
"Status": 0
}
],
"AssociatedAuthorityRecordID": 0,
"EffectiveTagNumber": 0,
"TagStatus": 0,
"BulkAddReportTag": null
},
...
],
"IsBib": true,
"SavingRecord": false,
"HeadingsOnReplace": false,
"RecordID": 1402098,
"Tag008DataString": ""
}
}
},
"InformationMessages": [],
"AnswerExtension": null,
"CircTranType": 0,
"ReceiptType": 0,
"ReceiptUrl": "",
"FineEReceiptSent": false,
"ErrorCode": null
}
PUT /api/.../workflow/34ad1205-d622-44fb-ad1c-fd6245298b1a
{
"WorkflowPromptID": 86,
"WorkflowPromptResult": 5,
"ReplyValue": null,
"ReplyExtension": TBD
}
| Step | WorkflowPromptID | WorkflowPromptType | WorkflowPromptOptions | Title |
|---|---|---|---|---|
| CheckMARC21RecordStructureAndRequiredFields | 66 (NoDisplayInPAC) | 45 (BibMARCFormatError) | 8 (Ok) | "MARC Validation Results" |
| CheckHeadings | 85 (CheckHeadingsAssistant) | 24 (CheckHeadingsAssistant) | 6 (ContinueCancel) | "Check Headings Assistant" |
| Step | InformationMessages.Type | InformationMessages.Title | InformationMessages.Message |
|---|---|---|---|
| StartProcedureCheckHeadingsAssist | 2 (Failure) | n/a | "Bib record is locked by Other Staff.", etc. |
| Code | Description |
|---|---|
| 200 | OK. Success |
Permission IDs found here.
AccessCatalogingSubsystem_Allow
BibliographicRecords_Access