4.1 - Start search
The startSearch The startSearch endpoint is used to submit a search request to the Search & Match Service. This call returns a searchId for of the search.
| Post |
|---|
startSearch |
| 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 |
|
|
...
The retrieveSearchResultsSummary 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.
| Get |
|---|
| retrieveSearchResultsSummary |
| 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 which 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 |
|
|
...
The retrieveSearchResultsDonors endpoint is used to retrieve search results for with adult donors. Pagination is possible and optional filters can be provided.
...
The retrieveFullReportDonors endpoint is used to retrieve retrieves all available information for of a specific donor in a search result.
| Get |
|---|
| retrieveSearchResultsDonors |
| Expand |
|---|
| | Field | Details |
|---|
| searchResultsId | integer Unique identifier for of the donor within a search result. This is the "id" field within a searchResult |
|
| Expand |
|---|
| | Field | Details |
|---|
| searchId | integer
nullable: false
minimum: 1 | | searchType | string
Enum:
Array [ 1 ] | | matchDuration | integer
minimum: 0
nullable: true
example: 30time in seconds that the search took to run on the matching engine | | patient | {...} | | search | {...} | | donor | {...} |
|
|
...
The retrieveSearchResultsDonors endpoint is used to retrieve search results for with cord blood units. Pagination is possible and optional filters can be provided.
...
The retrieveFullReportCBUs endpoint is used to retrieve retrieves all available information for of a specific CBU in a search result.
| Get |
|---|
| retrieveFullReportCBUs |
| Expand |
|---|
| | Field | Details |
|---|
| searchResultsId | integer Unique identifier of the search. Can be determined by retrieving the patient search summary |
|
| Expand |
|---|
| | Field | Details |
|---|
| searchId | integer
nullable: false
minimum: 1 | | searchType | stringEnum:
Array [ 1 ] | | matchDuration | integer
minimum: 0
nullable: true
example: 30time in seconds that the search took to run on the matching engine | | search | {...} | | patient | {...} | | cbu | {...} |
|
|
...
4.7 - Suggested use of API endpoints
Below is a diagram indicated indicating the suggested use of some of the API endpoints. More API endpoints are available and the API implementer may choose to implement the endpoints in another order.
...