1 of 7

Subjects

A subject represents a human being who is the subject of a record, ie the person wearing the headset during the record. A subject is a permanent object. It is stored on the hard drive and then synchronized to the EMOTIV cloud.

To associate a subject to a record, you must create the subject first, by calling createSubject. Then you must specify the subject name when you call createRecord. A subject is identified by his/her name.

You can call querySubjects to list the subjects already created for the current user.

createSubject

This method is to create a new subject. Then you can associate the subject to a record when you call .

This method was added in Cortex 2.1

Parameters

updateSubject

This method is to update an existing subject.

This method was added in Cortex 2.1

Parameters

deleteSubjects

This method is to delete one or more subjects.

Deleting a subject is irreversible. There is no way to recover a deleted subject.

This method was added in Cortex 2.1

Parameters

A subject is identified by his/her name, so you must provide the name of the subjects you want to delete.

Result

The result is an object that includes these fields:

In case of success, you get an object with these fields:

In case of failure, you get an object with these fields:

Examples

querySubjects

This method returns a list of subjects owned by the current user.

This method was added in Cortex 2.1

Parameters

Name

Type

Depending on the query, this method may return a lot of subjects. To avoid performance issues, you should always set an offset and a limit.

query

The query object can contain one or more of these fields:

orderBy

The orderBy parameters is an array of objects, similar to the orderBy clause of a SQL request.

Each object must have a single attribute. The key of the attribute is the name of subject's field you want to order by. The value of the attribute must be "ASC" or "DESC", to order is ascending or descending order.

For example, to order the subjects by their names, in alphabetical order, you must use the object {"subjectName":"ASC"}.

You can order the subjects by these fields: subjectName, dateOfBirth.

limit and offset

These parameters are to implement pagination. It useful if you want to display the subjects in a UI. You must order the results to use these parameters.

First you should call this method with a offset of zero, and a limit of X. In the response, check the value of count. If count is greater than the limit, then you should call this method again with an offset of X. And then with an offset of 2*X, 3*X... until you get all the subjects for your query.

Result

The result is an object that includes these fields:

Examples

Find the 10 first female subjects born in 1979 or 1980.

getDemographicAttributes

This method returns the list of valid names and values for the demographic attribute objects.

This method was added in Cortex 2.1

Parameters

Name

Result

The result is an array of objects. Each object contain these fields:

Example

Subject object

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

Description

A subject object includes these fields:

Name

Type

Demographic attribute object

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

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

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

Example

querySubjects

This method returns a list of subjects owned by the current user.

This method was added in Cortex 2.1

Parameters

Name

Type

Depending on the query, this method may return a lot of subjects. To avoid performance issues, you should always set an offset and a limit.

query

The query object can contain one or more of these fields:

orderBy

The orderBy parameters is an array of objects, similar to the orderBy clause of a SQL request.

For example, to order the subjects by their names, in alphabetical order, you must use the object {"subjectName":"ASC"}.

You can order the subjects by these fields: subjectName, dateOfBirth.

limit and offset

These parameters are to implement pagination. It useful if you want to display the subjects in a UI. You must order the results to use these parameters.

Result

The result is an object that includes these fields:

Examples

Find the 10 first female subjects born in 1979 or 1980.

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": [
    {
        "name": "Education",
        "value": [
            "Below high school",
            "High school or equivalent",
            "Vocational/technical training",
            "Bachelor's degree",
            "Master's degree",
            "Doctoral degree",
            "Prof. degree (medical, law, etc. )"
        ]
    },
    {
        "name": "Handedness",
        "value": [
            "Left",
            "Right",
            "Ambidextrous",
            "Unspecified"
        ]
    },
    {
        "name": "Language ability",
        "value": [
            "Native Language Only",
            "Bilingual",
            "Multilingual"
        ]
    },
    {
        "name": "Musical skills",
        "value": [
            "None",
            "Single instrumentalist",
            "Multi-instrumentalist",
            "Vocalist",
            "Vocalist & instrumentalist"
        ]
    },
    {
        "name": "Profession",
        "value": [
            "Architecture",
            "Art and design",
            "Entertainment and media",
            "Sports",
            "Building and grounds cleaning",
            "Business and finance",
            "Community and social service",
            "Computer and mathematical",
            "Construction and extraction",
            "Engineering",
            "Education and training",
            "Farming, fishing, and forestry",
            "Food preparation and serving",
            "Healthcare practitioners",
            "Healthcare technicians",
            "Healthcare support",
            "Installation and maintenance",
            "Legal",
            "Physical and social science",
            "Management",
            "Office and administration",
            "Personal care and service",
            "Production and manufacturing",
            "Protective service",
            "Sales",
            "Transportation and logistics",
            "Homemaker",
            "Retired",
            "Student",
            "Unemployed"
        ]
    }
    ]
}

Subjects

createSubject

hashtagParameters

updateSubject

hashtagParameters

deleteSubjects

hashtagParameters

hashtagResult

hashtagExamples

querySubjects

hashtagParameters

hashtagquery

hashtagorderBy

hashtaglimit and offset

hashtagResult

hashtagExamples

getDemographicAttributes

hashtagParameters

hashtagResult

hashtagExample

Subject object

hashtagDescription

hashtagDemographic attribute object

hashtagExample

deleteSubjects

hashtagParameters

hashtagResult

hashtagExamples

updateSubject

hashtagParameters

Subjects

hashtagResult

hashtagExamples

querySubjects

hashtagParameters

hashtagquery

hashtagorderBy

hashtaglimit and offset

hashtagResult

hashtagExamples

createSubject

hashtagParameters

hashtagResult

hashtagExamples

getDemographicAttributes

hashtagParameters

hashtagResult

hashtagExample

Subject object

hashtagDescription

hashtagDemographic attribute object

hashtagExample

Parameters

Parameters

Parameters

Result

Examples

Parameters

query

orderBy

limit and offset

Result

Examples

Parameters

Result

Example

Description

Demographic attribute object

Example

Parameters

Result

Examples

Parameters

Result

Examples

Parameters

query

orderBy

limit and offset

Result

Examples

Parameters

Result

Examples

Parameters

Result

Example

Description

Demographic attribute object

Example