API Endpoint: External to Internal Sample IDs

[MattWellie]

We would like an endpoint for programmatic access that allows querying on a non-seqr ID to obtain the internal Seqr-ID for the same sample/family

e.g. from @illusional via Slack

query:
seqr.popgen.org.au/<project-guid>/family-page-redirect?external_family_id=FAM0001

delivers:
https://seqr.populationgenomics.org.au/project/<project-guid>/family_page/F000001_fam0001

Q. can we consistently identify a project via argument using a text name (e.g. is R0011_acute_care unique within a seqr deployment), or is there a better unique identifier we can use for projects?

Q. should this take a family ID, a participant ID, or have multiple implementations that are open to different inputs

• for linking to variants, we will want family IDs, but for other use cases the individual IDs may be required

Q. should this take a CPG### ID, and external ID, or have multiple implementations that are open to either

• are the family IDs consistent, but the CPG IDs are used for individual samples?

Q. should this be a single input -> output, or should there be a project level implementation

• for AIP we want to generate multiple links, querying for each family/sample individually will be unnecessary network traffic. Instead:

query: 
seqr.popgen.org.au/<project-guid>/family_id_mapping

result:
{
    family1: seqr_family_id_1,
    family2: seqr_family_id_2,
    family3: seqr_family_id_3
}

An API implementation is alternative to periodically dumping this data from a Seqr instance e.g. as a csv or json object.