- Family Graph API
- Objects
- AggregateValueAdd
- Album
- Audio
- BuyNowData
- ChildInFamily
- Citation
- ColorizationData
- Comment
- Config
- ConfirmationStatus
- Counter
- Device
- DiscoveryBase
- DnaAncestorName
- DnaEnums
- DnaEthnicity
- DnaEthnicityReport
- DnaKit
- DnaKitFile
- DnaMatch
- DnaMatchCommonAncestor
- DnaMatchNote
- DnaMatchRelationship
- DnaOrderItemShippingDetails
- Document
- Enums
- EthnicityInLocation
- Event
- EventDate
- EventPlace
- ExportGEDCOM
- ExportGEDCOMStatus
- Family
- FamilyEvent
- GenealogyEvent
- GoalActivity
- Image
- Individual
- Installation
- Invitation
- MatchesCount
- MatchingRequest
- MediaItem
- Membership
- Navigation
- NavigationItem
- NavigationItemBadge
- NewPhotoInfo
- Note
- Notification
- NotificationHistory
- OrderItemCoupon
- OrderItemShippingDetails
- Page
- PersonalPhotosDiscovery
- Phones
- Photo
- PhotoVersion
- Range
- RecordColorizationData
- RecordIndividual
- RecordMatchesCount
- Relationship
- ResiEvent
- ShippingOption
- SingleDate
- Site
- SmartMatch
- Source
- StructuredDate
- StructuredPlace
- SubTree
- SuggestedRelative
- System
- Tag
- ThreadsCount
- Tree
- TreeItem
- User
- UserMenu
- ValueAddData
- ValueAddElement
- ValueAddFactor
- Video
- WorldEthnicities
- SDKs
- PHP SDK
- iOS SDK
- Android SDK
DnaKit
A DNA kit
Fields
The DnaKit
object contains the following fields:
Name | Description | Type | Access Mode |
id |
The dna kit ID |
id |
read |
upload_guid |
The kit upload guid |
string |
read |
name |
The name of the DNA kit |
string |
read |
name_html |
The name of the DNA kit, formatted for HTML |
string |
read |
description |
The description of the DNA kit |
string |
read |
description_html |
The description of the DNA kit, formatted for HTML |
string |
read |
submitter |
The user who uploaded the DNA kit |
User object: id and name fields |
read, write |
member |
The member that the DNA kit is assigned to |
User object: id and name fields |
read, write |
individual |
The individual that the DNA kit is assigned to |
Individual object: id and name fields |
read, write |
associated_individual |
The individual associated to the kit, will be the kit assigned individual if exists, if not the member biggest tree associated individual |
Individual object: id and name fields |
read, write |
consent |
Specifies that we got the consent of the user to participate in the DNA Research Project |
boolean |
read, write |
genetic_information_processing_consent |
Specifies that we got the consent of the user to process his genetic information by MyHeritage |
boolean |
read, write |
source |
The source of the DNA kit
|
string |
read |
version |
The dna kit source version |
string |
read |
type |
The type of the DNA kit
|
string |
read |
files |
DNA files associated with this kit |
array of DnaKitFile objects containing the name, source, content_type and class_name fields |
read, write |
should_use_for_matching |
Specifies whether or not this kit should be used for matching |
boolean |
read |
status |
Specifies the status of the dna data
|
int |
read |
reported_order_status |
Specifies the order status of the dna kit as last reported
|
int |
read |
estimated_order_status |
Specifies the order status of the dna kit as estimated which can be more advanced than the reported order status
|
int |
read |
activation_status |
Specifies the activation status of the kit
|
int |
read, write |
error |
Specifies the error of the dna kit
|
int |
read |
tag |
Specifies the tagging of the kit
|
string |
read |
reported_gender |
Specifies the kit owner gender reported during activation. This field is editable only when activating the kit
|
string |
read, write |
dna_gender |
Specifies the kit owner gender according to dna kit.
|
string |
read |
can_user_download |
Whether the current user can download the kit |
boolean |
read |
serial_number |
The kit serial number |
string |
read |
shipping_details |
The kit's shipping details |
DnaOrderItemShippingDetails object: id and status fields |
read |
created_time |
The date and time when the kit was uploaded |
string (YYYY-MM-DD HH:MM:SS) |
read |
updated_time |
The date and time when the kit was last updated |
string (YYYY-MM-DD HH:MM:SS) |
read |
intro_url |
The kit intro page url |
string |
read |
intro_facebook_api |
The kit intro share API to facebook |
string |
read |
intro_twitter_api |
The kit intro share API to twitter |
string |
read |
intro_whats_app_api |
The kit intro share API to whatsApp |
string |
read |
intro_native_share_title |
The kit intro title to native share |
string |
read |
ethnicity_printing_api |
The kit ethnicity printing API |
string |
read |
sponsor |
The member that bought this DNA kit |
User object: id and name fields |
read |
dna_ethnicity_report_models |
List of Ethnicity Estimate models supported for this kit |
array of strings |
read |
activation_date |
The Date the kit was first activated |
string (YYYY-MM-DD HH:MM:SS) |
read |
lab_arrival_date |
The Date the sample was received at the lab |
string (YYYY-MM-DD HH:MM:SS) |
read |
lab_extraction_date |
The Date the sample was extracted in the lab |
string (YYYY-MM-DD HH:MM:SS) |
read |
lab_analysis_date |
The Date the the lab started the DNA analysis |
string (YYYY-MM-DD HH:MM:SS) |
read |
lab_raw_data_date |
The Date the the lab extracted the raw data |
string (YYYY-MM-DD HH:MM:SS) |
read |
expected_results_min_date |
The earliest expected date for DNA processing results |
string (YYYY-MM-DD HH:MM:SS) |
read |
expected_results_max_date |
The latest expected date for DNA processing results |
string (YYYY-MM-DD HH:MM:SS) |
read |
is_pedigree_chart_obfuscated |
Indicates if pedigree chart have to be obfuscated |
boolean |
read |
eligibility_variant |
Eligibility variant
|
string |
read |
product_type |
Specifies the product type of the kit
|
int |
read |
has_dna_matches_with_new_theories |
Indicates whether the DNA kit has any DNA matches that have new Theories of Family Relativity |
boolean |
read |
second_vile_availability |
Indicates whether the DNA kit has an available second vile |
boolean |
read |
user_description |
kit description that wrote by user |
string |
read |
class_name |
The object class name |
string |
read |
Connections
The DnaKit object contains the following connections:Name | Description | Type | Access Mode |
dna_ethnicity_reports |
This kit DNA Ethnicity Report |
array of DnaEthnicityReport objects |
read |
dna_matches |
The individual's DNA matches |
array of DnaMatch objects |
read, write |