Create Record Set and Contents

Create Record Set

POST /api/.../recordsets

Create record set and add contents.

Record sets may be owned by organizations or users. Setting the owner is determined by the OrganizationOwnerID and CreatorID values. If an OrganizationOwnerID is supplied, the record set will be owned by the organization. If an OrganizationOwnerID is not supplied, the record set will be owned by the creator. NOTE: Weeding record sets can only be owned by an organization.

Request Information

Parameters
Name Type Required Description
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.
ObjectTypeID Int No Required. 1 Authority Record, 2 Bibliographic Record, 3 Item Record, 27 Patron Record, 107 Weeding
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.
Note String Yes
RecordSetID Int Yes
Records Array Yes Array of Integers, Unique ID assigned to system record.
Example Body containing list of record Ids
application/json, text/json 
    
    {
        "Name": "My record set",
        "ObjectTypeID": 1,
        "CreatorID": 1,
        "ModifierID": 1,
        "OrganizationOwnerID": 3,
        "CreationDate": "",
        "ModificationDate": "",
        "Note": "Creating My Record Set",
        "Records": [275071, 275071]
    }

Response Information

Example Response
application/json, text/json 
{
    "RecordSetId":36928,
    "NumberOfRecordsAdded":1,
    "NumberOfRecordsRemoved":0,
    "NumberOfRecords":0,
    "Warnings":["Duplicate id 275071."]    
}

HTTP Response Codes

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