POST /api/.../workflow
This method allows the caller to delete an authority record.
Name | Type | Required | Description |
---|---|---|---|
WorkflowRequest | DtoWorkflowRequest | Yes | Define this parameter in the request body. |
Property | Type | Nullable | Description |
---|---|---|---|
WorkflowRequestType | Int | No | Required. For a delete authority record request, this must be set to 12 (DeleteAuthorityRecord). |
TxnBranchID | Int | No | Transacting branch ID. This should represent where the request originated from. Typically the same as the logged on branch. |
TxnUserID | Int | No | Transacting Polaris user ID. This should represent who originally created this request. Typically the same as the logged on user. |
TxnWorkstationID | Int | No | Transacting workstation ID. This should represent where the request originated from. Typically the same as the logged on workstation. |
RequestExtension | DtoWorkflowRequestExtension | No | A delete authority record request requires a DtoDeleteAuthorityRecordExtensionData 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 | For a delete authority record request, the extension type must be 11 (DeleteAuthorityRecordData). |
Data | Object | No | This must be an extension data object of type DtoDeleteAuthorityRecordExtensionData. |
Property | Type | Nullable | Required | Description |
---|---|---|---|---|
AuthorityRecordID | Int | No | Yes | ID of authority record to delete. |
IsBulkMode | Boolean | No | Yes | Set to false. When set to true, asking for confirmation to delete (ConfirmDelete) step is skipped. |
{
"WorkflowRequestType":12,
"TxnBranchID":"92",
"TxnUserID":"1",
"TxnWorkstationID":"15",
"RequestExtension":{
"WorkflowRequestExtensionType":11,
"Data":{
"AuthorityRecordID": 340293,
"IsBulkMode": false
}
},
"WorkflowReplies":null
}
{
"WorkflowRequestGuid":"9edf7aa7-bfb5-4e5c-a802-237e56851987",
"WorkflowRequestType":12,
"WorkflowStatus":1,
"Prompt":null,
"InformationMessages":[
{
"Type":1,
"Title":"",
"Message":"The record was deleted successfully."
}
],
"AnswerExtension":null,
"CircTranType":0,
"ReceiptType":0,
"ReceiptUrl":"",
"FineEReceiptSent":false
}
{
"WorkflowRequestGuid":"9edf7aa7-bfb5-4e5c-a802-237e56851987",
"WorkflowRequestType":12,
"WorkflowStatus":-3,
"Prompt":{
"WorkflowPromptID":80,
"Name":null,
"Description":null,
"WorkflowPromptType":1,
"WorkflowPromptOptions":6,
"DefaultPromptOption":5,
"Title":"Delete authority record",
"Message":"Are you sure you want to delete authority record 890477?",
"AlternateYesText":"",
"AlternateNoText":"",
"AlternateCancelText":"",
"AlternateContinueText":"",
"PromptExtension":null
},
"InformationMessages":[],
"AnswerExtension":null,
"CircTranType":0,
"ReceiptType":0,
"ReceiptUrl":"",
"FineEReceiptSent":false
}
{
"WorkflowRequestGuid":"9edf7aa7-bfb5-4e5c-a802-237e56851987",
"WorkflowRequestType":12,
"WorkflowStatus":-3,
"Prompt":{
"WorkflowPromptID":75,
"Name":null,
"Description":null,
"WorkflowPromptType":18,
"WorkflowPromptOptions":6,
"DefaultPromptOption":4,
"Title":"Authority Record Links (Breakable)",
"Message":"The following links will be broken if you continue deleting authority record [890477]:",
"AlternateYesText":null,
"AlternateNoText":null,
"AlternateCancelText":null,
"AlternateContinueText":"Continue deleting",
"PromptExtension":{
"WorkflowPromptExtensionType":23,
"Data":{
"Messages":["This authority record is linked to 7 record set."]
}
}
},
"InformationMessages":[],
"AnswerExtension":null,
"CircTranType":0,
"ReceiptType":0,
"ReceiptUrl":"",
"FineEReceiptSent":false
}
{
"WorkflowRequestGuid":"9edf7aa7-bfb5-4e5c-a802-237e56851987",
"WorkflowRequestType":12,
"WorkflowStatus":-3,
"Prompt":{
"WorkflowPromptID":81,
"Name":null,
"Description":null,
"WorkflowPromptType":21,
"WorkflowPromptOptions":6,
"DefaultPromptOption":4,
"Title":"Authority Record Heading Deletion Options",
"Message":"",
"AlternateYesText":null,
"AlternateNoText":null,
"AlternateCancelText":null,
"AlternateContinueText":null,
"PromptExtension":{
"WorkflowPromptExtensionType":24,
"Data":{
"BibsMessage":"There are 2 bibliographic record(s) linked to this authority record. Would you like to:",
"AuthsMessage":"There are 0 authority record(s) linked to this authority record.",
"UnlinkLinkedHeadingsBibEnabled":true,
"DeleteLinkedHeadingsBibEnabled":true,
"UnlinkLinkedHeadingsAuthorityEnabled":false,
"FlipLinkedHeadingsAuthorityEnabled":false,
"DeleteLinkedHeadingsAuthorityEnabled":false
}
}
},
"InformationMessages":[],
"AnswerExtension":null,
"CircTranType":0,
"ReceiptType":0,
"ReceiptUrl":"",
"FineEReceiptSent":false
}
Code | Description |
---|---|
200 | OK. Success |
Permission IDs found here.
CR_AuthorityRecords_Delete