Developers can now request access to the COGVIC API by sending an email to info@mendel-genes.com,
which should include the following:
After completing your application, you will get a client_id with a duration of 15 days:
The document directory
Send http://www.cogvic.vip/COGVIC/getToken?client_id=client_id to the server in
your
application with the following parameters:
Then you will get a token with a duration of 2 hours.
If successful, you will receive a JSON response like this:
{"msg":"success","token":"bd990fbb"}
Otherwise, you will receive an error response:
{"msg":"client_id Not Found","code":"404"}
| Parameter | Type | Default Value | Reference Data | Explain |
|---|---|---|---|---|
| pageNum | Integer | 1 | Page Number | |
| pageSize | Interger | 5 | Number of Pages | |
| searchKey | String | gene,rsid,chromosome,population | Key Column | |
| searchValue | String | Key Column Value | ||
| sort | String | id,dbsnpId | The key | |
| order | String | asc,desc | The order | |
| token | String | Token |
Send to the server using the following format:
http://www.cogvic.vip/COGVIC/getGeneMsg?searchKey=searchKey&searchValue=searchValue&sort=sort&order=order&token=token
If successful, you will receive a JSON response like this:
{
"msg": "success",
"total": 3,
"mutaSum": 0,
"rows": [
{
"chromosome": "11",
"clinvarId": "-",
"dbsnpId": ".",
"disease": ".",
"gene": "DDB2",
"id": 221,
"molecularConsequence": "-",
"mutationineastasia": "0",
"nucleotideChange": "DDB2:NM_000107:exon2:c.C259T:p.Q87X,DDB2:NM_001300734:exon2:c.C259T:p.Q87X",
"nucleotidesAlt": "T",
"nucleotidesRef": "C",
"position": "47238018",
"variantType": "stopgain"
},
{
"chromosome": "11",
"clinvarId": "-",
"dbsnpId": "rs144989465",
"disease": ".",
"gene": "DDB2",
"id": 222,
"molecularConsequence": "-",
"mutationineastasia": "0",
"nucleotideChange": "DDB2:NM_000107:exon5:c.C640T:p.R214X",
"nucleotidesAlt": "T",
"nucleotidesRef": "C",
"position": "47256161",
"variantType": "stopgain"
},
{
"chromosome": "11",
"clinvarId": "8788",
"dbsnpId": "rs121434640",
"disease": "Xeroderma_pigmentosum,_group_E",
"gene": "DDB2",
"id": 223,
"molecularConsequence": "SO:0001583|missense_variant,SO:0001627|intron_variant",
"mutationineastasia": "0",
"nucleotideChange": "DDB2:NM_000107:exon6:c.G818A:p.R273H",
"nucleotidesAlt": "A",
"nucleotidesRef": "G",
"position": "47256423",
"variantType": "nonsynonymous SNV"
}
],
"type": "gene"
}
Otherwise, you will receive an error response:
{"msg":"Token Not Found","code":"404"}
{"msg":"The parameter cannot be empty","code":"405"}