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
metadata key (any string prefixed with :) string metadata value for the supplied key (ex: :orderId=179365)
BIRTH_DATE string Complete birth date of the verification subject
EMAIL string An email address, preferably the one issued by the organization being verified
FIRST_NAME string Given name of the verification subject
LAST_NAME string Surname/family name of the verification subject
STATUS_START_DATE string The date on which the affiliation being verified began. For VETERAN, this is the date of discharge/end of active duty status.
affiliationType AffiliationType the affiliation type of this entry, required if not set globally for this dataset
Possible values: ACTIVE_DUTY, ALUMNUS, BUSINESS, BUSINESS_CONTACT, CIVILIAN_EMPLOYEE, CONTRACTOR, CUSTOMER, DISABLED_VETERAN, EMPLOYEE, EMT, FACULTY, FIREFIGHTER, GRADUATE, MEMBER, MILITARY_FAMILY, MILITARY_RETIREE, NON_PROFIT, NURSE, OWNER, POLICE, RESELLER, RESERVIST, STUDENT_COLLEGE_BOUND, STUDENT_FULL_TIME, STUDENT_PART_TIME, VETERAN
expirationDate date a date upon which this entry is no longer valid
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