E: Use Cases

Alleles

Returns alleles with their associated immunogenicity groups.

---

HTTP Method: GET
/alleles
Request: Request query parameters

• allele: allele name or URI
• group: group number (0-3)
• race: race code

Response: Response HTTP OK 200
Response body = application/json
Example

[
  {
    "allele": "HLA-DPB1*01:01",
    "group": 3,
    "race": "NAMER",
    "frequency": 0.05153
  },...
]

/alleles/{allele}
Request: Request query parameters

• allele: allele name or URI
• race: race code

Response: Response HTTP OK 200
Response body = application/json
Example

{
  "allele": "HLA-DPB1*01:01",
  "group": 3,
  "race": "NAMER",
  "frequency": 0.05153
}

---

HTTP Method: POST
/alleles
Request: body application/json, specify allele for which to associate immunogenicity group.

• Allele/s
• Group
• Race

Example

{
  "alleles": [
    "DPB1*01:01"
  ],
  "groups": [
    3
  ],
  "race": "NAMER"
}

Response: Response HTTP OK 200
Response body = application/json
Example

[
  {
    "allele": "HLA-DPB1*01:01",
    "group": 3,
    "race": "NAMER",
    "frequency": 0.05153
  },
  {
    "allele": "HLA-DPB1*01:01:01:01",
    "group": 3,
    "race": "NAMER",
    "frequency": 0.05153
  }, 
  {...
  },
   ...
]

---

---

Groups

Returns immunogenicity groups with their associated alleles.

---

HTTP Method: GET
/groups
Request: Request query parameters

• alleles
• groups
• race

Response: Response HTTP OK 200
Response body = application/json
Example

[
  {
    "group": 0,
    "race": "NAMER",
    "probability": 0.00056,
    "alleleList": [
      "HLA-DPB1*120:01N",
      "HLA-DPB1*154:01N",
      "HLA-DPB1*159:01N",
       ...
    ]
  },
  {
    "group": 3,
    "race": "NAMER",
    "probability": 0.99944,
    "alleleList": [
      "HLA-DPB1*01:01"
    ]
  }
]

/groups/{group}
Request: Request query parameters

• group (0-3)

Response: Response HTTP OK 200
Response body = application/json
Example

{
  "group": 3,
  "alleleList": [
    "HLA-DPB1*01:01",
    "HLA-DPB1*01:01:01:01",
    ...,
  ]
}

---

HTTP Method: POST
/groups
Request: body application/json, specify allele for which to associate immunogenicity group.

• Allele/s
• Group/s
• Race

Example

{
  "alleles": [
    "DPB1*01:01"
  ],
  "groups": [
    0
  ],
  "race": "AAFA"
}

Response: Response HTTP OK 200
Response body = application/json
Example

[
  {
    "group": 0,
    "race": "AAFA",
    "probability": 0.00137,
    "alleleList": [
      "HLA-DPB1*120:01N",
      "HLA-DPB1*154:01N",
      "HLA-DPB1*159:01N",
      ...
    ]
  },
  {
    "group": 3,
    "race": "AAFA",
    "probability": 0.99863,
    "alleleList": [
      "HLA-DPB1*01:01"
    ]
  }
]

---

---

Matches

Returns list of match results correlated by token (or genotypes, if no token is provided).

The reported match grade is the most optimistic outcome possible with a probability greater than 0.01.

---

HTTP Method: POST
/matches
Request: body application/json, specify match request for which to create match results.

• Recipient HLA-DPB1
• Recipient Race
• Donor HLA DPB1
• Donor Race
• Token (optional)

Example

[
  {
    "recipient": "DPB1*03:01:01:02",
    "recipientRace": "CAU",
    "donor": "DPB1*03:01:01:07",
    "donorRace": "CAU",
    "token": "string"
  }
]

Response: Response HTTP OK 200
Response body = application/json
Example

[
  {
    "token": "string",
    "matchProbability": 1,
    "permissiveMismatchProbability": 0,
    "hvgNonPermissiveMismatchProbability": 0,
    "gvhNonPermissiveMismatchProbability": 0,
    "unknownProbability": 0,
    "matchGrade": "MATCH"
  }
]

---

PUT, PATCH and DELETE not supported.