Media API Documentation

General


  • All requests are GET requests unless otherwise stated. paginated using the query parameters start and resultsize
    • start – offset
    • resultsize – max number of results to retrieve
    • Both parameters need to be > 0 or are otherwise ignored
    • By default pagination is disabled except if a resultsize > 0 is defined

Requests


/:centre

Returns all media files for given :centre – The centre short name, e.g Tcp

  • Takes additional parameters as query string:
    • url – Url for the media file
    • animalName – The animal name
    • genotype – The genotype
    • strain – The strain
    • parameterKey – The parameter key
    • procedureKey – The pocedure Key
    • phase – The phase of file
    • status – The status of file
    • xmlFileName – The xml file name for the media file

Example: https://api.mousephenotype.org/media/Kmpc?start=0&resultsize=50


/dccUrl/:centre

Returns all media files with download URLs, rather than the URLs which centres submit.

:centre – The centre short name, e.g Tcp

  • Takes additional parameters as query string:
    • dccUrl – download url for the media file
    • animalName – The animal name
    • genotype – The genotype
    • strain – The strain
    • parameterKey – The parameter key
    • procedureKey – The pocedure Key
    • phase – The phase of file
    • status – The status of file
    • xmlFileName – The xml file name for the media file
    • pipelineKey – The pipelineKey for media file
  • Example: https://api.mousephenotype.org/media/dccUrl/Kmpc?start=0&resultsize=50