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 | ||||||||||||
|
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 |
|
The retrieveSearchResultsDonors endpoint is used to retrieve search results for donors. Pagination is possible and optional filters can be provided.
Send |
---|
retrieveSearchResultsDonors |
|
The retrieveFullReportDonors endpoint is used to retrieve all available information for a specific donor in a search result.
Send |
---|
retrieveSearchResultsDonors |
|
The retrieveSearchResultsDonors endpoint is used to retrieve search results for cord blood units. Pagination is possible and optional filters can be provided.
Send |
---|
retrieveSearchResultsCBUs |
|
The retrieveFullReportCBUs endpoint is used to retrieve all available information for a specific CBU in a search result.
Send |
---|
retrieveFullReportCBUs |
|
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.