4.1 - Start
...
search
A POST to the searches The startSearch endpoint is used to submit a search request to the Search & Match Service. This call returns a searchId for of the search.
SendPost |
---|
startSearchsearches |
Expand |
---|
| Field | Details |
---|
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 |
|
Expand |
---|
| Field | Details |
---|
searchId | integer nullable: false minimum: 1 |
|
|
4.2 - Search summary
The retrieveSearchResultssummary A GET to the searches/{searchId} endpoint is used to request a search summary for of a search. It also contains the status of a the search and can therefore be used to check whether a the search is done.
retrieveSearchResultssummary which Get |
---|
searches/{searchId} |
Send |
---|
|
Expand |
---|
| Field | Details |
---|
searchId* | integer Unique identifier of the search. Can be determined by retrieving the patient search summary |
|
Expand |
---|
| Field | Details |
---|
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 |
|
|
whose phenotype cannot be explained by known haplotype | statistics* | {...} | error* | {...} nullable: true | lociToBeConsidered | [...] | lastUpdated | string($date-time) nullable: false maxLength: 255needed to help determine when the patient can be automatically moved to STP state |
|
|
4.3 -
...
Retrieve all searches for a patient
A GET to the searches/patientSearches/{wmdaId} The retrieveSearchResultsDonors endpoint is used to retrieve search results for donors. Pagination is possible and optional filters can be provided. an overview off all searches that have been performed for a specific patient.
retrieveSearchResultsDonors{...}string
nullable: truestandard 2 expandpagingsearchResultsGet |
---|
searches/patientSearches/{wmdaId} |
Send |
---|
|
|
pagination |
integer wmdaId of patient you want to find search information for. This is NOT the patientId, but the wmdaId you received in the response body after creating your patient. |
|
|
|
---|
searchId* | integer nullable: false minimum: 1 |
|
|
filters | {...} |
sortBy |
| matchEngine* | integer nullable: falseUnique identifier of match engine used in the search. Allowed: 2 (HAP-E), 3 (ATLAS). Enum: Array [ 2 ] | searchType* | stringEnum: Array [ 1 ] | overallMismatches* | integer |
|
|
|
|
|
|
|
Field | Details |
---|
string nullable: falseEnum: Array [ 3 ] | summary* | {...} |
|
|
lociToBeConsidered* | [...] | lastUpdated* | string($date-time) nullable: false maxLength: 255needed to help determine when the patient can be automatically moved to STP state | inexplicable | integer nullable: trueTotal number of donors whose phenotype cannot be explained by known haplotype | statistics | {...} | error | {...} nullable: true |
|
|
4.4 -
...
Search results - Donors
The retrieveFullReportDonors A POST to the searches/searchResults/donors endpoint is used to retrieve all available information for a specific donor in a search result. search results with adult donors. Pagination is possible and optional filters can be provided. If only interested in recent changes to the search results, this can be achieved using a filter on "recordLastUpdatedFrom" field.
string |
filters | {...} |
sortBy | string nullable: true default: standard
|
1 matchDuration patient Expand |
---|
|
| integer minimum: 0 nullable: true example: 30time in seconds that the search took to run on the matching engine |
donor{}