Versions Compared

Old Version 6

changes.mady.by.user Matt Prestegaard

Saved on

compared with

New Version 7

changes.mady.by.user Matt Prestegaard

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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*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 ]
overallMismatches
cbuABLowDrb1HighResolution
integer
default: 0Enum:
Array [ 8 ]
lociToBeConsidered[...]
isCbuAbLowDrb1HighResolutionboolean
default: false
nullable: true

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. 

...