Polaris.ApplicationServices Help

Bulk Change of Contents

Overview

General processing of bulk change uses the following order of operations:

Validate changes and create a summary.
Insert change data into the database.
Process change data using bulk change ID.
Delete change data from the database.

Create Summary of Bulk Changes

POST /api/.../recordsets/{id}/records/bulkchangesummary

In preparation for a bulk change operation the user may want to see a summary of the changes. Use this method to validate the bulk change data object and return a list of changes to be applied.

"Change" Values:

0 = do not change
non-zero = change

"Mode" Values:

0 = Replace
1 = Prepend
2 = Append

General values:

null = do not change
"" = Set to clear/none/empty

Clear IDs ParentItemRecordID by passing in a -1.

Request Information

Parameters

Name	Type	Required	Description
id	Integer	Yes	ID of the record set.

DtoBulkItemChange

Property	Type	Nullable	Description
BulkChangeReportName	String	No	Required
ErrorRecordSetName	String	Yes
ErrorRecordSetOwnerID	String	Yes	Required if ErrorRecordSetName supplied. Examples: user:1 or org:1
OwningBranchID	Int32	Yes
AssignedBranchID	Int32	Yes
AssignedCollectionName	String	Yes
AssignedCollectionAbbreviation	String	Yes
ShelfLocationName	String	Yes
TemporaryShelfLocationChange	Int32	No	0 = do not change, non-zero = change
TemporaryShelfLocation	String	Yes
CirculationStatusID	Int32	Yes
MaterialTypeID	Int32	Yes
LoanPeriodCodeID	Int32	Yes
FineCodeID	Int32	Yes
StatisticalCodeName	String	Yes
RenewalLimit	Int32	Yes
Holdable	Int32	Yes
HoldableByPickup	Int32	Yes
HoldPickupBranchID	Int32	Yes
HoldableByLibrary	Int32	Yes
HoldableByBranch	Int32	Yes
HoldableByPrimaryLender	Int32	Yes
LoanableOutsideSystem	Int32	Yes
NonCirculating	Int32	Yes
ShelvingSchemeID	Int32	Yes
CallNumberPrefixChange	Int32	No	0 = do not change, non-zero = change
CallNumberPrefix	String	Yes
ClassificationNumberChange	Int32	No	0 = do not change, non-zero = change
ClassificationNumber	String	Yes
CutterNumberChange	Int32	No	0 = do not change, non-zero = change
CutterNumber	String	Yes
CallNumberSuffixChange	Int32	No	0 = do not change, non-zero = change
CallNumberSuffix	String	Yes
VolumeNumberChange	Int32	No	0 = do not change, non-zero = change
VolumeNumber	String	Yes
CopyNumberChange	Int32	No	0 = do not change, non-zero = change
CopyNumber	String	Yes
PullCallNumberFromBibChange	Int32	No	0 = do not change, non-zero = change
PublicNoteMode	Int32	Yes	0 = Replace, 1 = Prepend, 2 = Append
PublicNote	String	Yes
NonPublicNoteMode	Int32	Yes	0 = Replace, 1 = Prepend, 2 = Append
NonPublicNote	String	Yes
PhysicalConditionMode	Int32	Yes	0 = Replace, 1 = Prepend, 2 = Append
PhysicalCondition	String	Yes
ItemBlockName	String	Yes
FreeTextBlockMode	Int32	Yes	0 = Replace, 1 = Prepend, 2 = Append
FreeTextBlock	String	Yes
AssociatedBibRecordID	Int32	Yes
DisplayInPAC	Int32	Yes
ParentItemRecordID	Int32	Yes	Pass in a -1 to clear the ParentItemRecordID from the item record.
NameOfPieceChange	Int32	No	0 = do not change, non-zero = change
NameOfPiece	String	Yes
FundingSourceChange	Int32	No	0 = do not change, non-zero = change
FundingSource	String	Yes
PriceChange	Int32	No	0 = do not change, non-zero = change
Price	Decimal	Yes
HomeBranchID	Int32	Yes
ItemDoesNotFloat	Int32	Yes
DoNotMailToPatron	Int32	Yes
ItemBarcodes	Array of string	Yes
UseSystemBarcodes	Bool	Yes

