Record Set Contents

Get Record Set Contents

GET /api/.../recordsets/{recordsetid}/records?startIndex={startIndex}&numRecords={numRecords}

Gets the list of records contained by a specific record set based on the record set Id.

Request Information

Parameters
Name Type Required Description
recordsetid Integer Yes The id of the record set.
startIndex Integer No 0-based position in list. Defaults to 0.
numRecords Integer No Defaults to 1000. Specify 0 to load full list.
sortResults Boolean No Defaults to false.

Response Information

Example Authority Record Set Contents
application/json, text/json 
{
  "ObjectTypeID": 1,
  "Records": [
    {
      "RecordID": 46605,
      "Heading": "Hemingway, Ernest, 1899-1961. Sun also rises",
      "ControlNumber": 46605,
      "LinkedBibCount": 7,
      "LinkedSeeAlsoCount": 0,
      "IsName": true,
      "IsSubject": true,
      "IsSeries": false,
      "RecordStatusName": "Final"
    }
  ]
}
Example Bibliographic Record Set Contents
application/json, text/json 
{
  "ObjectTypeID": 2,
  "Records": [
    {
      "RecordID": 282560,
      "Title": "Return of the Jedi",
      "Author": "Levy, Elizabeth.",
      "FormatDescription": "Book",
      "LinkedItemCount": 2,
      "LinkedHoldCount": 0,
      "PublicationDate": "1995",
      "CallNumber": "J Fict Lev",
      "ControlNumber": 282560,
      "RecordStatusName": "Final",
      "NonFilingTuple":null
    }
  ]
}
Example Item Record Set Contents
application/json, text/json 
{
  "ObjectTypeID": 3,
  "Records": [
    {
      "RecordID": 94184,
      "Title": "Frog goes to dinner",
      "AssignedBranch": "Saratoga Springs Public Library",
      "Collection": "Children's Picture Books (JP)",
      "MaterialType": "Book",
      "ShelfLocation": null,
      "CallNumber": "JP Fict May",
      "Volume": null,
      "Status": "In",
      "Barcode": "0000201275351",
      "LastActivityDate": "2000-11-29T00:00:00-05:00",
      "RecordStatus": "Final",
      "NonFilingTuple":null
    }
  ]
}
Example Patron Record Set Contents
application/json, text/json 
{
  "ObjectTypeID": 27,
  "Records": [
    {
      "RecordID": 358243,
      "Barcode": "21756003332051",
      "PatronName": "Jetson, George",
      "Street": "100 Skypad Apartments",
      "City": "JAMESVILLE",
      "State": "NY",
      "Zip": "13078-1234",
      "Library": "Ballston Spa Public Library",
      "RecordStatusID": 1
    }
  ]
}
Example Weeding Record Set Contents
application/json, text/json 
{
  "ObjectTypeID": 107,
  "Records": [
    {
      "RecordID": 94184,
      "Title": "Frog goes to dinner",
      "AssignedBranch": "Saratoga Springs Public Library",
      "Collection": "Children's Picture Books (JP)",
      "MaterialType": "Book",
      "ShelfLocation": null,
      "CallNumber": "JP Fict May",
      "Volume": null,
      "Status": "In",
      "Barcode": "0000201275351",
      "LastActivityDate": "2000-11-29T00:00:00-05:00",
      "RecordStatus": "Final",
      "NonFilingTuple":null
    }
  ]
}

HTTP Response Codes

Code Description
200 Record set contents returned. Success
404 Record set was not found.
403 Permission(s) not granted.