Record Sets

Get User Permitted Record Sets

GET /api/.../recordsets?type=item

Gets user permitted record sets based on the user's Access cataloging record sets and Use 'own' cataloging record sets permissions. The type of the record sets will be specified by the type parameter. Default sort is RecordSetID ascending. When the PitID is specified, the RecordSetID, SearchByName, and SortOption are ignored.

Request Information

Parameters
Name Type Required Description
type String Yes Define this parameter in the request query string. Possible value is 'item'
pageRequest DtoRecordSetPageRequest Yes Page Request Object
DtoRecordSetPageRequest
Name Type Required Description
Limit Integer No Page Limit
Offset Integer No Page Offset
SortOption String No Order the data, default will be CreationDate Ascending sort.
PitID Integer No Point-in-time ID representing the snapshot of data for this query
RecordSetID Integer No Search by Record Set ID, either RecordSetID or Name must be provided. If both are provided, the RecordSetID will be used.
SearchByName String No Search by Record Set Name, either RecordSetID or Name must be provided. If both are provided, the RecordSetID will be used.
Request body
Example
application/json, text/json 
{ 
    SortOption: Default, 
    RecordSetID: 0,
    SearchByName: "missing parts",
    PitID: 0,
    Limit: 100,
    Offset: 0
}

Response Information

Example
application/json, text/json 
[
    {
      "RecordSetID": 36937,
      "Name": "Mary's Item Records",
      "OrganizationOwnerName": "Balston Spa branch",
      "CreationDate": "2016-09-22T11:49:00.24-04:00"
    },
    {
      "RecordSetID": 36938,
      "Name": "Tom's Item Records",
      "OrganizationOwnerName": "Amsterdam branch",
      "CreationDate": "2016-09-23T11:49:00.24-04:00"
    }
    ]

HTTP Response Codes

Code Description
200 Record sets returned. Success