API Reference

/get/PhenoTips/FamilyPedigreeInterface

post
{Protocol}://{Host}:{Port}/{Path}/get/PhenoTips/FamilyPedigreeInterface

It it not yet possible to update a family's pedigree through the REST API. Instead, you must use the save action of the FamilyPedigreeInterface script service, and provide a family identifier, URL encoded pedigree JSON and URL encoded SVG thumbnail. Note that the code samples generated for you by the PhenoTips documentation will automatically URL encode the pedigree JSON and SVG thumbnail.

Query Params
string
required

Pass the value save in the URL query.

Form Data

Form data parameters in the request body for passing the family identifier, family pedigree JSON, and family pedigree SVG thumbnail.

string

The identifier of the family to update

json

The Pedigree JSON schema. This is used to construct the pedigree.

string

The family pedigree SVG. This must be a valid SVG definition and is shown as a thumbnail on the family and patient pages. In PhenoTips version 8.3.0 or later, the API will default to a generic SVG if one is not provided.

Response

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