Create Dataset Entry

Add a single dataset entry

Request Details

HTTP Method(s)

POST

Resource URI

https://services-sandbox.sheerid.com/rest/0.5/dataset/{datasetId}/entry

Accepted Content Type(s)

application/x-www-form-urlencoded

Path Parameters

Name Type Description
datasetId string the identifier of an existing dataset to which entries should be added

Parameters

Name Type Description
any field name from List Fields mixed value for the specified field (ex: FIRST_NAME=Thomas)
metadata key (any string prefixed with :) string metadata value for the supplied key (ex: :orderId=179365)
affiliationType AffiliationType the affiliation type of this entry, required if not set globally for this dataset
Possible values: STUDENT_COLLEGE_BOUND, STUDENT_FULL_TIME, STUDENT_PART_TIME, GRADUATE, ALUMNUS, FACULTY, EMPLOYEE, RESELLER, NON_PROFIT, ACTIVE_DUTY, VETERAN, RESERVIST, MILITARY_FAMILY, MILITARY_RETIREE, DISABLED_VETERAN, CIVILIAN_EMPLOYEE, FIREFIGHTER, POLICE, EMT, NURSE, MEMBER, CUSTOMER, OWNER, BUSINESS, BUSINESS_CONTACT
expirationDate date a date upon which this entry is no longer valid (format: yyyy-MM-dd)
organizationId long the organizationId to which this entry pertains, required if not set globally for this dataset

Response Details

Expected Response

A single DatasetEntry object

Response Content Type(s)

application/json

Errors (HTTP Status Codes)

HTTP Status Code Description
400 all dataset fields are not present in the request
400 there is no organization associated with the dataset and organizationId is missing or invalid
400 there is no affiliation type associated with the dataset and affiliationType is missing or invalid