Update Bibliographic Record

Start Update Bib Record Process

POST /api/.../workflow

This method allows the caller to update an existing bibliographic record's 'Display in PAC', 'Do not overlay' and 'Owner' columns.

The API will load the existing bib record and update .

Request Information

Parameters
Name Type Required Description
WorkflowRequest DtoWorkflowRequest Yes Define this parameter in the request body.
DtoWorkflowRequest
Property Type Nullable Description
WorkflowRequestType Int No Required. For update bib record, this must be set to 9.
TxnBranchID Int No Transacting branch ID.
TxnUserID Int No Transacting Polaris user ID.
TxnWorkstationID Int No Transacting workstation ID.
RequestExtension DtoWorkflowRequestExtension No An update bib record request requires a DtoUpdateBibRecordExtensionData object.
WorkflowReplies List of DtoWorkflowReply Yes It is possible to pass in a list of replies for automated processing.
DtoWorkflowRequestExtension
Property Type Nullable Description
WorkflowRequestExtensionType Int No For an update bib record request, the extension type must be a 7 (UpdateBibRecordData).
Data Object No This must be an extension data object of type DtoUpdateBibRecordExtensionData
DtoUpdateBibRecordExtensionData
Property Type Nullable Required Description
IsNewBooleanNoNoIs this a new bib record? Default: false
BibRecordIDIntNoYesBibliographic record ID to update.
DisplayInPACBooleanNoNo
DoNotOverlayBooleanNoNo
RecordOwnerIDIntNoNo
Request body
application/json, text/json 
    {
    "WorkflowRequestType": 9,
    "TxnBranchID": 3,
    "TxnUserID": 1,
    "TxnWorkstationID": 1205,
    "RequestExtension": {
        "WorkflowRequestExtensionType": 7,
        "Data": {
               "BibRecordID": 241046,  
               "RecordOwnerID": 3                                
               "DisplayInPAC": false,
               "DoNotOverlay": true
        }
    },
    "WorkflowReplies": null
}

Response Information

<== Answer from server - If 'Display in PAC' is false
Server would like caller to prompt for more input. Display information is provided. 
{
    "WorkflowRequestGuid":"00c1f31d-ac0a-417e-abe0-47502f70974d",
    "WorkflowRequestType":9,
    "WorkflowStatus":-3,
    "Prompt":
    {
        "WorkflowPromptID":66,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":1,
        "WorkflowPromptOptions":6,
        "DefaultPromptOption":5,
        "Title":"Update item record",
        "Message":"This record will no longer display in the online catalog. Do you want to continue saving ?",
        "AlternateYesText":"",
        "AlternateNoText":"",
        "AlternateCancelText":"",
        "AlternateContinueText":"",
        "PromptExtension":null},
        "InformationMessages":[],
        "AnswerExtension":null,
        "CircTranType":0,
        "ReceiptType":0,"ReceiptUrl":"",
        "FineEReceiptSent":false
     }
}
==> Caller sends a reply to the server indicating they want to continue (PromptResult=5).
PUT /api/.../workflow/00c1f31d-ac0a-417e-abe0-47502f70974d 
{
    "WorkflowPromptID": 66,
    "WorkflowPromptResult": 5,
    "ReplyValue": null,
    "ReplyExtension": null
}
Example: DtoWorkflowAnswer - The bibliographic record has been updated.
application/json, text/json 
{
  "WorkflowRequestGuid": "00000000-0000-0000-0000-000000000000",
  "WorkflowRequestType": 9,
  "WorkflowStatus": 1,
  "Prompt": null,
  "InformationMessages": [
    {
      "Type": 1,
      "Title": "",
      "Message": "The bibliographic record has been updated."
    }
  ],
  "AnswerExtension": null,
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}

HTTP Response Codes

Code Description
200 OK. Success

Required Permissions

Permission IDs found here.

    AccessCatalogingSubsystem_Allow
    BibliographicRecords_Access
    BibliographicRecords_Create: If owner branch is changed
    BibliographicRecords_Modify