4.1 - Start search
A POST to the searches endpoint is used to submit a search request to the Search & Match Service. This call returns a searchId of the search.
| Post |
|---|
searches |
| 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 |
|
| Field | Details |
|---|
| searchId | integer
nullable: false
minimum: 1 |
|
|
4.2 - Search summary
A GET to the searches/{searchId} endpoint is used to request a search summary of a search. It also contains the status of the search and can therefore be used to check whether the search is done.
| Get |
|---|
| searches/{searchId} |
| Field | Details |
|---|
| searchId* | integer Unique identifier of the search. Can be determined by retrieving the patient search summary |
|
| 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 - Search results - Donors
A POST to the searches/searchResults/donors endpoint is used to retrieve search results with adult donors. Pagination is possible and optional filters can be provided.
| Post |
|---|
| searches/searchResults/donors |
| Field | Details |
|---|
| pagination | {...} | | searchId* | integer
nullable: false
minimum: 1 | | filters | {...} | | sortBy | string
nullable: true
default: standard
Enum:
Array [ 2 ] |
|
| Field | Details |
|---|
| paging* | {...} | | searchResults* | [...] |
|
|
4.4 - Full report - Donors
A GET to the searches/donors/{searchResultsId} endpoint retrieves all available information of a specific donor in a search result.
| Get |
|---|
| searches/donors/{searchResultsId} |
| Field | Details |
|---|
| searchResultsId | integer Unique identifier of the donor within a search result. This is the "id" field within searchResult |
|
| 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 | {...} |
|
|
4.5 - Search results - CBUs
A POST to the searches/searchResults/cbus retrieveSearchResultsDonors endpoint is used to retrieve search results with cord blood units. Pagination is possible and optional filters can be provided.
| Post |
|---|
| searches/searchResults/cbus |
| Field | Details |
|---|
| pagination | {...} | | searchId* | integer
nullable: false
minimum: 1 | | filters | {...} | | sortBy | string
nullable: true
default: standardEnum:
Array [ 2 ] | | threeFourMismatchSortBy | string
nullable: true
default: resolutionScoreEnum:
Array [ 3 ] | | secondarySortBy | string
nullable: true
default: tncCountEnum:
Array [ 2 ] |
|
| Field | Details |
|---|
| paging* | {...} | | searchResults* | [...] |
|
|
4.6 - Full report - CBUs
A GET to the searches/cbus/{searchResultsId} endpoint retrieves all available information of a specific CBU in a search result.
| Get |
|---|
| searches/cbus/{searchResultsId} |
| Field | Details |
|---|
| searchResultsId | integer Unique identifier of the search. Can be determined by retrieving the patient search summary |
|
| 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 - use of API endpoints
Below is a diagram 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.
