The project methods return information about the project and its settings.
MyDataHelps.getProjectInfo()
Retrieve general project information.
Resolves to a result
object containing project data.
Unique project identifier.
Project’s display name, localized based on participant’s language settings.
Projects display description, localized based on participant’s language settings.
Project type, displayed to participants and used to filter search results. May be one of: Research Study
, Wellness Program
, or Clinical Program
.
Code used by participants to enroll in this project, if code enrollment is allowed.
Contact email for project support displayed to participants.
Contact number for project support displayed to participants.
A URL where participants can learn more about the project.
Site name or title for the learnMoreLink URL, localized based on participant’s language settings.
Unique organization identifier.
Organization name.
Organization description.
A URL to the organization’s logo.
The organization’s brand color.
A list of platforms that participants may use. Options include: iOS
, Android
, and Web
.
MyDataHelps.getProjectInfo()
.then( function(result) {
console.log(result);
} );
MyDataHelps.getProjectInfo()
.then( function(result) {
console.log(result);
} );
{
"id": "1d878704-64e6-e811-816b-9e01d28da2ca",
"name": "General Hospital Sleep Study",
"type": "Research Study",
"description": "Cutting-edge sleep study.",
"code": "AAAAA",
"supportEmail": "testproject@example.com",
"supportPhone": "888-555-1234",
"learnMoreLink": "https://example.com",
"learnMoreTitle": "Learn More At Test Project HQ",
"organization": {
"color": "#000000",
"description": "General Hospital of AnyTown USA",
"id": "063c0905-446b-4cd5-aa9f-3da958fec94a",
"logoUrl": "https://mydatahelps.org/api/researchkit/organizationbrandingimage/063c0905-446b-4cd5-aa9f-3da958fec94a",
"name": "General Hospital Research"
},
"platforms": [
"Web",
"Android",
"iOS"
]
}
{
"id": "1d878704-64e6-e811-816b-9e01d28da2ca",
"name": "General Hospital Sleep Study",
"type": "Research Study",
"description": "Cutting-edge sleep study.",
"code": "AAAAA",
"supportEmail": "testproject@example.com",
"supportPhone": "888-555-1234",
"learnMoreLink": "https://example.com",
"learnMoreTitle": "Learn More At Test Project HQ",
"organization": {
"color": "#000000",
"description": "General Hospital of AnyTown USA",
"id": "063c0905-446b-4cd5-aa9f-3da958fec94a",
"logoUrl": "https://mydatahelps.org/api/researchkit/organizationbrandingimage/063c0905-446b-4cd5-aa9f-3da958fec94a",
"name": "General Hospital Research"
},
"platforms": [
"Web",
"Android",
"iOS"
]
}
MyDataHelps.getDataCollectionSettings()
Retrieve settings related to data collection for the participant and their project.
Resolves to a result
object containing data collection settings fields.
Indicates whether Fitbit data collection is enabled for this project.
Indicates whether Electronic Health Record data collection is enabled for this project.
Indicates whether Garmin data collection is enabled for this project.
Indicates whether Air Quality data collection is enabled for this project.
Indicates whether Weather data collection is enabled for this project.
A collection of device data types that are supported by the current project configuration and can be queried using the Device Data API. A participant may not have data available for all data types. Note: Although data from the project
namespace can be queried using the Device Data API, it is not included in this list. SDK developers manage which data types exist within their project’s namespace.
The namespace to use when querying the Device Data API.
The type to use when querying the Device Data API.
Date when sensor data collection ended or will end for this participant, in ISO8601 format.
More Info: Stopping Device Data Collection.
MyDataHelps.getDataCollectionSettings()
.then( function(result) {
console.log(result);
} );
MyDataHelps.getDataCollectionSettings()
.then( function(result) {
console.log(result);
} );
{
"fitbitEnabled": false,
"ehrEnabled": false,
"airQualityEnabled": false,
"garminEnabled": false,
"weatherEnabled": false,
"queryableDeviceDataTypes": [
{
"namespace": "AppleHealth",
"type": "RespiratoryRate"
},
{
"namespace": "GoogleFit",
"type": "HeartRate"
}
],
"sensorDataCollectionEndDate": "2022-04-20T00:00:00-04:00"
}
{
"fitbitEnabled": false,
"ehrEnabled": false,
"airQualityEnabled": false,
"garminEnabled": false,
"weatherEnabled": false,
"queryableDeviceDataTypes": [
{
"namespace": "AppleHealth",
"type": "RespiratoryRate"
},
{
"namespace": "GoogleFit",
"type": "HeartRate"
}
],
"sensorDataCollectionEndDate": "2022-04-20T00:00:00-04:00"
}