Create record set of associated records from an existing record set

Create record set of associated records from an existing record set.

POST /api/.../recordsets?allowLargeRecordSet=true

Create record set of associated records from an existing record set.

Request Information

Parameters
Name Type Required Description
allowLargeRecordSet Boolean Yes Define this parameter in the request query string. If set to true, create a record set with more than 1000 (default) records. The threshold that is used to define a "large" record set is controlled by SA.
itemCircStatusFilter Long No Define this parameter in the request query string. Used when creating an item record set from a patron record set. Bit mask. 4 = Out, 8 = Out ILL, 128 = Lost.
patronCodesFilter String No Define this parameter in the request query string. Used when creating an item record set from a patron record set. Comma delimited list of patron codes. ie: 2,15,3
includeDelete Boolean No Define this parameter in the request query string. Used when creating an item record set from a patron record set. Include item records with a 'Deleted' record status.
recordSet DtoRecordSet Yes Define this parameter in the request body.
DtoRecordSet
Property Type Nullable Description
Name String No Required. Name for the newly created record set. May not exceed 65 characters.
ObjectTypeID Int No Required. 1 Authority Record, 2 Bibliographic Record and 3 Item Record
CreatorID Int Yes If not supplied, the logged in user ID will be used.
CreatorName String Yes
ModifierID Int Yes
ModifierName String Yes
OrganizationOwnerID Int Yes Supply a valid organization ID (not null and not 0) to set the owner of the record set at the organization level. If null or 0 is supplied, the record set will be owned by the creator id.
OriginatingRecordSetID Int Yes Required. Existing record set ID
Example Body for an associated record set
application/json, text/json 
{
    "Name": "My items from a patron rec set",
    "ObjectTypeID": 27,
    "CreatorID":1029,
    "OrganizationOwnerID": 3
    "OriginatingRecordSetID": 35071
}

Response Information

Example Response
application/json, text/json 
{
  "RecordSetId": 39165,
  "NumberOfRecordsAdded": 0,
  "NumberOfRecordsRemoved": 0,
  "NumberOfRecords": 0,
  "Warnings": [],
  "NotFoundRecordIDs": [],
  "DuplicateRecordIDs": [],
  "DuplicateFileRecordIDs": [],
  "RejectedRecordIDs": [],
  "InvalidIDs": [],
  "ReportID": null
}

HTTP Response Codes

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