...
| Send |
|---|
| retrieveSearchResultsCBUs |
{Request: | pagination | { | offset | integer($int32)
default: 0 | | limit | integer($int32)
default: 100Maximum number of records per page. |
} | | searchId* | integer
nullable: false
minimum: 1 | | filters | { | description: | The search parameters used for finding search results. | | mismatchLocusAllowed | [...] | | dpb1MatchGrade | [...] | | donorRegistryIon | [...] | | registryAccreditationStatus | [...] | | sex | [...] | | cmvStatus | [...] | | abo | [...] | | isSelected | boolean
nullable: true
default: null
example: falseFilter for only returning donors/CBUs marked as selected | | onlyRecordsWithDrb1 | boolean
nullable: true
default: false
example: falseDo no use - Obsolete. Filter for whether or not to return donors without DRB1 typing. Replaced by requiredTypedLoci | | requiredTypedLoci | [...] | | inexplicable | string
nullable: true
default: null
example: OnlyInexplicableFilter for only returning donors/CBUs marked as selected Enum:
Array [ 4 ] | | status | [...] | | allowedMismatchedAlleles | {...} | | minimumTncCount | number
example: 1140000000
nullable: true | | minimumCd34Count | number
example: 3900000
nullable: true | | cbbAccreditationStatus | [...] |
} | | sortBy | string
nullable: true
default: standardEnum:
[ standard, sumOfProbabilities ] | | threeFourMismatchSortBy | string
nullable: true
default: resolutionScoreEnum:
[ none, resolutionScore, standard (not yet available) ] | | secondarySortBy | string
nullable: true
default: tncCountEnum:
[ tncCount, cd34Count ] |
Response: {
{ | | limit* | integer
default: 100
minimum: 0 | | offset* | integer
default: 0
minimum: 0 | | totalCount* | integer
minimum: 0 |
|
} | | searchResults* | [
minItems: 0 |
{| id* | integer
nullable: false
example: 5176 | | donorRegistryIon* | integer
nullable: false
minimum: 1000
maximum: 9999
example: 1234 | | abbreviation* | string
example: NL-WMDA
maxLength: 24 | | haplotypeFrequencySetId* | integer
nullable: true
minimum: 0
example: 15 | | status* | string
nullable: falseEnum:
Array [ 3 ] | | sex* | string
nullable: trueEnum:
Array [ 2 ] | | ethnicity* | string
nullable: trueEnum:
Array [ 21 ] | | idm* | {...} | | abo* | string
nullable: trueEnum:
Array [ 4 ] | | rhesus* | string
nullable: trueEnum:
Array [ 2 ] | | registryAccreditationStatus* | string
nullable: trueEnum:
Array [ 2 ] | | firstAccreditationYear* | number
minimum: 1990
maximum: 2100
nullable: true
example: 2019 | | matchClass* | string
example: 9/10
nullable: false | | nmdpGrade* | string
maxLength: 5
example: MPPMP
nullable: trueA - high-res match on ARD, P - probable match, M - sure Mismatch | | zeroMismatchProbability* | integer
minimum: 0
maximum: 100
nullable: true | | oneMismatchProbability* | integer
nullable: true
minimum: 0
maximum: 100 | | twoMismatchProbability* | integer
nullable: true
minimum: 0
maximum: 100 | | aLocusMatchProbability* | integer
nullable: true
minimum: 0
maximum: 100 | | bLocusMatchProbability* | integer
nullable: true
minimum: 0
maximum: 100 | | cLocusMatchProbability* | integer
nullable: true
minimum: 0
maximum: 100 | | drLocusMatchProbability* | integer
nullable: true
minimum: 0
maximum: 100 | | dqLocusMatchProbability* | integer
nullable: true
minimum: 0
maximum: 100 | | inexplicable* | boolean | | matchingInformationDpb1* | {...} | | mismatches* | [...] | | searchResultRecordState* | string
nullable: false
default: ExistingEnum:
Array [ 4 ] | | searchResultRecordStateUpdatedAt* | string($date-time)
nullable: true
maxLength: 255date and time when the last change was registered in the system | | isSelected* | boolean
nullable: truetrue when this record has been marked as a selected | | resolutionScore* | number
minimum: 0
maximum: 100
nullable: true
example: 54 | | resolutionString* | string
minLength: 5
maxLength: 5
example: AP-A-
nullable: trueA - high-res P - low or intermediate, - no typing | | cordId* | string
nullable: true
maxLength: 25
example: 9991012070433202000 | | donorType* | stringEnum:
Array [ 1 ] | | collectionDate* | string($date)
minLength: 10
maxLength: 10
nullable: true
example: 2021-05-27 | | volume* | integer
example: 25
nullable: true | | tncCount* | number
example: 1140000000
nullable: true | | cd34Count* | number
example: 3900000
nullable: true | | viability* | integer
minimum: 0
maximum: 100
example: 97
nullable: true | | attachedSegmentsCount* | integer
nullable: true
minimum: 0
maximum: 99
example: 2 | | bankManufacturerIdWmda* | integer
example: 5432
nullable: true | | cbbAccreditationStatus* | string
nullable: trueEnum:
Array [ 3 ] | | hla* | {... |
|
}}] |
4.6 - Full report - CBUs
The retrieveFullReportCBUs endpoint is used to retrieve all available information for a specific CBU in a search result.
...