Serial Check In Records

Get serial holdings record by copy Id

GET /api/.../serialcheckins/{id}

Returns all the data related to serial checkin holdings record.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the serial check in record.
iscopy Boolean No Define this parameter in the request query string. Defaults to false. For use with copying an existing serial holdings record, if true it will check to see if the PO line item segment data can be copied.

Response Information

Example
application/json, text/json
{
  "CopyID": 309,
  "BibRecordID": 280,
  "PoLineItemSegmentID": 216165,
  "InvLineItemSegmentID": 0,
  "CompletenessCodeH": null,
  "CopyNumber": 1,
  "CreationDate": "2010-01-11T11:13:17.437+05:30",
  "CreatorID": 897,
  "CreatorName": "clarke",
  "ModifierName": "matt.nilsen",
  "DestinationCollectionID": 0,
  "DestinationOrgID": 101,
  "IntentToCancel": null,
  "LastTransaction": "2011-07-14T10:26:12.84+05:30",
  "ListServeAddr": null,
  "ModifierID": 894,
  "NoteNonPub": null,
  "NotePub": null,
  "NoteStaff": null,
  "OrganizationID": 101,
  "OrderType": 7,
  "OrderTypeDescription": "Standing Order",
  "PlanDescr": null,
  "PlanName": null,
  "RetDesignCopy": null,
  "RetDesignGenH": 5,
  "RetDesignSpec00813": null,
  "RetDesignSpec00814": 0,
  "RetDesignSpec00815": null,
  "StartDate": null,
  "StartNumber": null,
  "SubscrExpDate": null,
  "SupplierID": 61,
  "SubsID": 0,
  "SubscrStatusH": 2,
  "CallNoPrefix": null,
  "ClassificationNo": null,
  "CutterNo": null,
  "ShelvingSchemeID": 3,
  "Designated": false,
  "MemberOrgName": null,
  "MemberName": null,
  "MaterialType": 0,
  "VendorTitleNumber": "54353",
  "DisplayInPac": true,
  "SerialClaims": [
    {
      "CategoryId": 1,
      "OrderNumber": 1,
      "DaysToWait": 1,
      "Description": "Basic Bibliographic Unit"
    },
    {
      "CategoryId": 1,
      "OrderNumber": 2,
      "DaysToWait": 1,
      "Description": "Basic Bibliographic Unit"
    },
    {
      "CategoryId": 1,
      "OrderNumber": 3,
      "DaysToWait": 1,
      "Description": "Basic Bibliographic Unit"
    },
    {
      "CategoryId": 1,
      "OrderNumber": 4,
      "DaysToWait": 1,
      "Description": "Basic Bibliographic Unit"
    },
    {
      "CategoryId": 1,
      "OrderNumber": 5,
      "DaysToWait": 1,
      "Description": "Basic Bibliographic Unit"
    }
  ],
  "SupplierBriefInfo": {
    "SupplierID": 61,
    "SupplierName": "BLACK CAT PRESS",
    "LBAcctNumber": "12345678901234567",
    "OrganizationID": 103
  },
  "POLineData": {
    "POLineItemSegmentID": 216165,
    "PONumber": "SAL648",
    "LineNumber": 1,
    "POLISegmentNumber": 1,
    "PONumberSuf": "123"
  },
  "CanPOLISegBeCopied": 0
}

Reference for Polaris API Response values:

CanPOLISegBeCopied is set when the query string value for iscopy = true. If CanPOLISegBeCopied is less than 0, POLineData will not be set.

CanPOLISegBeCopied
{
    0 = Purchase Order Line Item Segment data can be copied,
    -1 = Purchase Order Line Item not in a valid status. Status must be Backordered, Never Published, On Order or Out of Print,
    -2 = Number of linked Serial Holdings records meets or exceeds the quantity ordered in the Purchase Order Line Item Segment,
    -3 = The copied Serial Holdings record is linked to a Subscription record
}
            

HTTP Response Codes

Code Description
200 OK. Success