Versions Compared

Old Version 38

changes.mady.by.user Matt Prestegaard

Saved on

compared with

New Version 39

changes.mady.by.user Mark Melchers

Saved on

Key

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

...

Send

startSearch

Expand
titleRequest...
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
Expand
titleResponse
FieldDetails
searchIdinteger
nullable: false
minimum: 1

4.2 - Search summary

The retrieveSearchResultssummary 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
retrieveSearchResultssummaryretrieveSearchResultsSummary
Expand
titleRequest
FieldDetails
searchId*integer
Expand
titleResponse
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

...

Send
retrieveSearchResultsDonors
Expand
titleRequest
FieldDetails
pagination{...}
searchId*integer
nullable: false
minimum: 1
filters{...}
sortBy

string
nullable: true
default: standard
Enum:
Array [ 2 ]

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

...

Send
retrieveSearchResultsDonors
Expand
titleRequest
FieldDetails
searchResultsIdinteger
Expand
titleResponse
FieldDetails
searchIdinteger
nullable: false
minimum: 1
searchTypestring
Enum:
Array [ 1 ]
matchDurationinteger
minimum: 0
nullable: true
example: 30

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

patient{...}
donor{...}

4.5 - Search results - CBUs

...

Send
retrieveSearchResultsCBUs
Expand
titleRequest
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 ]



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

...

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. 


Image RemovedImage Added