Example body to change the OwningBranchID, AssignedBranchID, HomeBranchID, Holdable and Price properties.

application/json, text/json

{ 
    BulkChangeReportName: "bulkName",
    ErrorRecordSetName: "error record set name",
    ErrorRecordSetOwnerID: "user:1",
    OwningBranchID: 3,
    AssignedBranchID: 3,
    AssignedCollectionName: null,
    AssignedCollectionAbbreviation: null,
    ShelfLocationName: null,
    TemporaryShelfLocationChange: 0,
    TemporaryShelfLocation: null,
    CirculationStatusID: null,
    MaterialTypeID: null,
    LoanPeriodCodeID: null,
    FineCodeID: null,
    StatisticalCodeName: null,
    RenewalLimit: null,
    Holdable: 1,
    HoldableByPickup: 1,
    HoldPickupBranchID: 3,
    HoldableByLibrary: null,
    HoldableByBranch: null,
    HoldableByPrimaryLender: 0,
    LoanableOutsideSystem: null,
    NonCirculating: null,
    ShelvingSchemeID: null,
    CallNumberPrefixChange: 0,
    CallNumberPrefix: null,
    ClassificationNumberChange: 0,
    ClassificationNumber: null,
    CutterNumberChange: 0,
    CutterNumber: null,
    CallNumberSuffixChange: 0,
    CallNumberSuffix: null,
    VolumeNumberChange: 0,
    VolumeNumber: null,
    CopyNumberChange: 0,
    CopyNumber: null,
    PullCallNumberFromBibChange: 0,
    PublicNoteMode: 1,
    PublicNote: 'Note: ',
    NonPublicNoteMode: 0,
    NonPublicNote: null,
    PhysicalConditionMode: 0,
    PhysicalCondition: null,
    ItemBlockName: null,
    FreeTextBlockMode: 0,
    FreeTextBlock: null,
    AssociatedBibRecordID: null,
    DisplayInPAC: null,
    ParentItemRecordID: null,
    NameOfPieceChange: 0,
    NameOfPiece: null,
    FundingSourceChange: 0,
    FundingSource: null,
    PriceChange: 1,
    Price: 2.25,
    HomeBranchID: 3,
    ItemDoesNotFloat: null,
    DoNotMailToPatron: null,
    ItemBarcodes: null,
    UseSystemBarcodes: null
}

Response Information

Example Response

application/json, text/json

[
  "Owner: Amsterdam Free Library (br)",
  "Assigned branch: Amsterdam Free Library (AMS)",
  "Home branch: Amsterdam Free Library (AMS)",
  "Holdable: Yes",
  "Pickup at Amsterdam Free Library (AMS): Yes",
  "Preferred borrowers: No",
  "Public note (Prepend): 'Note:  '",
  "Price: 2.25"
]

HTTP Response Codes

Code	Description
200	Success
400	Bad request
403	Permission(s) not granted.

Add Bulk Change Data For Processing

POST /api/.../recordsets/{id}/records/bulkchange

Insert change data for a bulk change operation and return the bulk change ID.

For ad-hoc bulk changes, pass in a record set ID of '0' and a list of IDs using AdHocItemRecordIDs.

"Change" Values:

0 = do not change
non-zero = change

"Mode" Values:

0 = Replace
1 = Prepend
2 = Append

General values:

null = do not change
"" = Set to clear/none/empty

Clear IDs for ParentItemRecordID by passing in a -1.

Request Information

Parameters

Name	Type	Required	Description
id	Integer	Yes	ID of the record set. For ad-hoc bulk changes, pass in a record set ID of '0'

DtoBulkItemChange

