From 070552b55c40bc2fbbb791b652981892ee305db5 Mon Sep 17 00:00:00 2001 From: Peter Selby Date: Thu, 25 Jan 2018 12:46:05 -0500 Subject: [PATCH] changed map details call to be paged --- Specification/GenomeMaps/GenomeMapDetails.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/Specification/GenomeMaps/GenomeMapDetails.md b/Specification/GenomeMaps/GenomeMapDetails.md index c309558c..e09e3d09 100644 --- a/Specification/GenomeMaps/GenomeMapDetails.md +++ b/Specification/GenomeMaps/GenomeMapDetails.md @@ -6,22 +6,24 @@ Implemented by: Germinate, Cassavabase Used by: Flapjack -### Get map details [GET /brapi/v1/maps/{mapDbId}] +### Get map details [GET /brapi/v1/maps/{mapDbId}{?pageSize}{?page}] Provides the number of markers on each linkageGroup and the max position on the linkageGroup + Paramters + mapDbId (required, string, `abc123`) ... the internal db id of a selected map + + pageSize (optional, integer, `1000`) ... The size of the pages to be returned. Default is `1000`. + + page (optional, integer, `0`) ... Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`. + Response 200 (application/json) { "metadata" : { "pagination" : { - "pageSize":0, + "pageSize":1000, "currentPage":0, - "totalCount":0, - "totalPages":0 + "totalCount":2, + "totalPages":1 }, "status" : [], "datafiles": [] @@ -31,7 +33,7 @@ Provides the number of markers on each linkageGroup and the max position on the "name": "Some map", "type": "Genetic", "unit": "cM", - "linkageGroups": [ + "data": [ { "linkageGroupName": "1", "markerCount": 100000,