Skip to content
Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
81 lines (48 sloc) 2.24 KB

Server response

The MyVariant.info server returns a variety of query responses, and response status codes. They are listed here.

Note

These examples show query responses using the python requests package.

Status code 200

A 200 status code indicates a successful query, and is accompanied by the query response payload.

In [1]: import requests

In [2]: r = requests.get('http://myvariant.info/v1/query?q=_exists_:clinvar')

In [3]: r.status_code
Out[3]: 200

In [4]: data = r.json()

In [5]: data.keys()
Out[5]: dict_keys(['total', 'max_score', 'took', 'hits'])

Status code 400

A 400 status code indicates an improperly formed query, and is accompanied by a response payload describing the source of the error.

In [6]: r = requests.get('http://myvariant.info/v1/query?q=_exists_:clinvar&size=u')

In [7]: r.status_code
Out[7]: 400

In [8]: data = r.json()

In [9]: data
Out[9]:
{'error': "Expected 'size' parameter to have integer type.  Couldn't convert 'u' to integer",
 'success': False}

Status code 404

A 404 status code indicates either an unrecognized URL, as in (/query is misspelled /quer resulting in an unrecognized URL):

In [10]: r = requests.get('http://myvariant.info/v1/quer?q=_exists_:clinvar')

In [11]: r.status_code
Out[11]: 404

or, for the /variant endpoint, a 404 status code could be from querying for a nonexistent HGVS ID, as in:

In [12]: r = requests.get('http://myvariant.info/v1/variant/5')

In [13]: r.status_code
Out[13]: 404

In [14]: data = r.json()

In [15]: data
Out[15]:
{'error': "ID '5' not found",
 'success': False}

Status code 5xx

Any 5xx status codes are the result of uncaught query errors. Ideally, these should never occur. We routinely check our logs for these types of errors and add code to catch them, but if you see any status 5xx responses, please submit a bug report to help@myvariant.info.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.