Property	Type	Nullable	Description
BulkChangeReportName	String	No	Required
ErrorRecordSetName	String	Yes
ErrorRecordSetOwnerID	String	Yes	Required if ErrorRecordSetName supplied. Examples: user:1 or org:1
OwningBranchID	Int32	Yes
AssignedBranchID	Int32	Yes
AssignedCollectionName	String	Yes
AssignedCollectionAbbreviation	String	Yes
ShelfLocationName	String	Yes
TemporaryShelfLocationChange	Int32	No	0 = do not change, non-zero = change
TemporaryShelfLocation	String	Yes
CirculationStatusID	Int32	Yes
MaterialTypeID	Int32	Yes
LoanPeriodCodeID	Int32	Yes
FineCodeID	Int32	Yes
StatisticalCodeName	String	Yes
RenewalLimit	Int32	Yes
Holdable	Int32	Yes
HoldableByPickup	Int32	Yes
HoldPickupBranchID	Int32	Yes
HoldableByLibrary	Int32	Yes
HoldableByBranch	Int32	Yes
HoldableByPrimaryLender	Int32	Yes
LoanableOutsideSystem	Int32	Yes
NonCirculating	Int32	Yes
ShelvingSchemeID	Int32	Yes
CallNumberPrefixChange	Int32	No	0 = do not change, non-zero = change
CallNumberPrefix	String	Yes
ClassificationNumberChange	Int32	No	0 = do not change, non-zero = change
ClassificationNumber	String	Yes
CutterNumberChange	Int32	No	0 = do not change, non-zero = change
CutterNumber	String	Yes
CallNumberSuffixChange	Int32	No	0 = do not change, non-zero = change
CallNumberSuffix	String	Yes
VolumeNumberChange	Int32	No	0 = do not change, non-zero = change
VolumeNumber	String	Yes
CopyNumberChange	Int32	No	0 = do not change, non-zero = change
CopyNumber	String	Yes
PullCallNumberFromBibChange	Int32	No	0 = do not change, non-zero = change
PublicNoteMode	Int32	Yes	0 = Replace, 1 = Prepend, 2 = Append
PublicNote	String	Yes
NonPublicNoteMode	Int32	Yes	0 = Replace, 1 = Prepend, 2 = Append
NonPublicNote	String	Yes
PhysicalConditionMode	Int32	Yes	0 = Replace, 1 = Prepend, 2 = Append
PhysicalCondition	String	Yes
ItemBlockName	String	Yes
FreeTextBlockMode	Int32	Yes	0 = Replace, 1 = Prepend, 2 = Append
FreeTextBlock	String	Yes
AssociatedBibRecordID	Int32	Yes
DisplayInPAC	Int32	Yes
ParentItemRecordID	Int32	Yes	Pass in a -1 to clear the ParentItemRecordID from the item record.
NameOfPieceChange	Int32	No	0 = do not change, non-zero = change
NameOfPiece	String	Yes
FundingSourceChange	Int32	No	0 = do not change, non-zero = change
FundingSource	String	Yes
PriceChange	Int32	No	0 = do not change, non-zero = change
Price	Decimal	Yes
HomeBranchID	Int32	Yes
ItemDoesNotFloat	Int32	Yes
DoNotMailToPatron	Int32	Yes
ItemBarcodes	Array of string	Yes
UseSystemBarcodes	Bool	Yes
AdHocItemRecordIDs	List of IDs	No	List of item record IDs. Used for ad-hoc bulk changes. Record set ID must be 0.

Example body to change the OwningBranchID, AssignedBranchID, HomeBranchID, Holdable and Price properties.

application/json, text/json

