...
| Send |
|---|
| startSearch |
Request | wmdaId* | integer
example: 123456
nullable: false | | matchEngine* | integer
nullable: falseUnique identifier of match engine used in the search. Allowed: 2 (HAP-E), 3 (ATLAS). Enum:
Array [ 2 ] | | searchType* | string
example: DREnum:
Array [ 2 ] | | overallMismatches | integer
default: 0Enum:
Array [ 8 ] | | lociToBeConsidered | [...] | | isCbuAbLowDrb1HighResolution | boolean
default: false
nullable: true |
Response | searchId | integer
nullable: false
minimum: 1 |
|
4.2 - Search summary
The retrieveSearchResultssummary endpoint is used to request a search summary for a search. It also contains the status of a search and can therefore be used to check whether a search is done.
| Send |
|---|
| retrieveSearchResultssummary |
Request: searchId * integer
Response: | patient | {...} | | searchId* | integer
nullable: false
minimum: 1 | | searchType* | stringEnum:
Array [ 1 ] | | matchEngine* | integer
nullable: falseUnique identifier of match engine used in the search. Allowed: 2 (HAP-E), 3 (ATLAS). Enum:
Array [ 2 ] | | overallMismatches* | integer
default: 0Enum:
Array [ 8 ] | | status* | string
nullable: falseEnum:
Array [ 3 ] | | summary* | {...} | | inexplicable* | integer
nullable: trueTotal number of donors which phenotype cannot be explained by known haplotype | | statistics* | {...} | | error* | {...}
nullable: true | | lociToBeConsidered | [...] | | lastUpdated | string($date-time)
nullable: false
maxLength: 255needed to help determine when patient can be automatically moved to STP state |
|
4.3 - Search results - Donors
...