4.1 - Start search

The startSearch endpoint is used to submit a search request to the Search & Match Service.  This call returns a searchId for the search. 

Send

startSearch

FieldDetails
wmdaId*integer
example: 123456
nullable: false
matchEngine*integer
nullable: false

Unique identifier of match engine used in the search. Allowed: 2 (HAP-E), 3 (ATLAS).

Enum:
Array [ 2 ]
searchType*string
example: DREnum:
Array [ 2 ]
overallMismatchesinteger
default: 0Enum:
Array [ 8 ]
lociToBeConsidered[...]
isCbuAbLowDrb1HighResolutionboolean
default: false
nullable: true
FieldDetails
searchIdinteger
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
FieldDetails
searchId*integer
FieldDetails
patient{...}
searchId*integer
nullable: false
minimum: 1
searchType*stringEnum:
Array [ 1 ]
matchEngine*integer
nullable: false

Unique 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: true

Total number of donors which phenotype cannot be explained by known haplotype

statistics*{...}
error*{...}
nullable: true
lociToBeConsidered[...]
lastUpdatedstring($date-time)
nullable: false
maxLength: 255

needed to help determine when patient can be automatically moved to STP state


4.3 - Search results - Donors

The retrieveSearchResultsDonors endpoint is used to retrieve search results for donors. Pagination is possible and optional filters can be provided. 

Send
retrieveSearchResultsDonors
FieldDetails
pagination{...}
searchId*integer
nullable: false
minimum: 1
filters{...}
sortBystring
nullable: true
default: standardEnum:
Array [ 2 ]
FieldDetails
paging*{...}
searchResults*[...]

4.4 - Full report - Donors

The retrieveFullReportDonors endpoint is used to retrieve all available information for a specific donor in a search result. 

Send
retrieveSearchResultsDonors
FieldDetails
searchResultsIdinteger
FieldDetails
searchIdinteger
nullable: false
minimum: 1
searchTypestringEnum:
Array [ 1 ]
matchDurationinteger
minimum: 0
nullable: true
example: 30

time in seconds that the search took to run on the matching engine

patient{...}
donor{...}
integer
nullable: false
minimum: 1

4.5 - Search results - CBUs

The retrieveSearchResultsDonors endpoint is used to retrieve search results for cord blood units. Pagination is possible and optional filters can be provided. 

Send
retrieveSearchResultsCBUs
FieldDetails
pagination{...}
searchId*integer
nullable: false
minimum: 1
filters{...}
sortBystring
nullable: true
default: standardEnum:
Array [ 2 ]
threeFourMismatchSortBystring
nullable: true
default: resolutionScoreEnum:
Array [ 3 ]
secondarySortBystring
nullable: true
default: tncCountEnum:
Array [ 2 ]
integer
nullable: false
minimum: 1



FieldDetails
paging*{...}
searchResults*[...]

4.6 - Full report - CBUs

The retrieveFullReportCBUs endpoint is used to retrieve all available information for a specific CBU in a search result. 

Send
retrieveFullReportCBUs
Field

Details

searchResultsId

integer

Unique identifier of the search.  Can be determined by retrieving patient search summary

FieldDetails
searchIdinteger
nullable: false
minimum: 1
searchTypestringEnum:
Array [ 1 ]
matchDurationinteger
minimum: 0
nullable: true
example: 30

time in seconds that the search took to run on the matching engine

patient{...}
cbu{...}


4.7 - Suggested use of API endpoints

Below is a diagram indicated 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.