{ 
    BulkChangeReportName: "bulkName",
    ErrorRecordSetName: "error record set name",
    ErrorRecordSetOwnerID: "user:1",
    OwningBranchID: 3,
    AssignedBranchID: 3,
    AssignedCollectionName: null,
    AssignedCollectionAbbreviation: null,
    ShelfLocationName: null,
    TemporaryShelfLocationChange: 0,
    TemporaryShelfLocation: null,
    CirculationStatusID: null,
    MaterialTypeID: null,
    LoanPeriodCodeID: null,
    FineCodeID: null,
    StatisticalCodeName: null,
    RenewalLimit: null,
    Holdable: 1,
    HoldableByPickup: 1,
    HoldPickupBranchID: 3,
    HoldableByLibrary: null,
    HoldableByBranch: null,
    HoldableByPrimaryLender: 0,
    LoanableOutsideSystem: null,
    NonCirculating: null,
    ShelvingSchemeID: null,
    CallNumberPrefixChange: 0,
    CallNumberPrefix: null,
    ClassificationNumberChange: 0,
    ClassificationNumber: null,
    CutterNumberChange: 0,
    CutterNumber: null,
    CallNumberSuffixChange: 0,
    CallNumberSuffix: null,
    VolumeNumberChange: 0,
    VolumeNumber: null,
    CopyNumberChange: 0,
    CopyNumber: null,
    PullCallNumberFromBibChange: 0,
    PublicNoteMode: 1,
    PublicNote: 'Note: ',
    NonPublicNoteMode: 0,
    NonPublicNote: null,
    PhysicalConditionMode: 0,
    PhysicalCondition: null,
    ItemBlockName: null,
    FreeTextBlockMode: 0,
    FreeTextBlock: null,
    AssociatedBibRecordID: null,
    DisplayInPAC: null,
    ParentItemRecordID: null,
    NameOfPieceChange: 0,
    NameOfPiece: null,
    FundingSourceChange: 0,
    FundingSource: null,
    PriceChange: 1,
    Price: 2.25,
    HomeBranchID: 3,
    ItemDoesNotFloat: null,
    DoNotMailToPatron: null,
    ItemBarcodes: null,
    UseSystemBarcodes: null,
    AdHocItemRecordIDs: null
}

Response Information

Example Response. Returns the bulk change ID.

application/json, text/json

HTTP Response Codes

Code	Description
200	Success
400	Bad request
403	Permission(s) not granted.

Process Bulk Change

PUT /api/.../recordsets/{id}/records/bulkchange/{bulkChangeID}

Schedule bulk change job to run in the background.

For ad-hoc bulk changes, pass in a record set ID of '0'.

Request Information

Parameters

Name	Type	Required	Description
id	Integer	Yes	ID of the record set. For ad-hoc bulk changes, pass in a record set ID of '0'
bulkChangeID	Integer	Yes	ID of the bulk change ID returned from POST operation.

DtoPerformBulkChangeData

Property	Type	Nullable	Required	Description
ModifierID	Int32	No	Yes
OrganizationID	Int32	No	Yes
WorkstationID	Int32	No	Yes
ErrorRecordSetName	String	Yes	No	Name of error record set.
ErrorRecordSetOrgOwnerID	String	Yes	No	Required if ErrorRecordSetName supplied. Use '0' to set owner to the record set's creator ID.
StartingBarcode	String	Yes	No	Staring barcode range when use system assigned barcodes.
EndingBarcode	String	Yes	No	Ending barcode range when use system assigned barcodes.
TypeOfBarcodeRange	Int32	No	No	type of barcode range (CLSI (0), Gaylord (1), Sequential (2)) when use system assigned barcodes.

Example body

application/json, text/json

{
    ModifierID: 1001,
    OrganizationID: 3,
    WorkstationID: 1233,
    ErrorRecordSetName: "",
    ErrorRecordSetOrgOwnerID: null
}

HTTP Response Codes

Code	Description
204	No Content. Item bulk change job has been scheduled to run in the background.
400	Bad request
403	Permission(s) not granted.

Purge Bulk Change

DELETE /api/.../recordsets/{id}/records/bulkchange/{bulkChangeID}

Used to purge a bulk change entry from the database.

For ad-hoc bulk changes, pass in a record set ID of '0'.

Request Information

Parameters

Name	Type	Required	Description
id	Integer	Yes	ID of the record set. For ad-hoc bulk changes, pass in a record set ID of '0'
bulkChangeID	Integer	Yes	ID of the bulk change ID returned from POST operation.

Response Information

Example Response.

application/json, text/json

true

HTTP Response Codes

Code	Description
200	Success
400	Bad request
403	Permission(s) not granted.