Cortex API
  • Getting Started
  • Connecting to the Cortex API
  • Overview of API flow
  • Authentication
    • getCortexInfo
    • getUserLogin
    • requestAccess
    • hasAccessRight
    • authorize
    • generateNewToken
    • getUserInformation
    • getLicenseInfo
  • Headsets
    • controlDevice
    • queryHeadsets
    • updateHeadset
    • updateHeadsetCustomInfo
    • syncWithHeadsetClock
    • Headset object
  • Sessions
    • createSession
    • updateSession
    • querySessions
    • Session object
  • Data Subscription
    • subscribe
    • unsubscribe
    • Data sample object
  • Records
    • createRecord
    • stopRecord
    • updateRecord
    • deleteRecord
    • exportRecord
    • queryRecords
    • getRecordInfos
    • configOptOut
    • requestToDownloadRecordData
    • Record object
  • Markers
    • injectMarker
    • updateMarker
    • Marker object
  • Subjects
    • createSubject
    • updateSubject
    • deleteSubjects
    • querySubjects
    • getDemographicAttributes
    • Subject object
  • BCI
    • queryProfile
    • getCurrentProfile
    • setupProfile
    • loadGuestProfile
    • getDetectionInfo
    • training
    • Readonly profile
  • Advanced BCI
    • getTrainedSignatureActions
    • getTrainingTime
    • facialExpressionSignatureType
    • facialExpressionThreshold
    • mentalCommandActiveAction
    • mentalCommandBrainMap
    • mentalCommandGetSkillRating
    • mentalCommandTrainingThreshold
    • mentalCommandActionSensitivity
  • Warning Objects
  • Error Codes
  • Troubleshooting Guide
  • Release Notes
  • cortexaccess tool
Powered by GitBook
On this page
  • Description
  • Demographic attribute object
  • Example
  1. Subjects

Subject object

PreviousgetDemographicAttributesNextBCI

Last updated 5 years ago

A subject represents a human being who is the subject of a (ie an experiment).

Description

A subject object includes these fields:

Name

Type

Description

subjectName

string

The name of the subject.

dateOfBirth

string

The date of birth of the subject. The format is "YYYY-MM-DD", e.g. "1980-12-25".

sex

string

Can be "M", "F" or "U". These letters stands for male, female and unknown respectively.

experimentsCount

number

countryCode

string

countryName

string

The name of the country the subject lives in.

state

string

The state the subject lives in.

city

string

The city the subject lives in.

attributes

array of objects

A list of demographic attribute objects. See below.

Demographic attribute object

The field attributes is a list of attributes. A demographic attribute is an object with 2 fields:

Name

Type

Required

Description

name

string

yes

The name of the attribute.

value

string

yes

The value of the attribute.

For example, to tell that the subject is right handed, you can add the attribute { "name":"Handedness", "value":"Right"}

Example

{
    "attributes": [
        {
            "name": "Handedness",
            "value": "Left"
        },
        {
            "name": "Education",
            "value": "Master's degree"
        }
    ],
    "city": "London",
    "countryCode": "GB",
    "countryName": "",
    "dateOfBirth": "1980-12-25",
    "experimentsCount": 3,
    "modifiedDatetime": "2019-07-01T11:23:11.644+07:00",
    "sex": "F",
    "state": "",
    "subjectName": "Alice Smith"
}

The of the country the subject lives in.

You must call to know what are the valid attribute names, and what are the possible values for each attribute.

record
getDemographicAttributes
Alpha-2 ISO code