You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

3.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
  • wmdaId
  • matchEngine
  • searchType
  • overallMismatches
  • cbuABLowDrb1HighResolution

3.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. 


3.3 - Search results - Donors

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

3.4 - Full report - Donors

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

Send
retrieveSearchResultsDonors
  • searchResultsId

3.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. 

3.6 - Full report - CBUs

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

Send
retrieveFullReportCBUs
  • searchResultsId


3.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. 



  • No labels