API Reference

/rest/families/phenopacket/export/{id}

get
{Protocol}://{Host}:{Port}/{Path}/rest/families/phenopacket/export/

Export an entire family's phenopacket. To preserve the pedigree structure, all patients in the family will be exported. The patients whose data the user is not permitted to see will be scrubbed of all data excepting the ID (patient ID if given, node id otherwise) and sex.

Path Params
string
required

Internal PhenoTips identifier

Query Params
boolean
Defaults to false

If true, the external_id value will be included as part of alternateIds. Because this value contains personal identifiable information, it is false by default.
This query parameter is only available in PhenoTips version 7.6.0 or later.

string

Specifies the labels of the labeled external identifiers that we want to include in the export as part of alternateIds.
This query parameter is only available in PhenoTips version 7.10.0 or later.

Responses

401

User not authenticated

403

User not authorized

404

Patient record not found

500

Server error

Updated 8 months ago

Language
Credentials
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 8 months ago