Participant Info

Get Participant Info

MyDataHelps.getParticipantInfo()

Retrieve demographic information about the current participant, as well as project-specific custom fields.

Returns

Promise<ParticipantInfo>

Resolves to a result object containing participant info fields.

result.participantIdentifier string

Project-specific participant identifier.

result.secondaryIdentifier string

Project-specific secondary identifier

result.linkIdentifier string

Auto-generated identifier used to complete surveys via link, if that feature is enabled for the project.

result.demographics object

Object containing properties for all demographic fields populated for the participant. Unpopulated values are not included.

result.demographics.email string
result.demographics.mobilePhone string
result.demographics.firstName string
result.demographics.middleName string
result.demographics.lastName string
result.demographics.street1 string
result.demographics.street2 string
result.demographics.city string
result.demographics.state string
result.demographics.postalCode string
result.demographics.dateOfBirth string
result.demographics.preferredLanguage string

Preferred language, automatically determined during enrollment. Used to determine language of notifications.

result.demographics.gender string

Gender code: M, F, O, or null.

result.demographics.utcOffset string

Timezone represented as a UTC offset, e.g., -04:00:00.

result.customFields object

Object whose properties represent key/value pairs as project-specific custom fields.

Availability

MyDataHelps Applications
Web View Steps
Example: Retrieving Participant Info
MyDataHelps.getParticipantInfo()
	.then( function(result) {
		console.log(result);
	} );
Console Output
{
  "participantIdentifier": "4c9d3554-7cb1-456e-89ca-5387bda4803c",
  "secondaryIdentifier": "a5dec550-29b6-49b6-85ff-35125956b35d",
  "linkIdentifier": "be0ec303-3abd-49ac-a5ce-78c6695d7d96",
  "demographics": {
    "email": "somebody@example.com",
    "firstName": "John",
    "lastName": "Smith",
    "dateOfBirth": "2000-06-16",
    "preferredLanguage": "en",
    "gender": "M",
    "utcOffset": "-04:00:00"
  },
  "customFields": {
    "Medication1": "Warfarin",
    "Smoker": "0",
    "SurgeryDate": null
  }
}