Error responses

Error responses

All responses with status different than HTTP SUCCESS contain a body with a single JSON object consisting of the following fields:

object
errorType
string
required
description
string
required
message
string

where:

  • errorType - error type, see the list below
  • description - description of error type
  • message - detailed information about error

Returned error object may also contain some additional fields, depending on the errorType. The field errorType always contains one of the short strings from the list below:

  • NotFound - The system does not contain any data about requested resource. Returned status is 404 (Not Found).
  • AuthorizationError - Access denied because of authorization failure. Returned status is 403 (Forbidden).
  • IncorrectRequest - The request sent to the server is incorrect. Returned status is 400 (Bad Request).
  • HgvsParsingError - Given HGVS expressions cannot be parsed. It is incorrect or not supported. Returned status is 400 (Bad Request).
  • IncorrectHgvsPosition - Position given in HGVS expression is incorrect. Returned status is 400 (Bad Request).
  • IncorrectReferenceAllele - Given allele from reference sequence is incorrect. It does not match actual sequence at given position. Returned status is 400 (Bad Request).
  • NoConsistentAlignment - Given allele cannot be mapped in consistent way to reference genome. Returned status is 400 (Bad Request).
  • UnknownCDS - The boundary of coding sequence for given transcript is not known. Returned status is 400 (Bad Request).
  • UnknownGene - Given reference sequence is not assigned to any gene. Returned status is 400 (Bad Request).
  • UnknownReferenceSequence - Given reference sequence is not known. Returned status is 400 (Bad Request).
  • VcfParsingError - Sent VCF file cannot be parsed. It is incorrect or contains unsupported features. Returned status is 400 (Bad Request).
  • RequestTooLarge - The body is too long. It must be smaller than 4 gigabytes. Returned status is 400 (Bad Request).
  • InternalServerError - Internal error occurred. Please, report it as an error. Returned status is 500 (Internal Server Error).