arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

createSubject

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

This method was added in Cortex 2.1

hashtag
Parameters

Name

hashtag
Result

The result is a representing the new subject.

hashtag
Examples

Create a subject with only his name.

Create a subject with more information.

Type

Required

Description

cortexToken

string

yes

A token returned by .

subjectName

string

yes

The name of the subject. Must be 30 characters or less.

dateOfBirth

string

no

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

sex

string

no

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

countryCode

string

no

The of the country the subject lives in.

state

string

no

The state the subject lives in.

city

string

no

The city the subject lives in.

attributes

array of objects

no

A list of demographic attribute objects. See .

subject object
{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "createSubject",
    "params": {
        "cortexToken": "xxx",
        "subjectName": "Bob Smith"
    }
}
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "attributes": [],
        "city": "",
        "countryCode": "",
        "countryName": "",
        "dateOfBirth": "",
        "experimentsCount": 0,
        "modifiedDatetime": "2019-07-01T11:41:25.270+07:00",
        "sex": "U",
        "state": "",
        "subjectName": "Bob Smith"
    }
}
{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "createSubject",
    "params": {
        "cortexToken": "xxx",
        "subjectName": "Alice Smith",
        "city": "London",
        "countryCode": "GB",
        "dateOfBirth": "1980-12-25",
        "sex": "F",
        "attributes": [
            {
                "name": "Handedness",
                "value": "Left"
            },
            {
                "name": "Education",
                "value": "Master's degree"
            }
        ]
    }
}
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "attributes": [
            {
                "name": "Handedness",
                "value": "Left"
            },
            {
                "name": "Education",
                "value": "Master's degree"
            }
        ],
        "city": "London",
        "countryCode": "GB",
        "countryName": "",
        "dateOfBirth": "1980-12-25",
        "experimentsCount": 0,
        "modifiedDatetime": "2019-07-01T11:23:11.644+07:00",
        "sex": "F",
        "state": "",
        "subjectName": "Alice Smith"
    }
}
authorize
Alpha-2 ISO codearrow-up-right
Subject object