Record Sets

Get a Record Set

GET /api/.../recordsets/{recordsetid}

Gets 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.

Response Information

Example
application/json, text/json 
{
  "RecordSetID": 36937,
  "Name": "Jeff's Item Records",
  "ObjectTypeID": 3,
  "CreatorID": 1012,
  "CreatorName": "jeff.young",
  "ModifierID": 0,
  "ModifierName": null,
  "OrganizationOwnerID": 0,
  "CreationDate": "2016-09-23T11:49:00.24-04:00",
  "ModificationDate": null,
  "Note": null,
  "NumberOfRecords": 0,
  "RecordStatusID": 1
}

HTTP Response Codes

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

Get a Record Set's Owner Information Only

GET /api/.../recordsets/{recordsetid}?ownerInfoOnly=true

Gets a specific record set's owner information based on the record set Id. Permissions are not checked.

Request Information

Parameters
Name Type Required Description
recordsetid Integer Yes The id of the record set.

Response Information

Example
application/json, text/json 
{
  "RecordSetID": 36937,
  "Name": null,
  "ObjectTypeID": 3,
  "CreatorID": 1012,
  "CreatorName": null,
  "ModifierID": null,
  "ModifierName": null,
  "OrganizationOwnerID": 0,
  "CreationDate": "0001-01-01T00:00:00-05:00",
  "ModificationDate": null,
  "Note": null,
  "NumberOfRecords": 0,
  "RecordStatusID": 0
}

HTTP Response Codes

Code Description
200 Record set returned. Success
404 Record set was not found.

Modify a Record Set Header

GET /api/.../recordsets/{recordsetid}

Update specific record set header based on record set ID. Only the name, owner and note may be modified.

Request Information

Parameters
Name Type Required Description
recordsetid Integer Yes The id of the record set.
PUT Body
Name Type Required Description
Name String Yes The name of the record set.
OrganizationOwnerID Integer Yes The owning organization ID. Provide 0 in order to change the owner to the Polaris creator ID.
Note String Yes Additional free text information about this record set.
Example
application/json, text/json 
{
    "Name": "My Items",
    "OrganizationOwnerID": 0,
    "Note": "Items to be reserved."
}

Response Information

The full, updated record set header is returned upon success.

Example
application/json, text/json 
{
    "RecordSetID": 36928,
    "Name": "Jeff's Items",
    "ObjectTypeID": 3,
    "CreatorID": 1,
    "CreatorName": "PolarisExec",
    "ModifierID": 1,
    "ModifierName": "PolarisExec",
    "OrganizationOwnerID": 0,
    "CreationDate": "2016-09-22T13:35:26.19-04:00",
    "ModificationDate": "2016-10-31T13:05:44.517-04:00",
    "Note": "Frog and toad book",
    "NumberOfRecords": 5
}

HTTP Response Codes

Code Description
200 OK. Success
400 Failure.
404 Not Found.