Post Item Record

Post Item Record

POST /api/.../itemrecords/

Post Item Record - When the type is PostItemRecordType.CreateItemRecord, the Request body is expected to be DtoAccessionItem. For type PostItemRecordType.RetrieveItemRecords, the Request body is expected to be a List of DtoItemData.

Request Information

Parameters
Name Type Required Description
object object Yes Define this object parameter in the request body.
type PostItemRecordType No Defines the type of request/request body. Defaults to PostItemRecordType.CreateItemRecord. Options are PostItemRecordType.CreateItemRecord and PostItemRecordType.RetrieveItemRecords
DtoAccessionItem for type=PostItemRecordType.CreateItemRecord (default)
Property Type Nullable Description
Barcode String No Item barcode, if this barcode already in use, exception will be thrown
Brn Integer No Bibliographic Record Identifier
VolumeNumber String No Volume identifier
BranchID Integer No Branch ID
ClassificationNumber String No Classification Number
MaterialTypeID Integer No Meterial Type ID
AssignedCollectionID Integer No Assigned Collection ID
LanguageID Integer No Language ID
CallNumberSuffix String No Call Number Suffix
Donor String No Donor
Price Decimal Yes Price
DisplayInPAC Boolean Yes Display In PAC
NonPublicNote String No Notes for staff view
PublicNote String No Notes for public view
NonCirculatingFlag Boolean Yes For reference item
ItemStatusID Integer No Item status
ShelfLocationId Integer No Shelf Location Id
FineCodeID Integer No Fine Code ID
DtoItemData for type PostItemRecordType.RetrieveItemRecords
Property Type Nullable Description
ItemRecordID Integer No Item Record Identifier
Barcode String No Item barcode
Example type = PostItemRecordType.CreateItemRecord
application/json, text/json
   {
     "itemId": "123newBarcode123",
     "brn": 5000,
     "volumeName": "TV",
     "locationCode": "AMS",
     "callNumber": "811",
     "mediaCode": "SER",
     "usageLevelCode": "RACL",
     "courseCode": "courseCode",
     "language": "E",
     "suffix": "suffix",
     "donor": "newDonorName132",
     "price": 50,
     "suppressFlag": true,
     "nonPublicNote": "nonBlockingNote",
     "publicNote": "PublicNote",
     "nonCirculatingFlag": true,
     "statusCode": "In-Process"
    }
Example type = PostItemRecordType.RetrieveItemRecords
application/json, text/json
   [
     {"ItemRecordID": 159373, "Barcode": null },
     {"ItemRecordID": 159374, "Barcode": null },
     {"ItemRecordID": null, "Barcode": "barcode" }
   ]

Response Information for type = PostItemRecordType.RetrieveItemRecords

Example
application/json, text/json
[
    {
        "ItemRecordID":668441,
        "Barcode":"0000413694472",
        "IsValid": true,
        "AssignedBranchID": 99,
        "VolumeNumber": " V1",
        "ISBN": "isbn",
        "ISSN": "issn",
        "OCLCNumber": "oclcnumber",
        "UPCNumber": "upc",
        "MaterialTypeID": 1,
        "MaterialType": "Book",
        "CopyNumber": null,
        "CheckInDate": 2013-01-20T23:59:00,
        "LastInventoryDate": 2013-01-28T23:59:00,
        "CheckInBranchID": 99,
        "CheckInWorkstationID":1,
        "LastCheckInWorkstationName": "test",
        "LifetimeCircCount":10,
        "LastCheckoutRenewDate":2013-01-19T23:59:00,
        "ItemStatusID": 11,
        "DueDate":2013-02-02T23:59:00,
        "YTDCircCount": 22,
        "NonPublicNote": null,
        "PublicNote": "public note",
        "DisplayInPac": false,
        "ShelfLocationID": 3,
        "AssignedCollectionID": 2,
        "BibliographicRecordID": 3,
        "PublicationYear": 1999,
        "PubInfo": "publisher",
        "NormalTitle": "title",
        "NormalAuthor":"author",
        "NormalCallNumber": null,
        "Edition": "edition",
        "BrowseTitle": "title",
        "BrowseAuthor":"author",
        "BrowseCallNumber": null
    },
    {
        "ItemRecordID":668333,
        "Barcode":"0000413694333",
        "IsValid": true,
        "AssignedBranchID": 99,
        "VolumeNumber": " V1",
        "ISBN": "isbn",
        "ISSN": "issn",
        "OCLCNumber": "oclcnumber",
        "UPCNumber": "upc",
        "MaterialTypeID": 1,
        "MaterialType": "Book",
        "CopyNumber": null,
        "CheckInDate": 2013-01-20T23:59:00,
        "LastInventoryDate": 2013-01-28T23:59:00,
        "CheckInBranchID": 99,
        "CheckInWorkstationID":1,
        "LastCheckInWorkstationName": "test",
        "LifetimeCircCount":10,
        "LastCheckoutRenewDate":2013-01-19T23:59:00,
        "ItemStatusID": 11,
        "DueDate":2013-02-02T23:59:00,
        "YTDCircCount": 22,
        "NonPublicNote": null,
        "PublicNote": "public note",
        "DisplayInPac": false,
        "ShelfLocationID": 3,
        "AssignedCollectionID": 2,
        "BibliographicRecordID": 3,
        "PublicationYear": 1999,
        "PubInfo": "publisher",
        "NormalTitle": "title",
        "NormalAuthor":"author",
        "NormalCallNumber": null,
        "Edition": "edition",
        "BrowseTitle": "title",
        "BrowseAuthor":"author",
        "BrowseCallNumber": null
    }
]

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request