HIV Molecular Immunology API

About

License

No license specified.

Contact information

immuno@lanl.gov

https://www.hiv.lanl.gov/content/immunology/index.html

Servers

http://www.hiv.lanl.gov/mojo/immunology/api/v2

Terms of service

https://www.lanl.gov/resources/web-policies/copyright-legal.php

Resources

getEpitopes

GET /mojo/immunology/api/v2/epitope/{table}
Operation ID: getEpitopes

Finds epitope records in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes	Which table to search
binding_type	query		No	Antibody binding type ID
dna_end	query	integer	No	Search for epitopes before this DNA location
dna_start	query	integer	No	Search for epitopes after this DNA location
end	query	integer	No	Search for epitopes before this protein location; requires protein
hla_id	query		No	Epitope Restricting HLA/MHC ID
id	query		No	Epitope ID
immunogen	query		No	Immunogen ID
isotype	query		No	Isotype ID
keyword	query		No	Epitope keyword ID
outcome	query		No	Outcome ID
protein	query		No	Epitope is from this protein ID
pubmed_id	query		No	PubMed ID of epitope references
spans	query	integer	No	Search for epitopes at this protein location; requires protein
species	query		No	Immune response observed in this species ID
start	query	integer	No	Search for epitopes after this protein location; requires protein
subtype	query		No	Virus subtype ID
vaccine_adjuvant	query		No	Vaccine adjuvant ID
vaccine_component	query		No	Vaccine component ID
vaccine_strain	query		No	Vaccine viral strain ID
vaccine_type	query		No	Vaccine type ID
author	query	string	No	Author of a reference
cite	query	string	No	Citation key of a reference
epitope	query	string	No	Epitope sequence
epitope_name	query	string	No	Epitope name
hla	query	string	No	Restricting MHC/HLA of the epitope. T cell only
mab_name	query	string	No	Name of the monoclonal antibody (mAb)
note	query	string	No	Text in a note
protein_name	query	string	No	Epitope is from this protein
epitope_exact	query	string	No	How to match epitope sequence
range_span	query	string	No	How to match epitope position
dna_range_span	query	string	No	How to match epitope DNA position
author_first	query	boolean	No	Restrict author search to first authors
author_last	query	boolean	No	Restrict author search to last authors
au_filter	query	boolean	No	Show only this author’s references (Ab only)
kw_filter	query	boolean	No	Show only notes containing selected keyword(s) (Ab only)
note_filter	query	boolean	No	Show only notes matching this text (Ab only)

Response 200

Epitopes

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EpitopeResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

getPatients

GET /mojo/immunology/api/v2/patient
Operation ID: getPatients

Finds patient records in the database

Parameters

Name	In	Type	Required	Description
id	query		No	Patient ID
infection_year	query	integer	No	Infection year
patient_hla_id	query		No	Patient HLA ID
species	query		No	Species ID
ethnicity	query	string	No	Patient ethnicity
note	query	string	No	Patient note
patient_code	query	string	No	Patient code
patient_sex	query	string	No	Patient sex
progression	query	string	No	Patient HIV progression state code
risk_factor	query	string	No	Patient HIV risk factor code
patient_code_exact	query	boolean	No	Restrict author search to first authors

Response 200

Patients

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PatientResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

getVariants

GET /mojo/immunology/api/v2/variant/{table}
Operation ID: getVariants

Finds variant epitope records in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes	Which table to search
mutation_type_filter	query	boolean	No	Restrict variants to matching mutation type
variant_id_filter	query	boolean	No	Restrict variants to matching variant ID
variant_method_filter	query	boolean	No	Restrict variants to matching variant method
end	query	integer	No	Search for epitopes before this protein location; requires protein
epitope_id	query		No	Epitope ID
mutation_type_id	query		No	Variant mutation type ID
protein	query		No	Epitope is from this protein ID
spans	query	integer	No	Search for epitopes at this protein location; requires protein
start	query	integer	No	Search for epitopes after this protein location; requires protein
variant_id	query		No	Variant ID
variant_method_id	query		No	Search for variants with this variant method ID
cite	query	string	No	Citation key of a reference
epitope	query	string	No	Epitope or variant sequence
protein_name	query	string	No	Epitope is from this protein
epitope_exact	query	string	No	How to match epitope sequence
range_span	query	string	No	How to match epitope position

Response 200

Epitopes

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EpitopeResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listBindingType

GET /mojo/immunology/api/v2/list/binding_type/{table}
Operation ID: listBindingType

List binding types in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Binding types

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listBindingTypeResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listCountry

GET /mojo/immunology/api/v2/list/country/{table}
Operation ID: listCountry

List countries in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Countries

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listCountryResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listHLA

GET /mojo/immunology/api/v2/list/hla/{table}
Operation ID: listHLA

List restricting HLAs in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

HLAs

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listHLAResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listImmunogen

GET /mojo/immunology/api/v2/list/immunogen/{table}
Operation ID: listImmunogen

List immunogens in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Immunogens

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listImmunogenResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listIsotype

GET /mojo/immunology/api/v2/list/isotype/{table}
Operation ID: listIsotype

List isotypes in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Isotypes

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listIsotypeResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listKeyword

GET /mojo/immunology/api/v2/list/keyword/{table}
Operation ID: listKeyword

List keywords in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Keywords

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listKeywordResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listOutcome

GET /mojo/immunology/api/v2/list/outcome/{table}
Operation ID: listOutcome

List outcomes in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Outcomes

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listOutcomeResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listPatientEthnicity

GET /mojo/immunology/api/v2/patient_list/ethnicity
Operation ID: listPatientEthnicity

List ethnicities in the patient table

Parameters

This resource has no input parameters.

Response 200

Ethnicity

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listPatientEthnicityResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listPatientHLA

GET /mojo/immunology/api/v2/patient_list/hla
Operation ID: listPatientHLA

List patient HLAs in the database

Parameters

This resource has no input parameters.

Response 200

HLAs

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listPatientHLAResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listPatientInfectionCountry

GET /mojo/immunology/api/v2/patient_list/infection_country
Operation ID: listPatientInfectionCountry

List infection countries in the database

Parameters

This resource has no input parameters.

Response 200

Infection countries

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listPatientInfectionCountryResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listPatientInfectionYear

GET /mojo/immunology/api/v2/patient_list/infection_year
Operation ID: listPatientInfectionYear

List infection years in the database

Parameters

This resource has no input parameters.

Response 200

Infection countries

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listPatientInfectionYearResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listPatientProgression

GET /mojo/immunology/api/v2/patient_list/progression
Operation ID: listPatientProgression

List patient HIV progression in the database

Parameters

This resource has no input parameters.

Response 200

Patient HIV progression

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listPatientProgressionResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listPatientRiskFactor

GET /mojo/immunology/api/v2/patient_list/risk_factor
Operation ID: listPatientRiskFactor

List patient HIV risk factor in the database

Parameters

This resource has no input parameters.

Response 200

Patient HIV risk factor

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listPatientRiskFactorResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listPatientSex

GET /mojo/immunology/api/v2/patient_list/sex
Operation ID: listPatientSex

List sexes in the patient table

Parameters

This resource has no input parameters.

Response 200

Sex

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listPatientSexResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listPatientSpecies

GET /mojo/immunology/api/v2/patient_list/species
Operation ID: listPatientSpecies

List species in the patient table

Parameters

This resource has no input parameters.

Response 200

Species

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listPatientSpeciesResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listProtein

GET /mojo/immunology/api/v2/list/protein/{table}
Operation ID: listProtein

List HXB2 proteins in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

HXB2 protein

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listProteinResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listSpecies

GET /mojo/immunology/api/v2/list/species/{table}
Operation ID: listSpecies

List species in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Species

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listSpeciesResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listSubtype

GET /mojo/immunology/api/v2/list/subtype/{table}
Operation ID: listSubtype

List subtypes in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Subtypes

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listSubtypeResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listVaccineAdjuvant

GET /mojo/immunology/api/v2/list/vaccine_adjuvant/{table}
Operation ID: listVaccineAdjuvant

List vaccine adjuvants in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Vaccine adjuvants

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listVaccineAdjuvantResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listVaccineComponent

GET /mojo/immunology/api/v2/list/vaccine_component/{table}
Operation ID: listVaccineComponent

List vaccine components in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Vaccine components

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listVaccineComponentResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listVaccineStrain

GET /mojo/immunology/api/v2/list/vaccine_strain/{table}
Operation ID: listVaccineStrain

List vaccine strains in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Vaccine strains

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listVaccineStrainResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listVaccineType

GET /mojo/immunology/api/v2/list/vaccine_type/{table}
Operation ID: listVaccineType

List vaccine types in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

Vaccine types

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listVaccineTypeResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listVariantHLA

GET /mojo/immunology/api/v2/variant_list/hla/{table}
Operation ID: listVariantHLA

List restricting HLAs in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

HLAs

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listVariantHLAResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listVariantMethod

GET /mojo/immunology/api/v2/variant_list/method/{table}
Operation ID: listVariantMethod

List variant methods in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

variant method

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listVariantMethodResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listVariantMutationType

GET /mojo/immunology/api/v2/variant_list/mutation_type/{table}
Operation ID: listVariantMutationType

List mutation types in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listVariantMutationTypeResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

listVariantProtein

GET /mojo/immunology/api/v2/variant_list/protein/{table}
Operation ID: listVariantProtein

List HXB2 proteins in the database

Parameters

Name	In	Type	Required	Description
table	path		Yes

Response 200

HXB2 protein

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/listVariantProteinResponse"}}}

Response 400

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 401

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 404

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 500

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Response 501

Default response.

{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DefaultResponse"}}}

Parameters

Components

listBindingTypeResponse

listCountryResponse

listHLAResponse

listImmunogenResponse

listIsotypeResponse

listKeywordResponse

listOutcomeResponse

listPatientEthnicityResponse

listPatientHLAResponse

listPatientInfectionCountryResponse

listPatientInfectionYearResponse

listPatientProgressionResponse

listPatientRiskFactorResponse

listPatientSexResponse

listPatientSpeciesResponse

listProteinResponse

listSpeciesResponse

listSubtypeResponse

listVaccineAdjuvantResponse

listVaccineComponentResponse

listVaccineStrainResponse

listVaccineTypeResponse

listVariantHLAResponse

listVariantMethodResponse

listVariantMutationTypeResponse

listVariantProteinResponse

NoteRecord

OutcomeRecord

PatientEthnicityRecord

PatientHLARecord

PatientInfectionCountryRecord

PatientInfectionYearRecord

PatientProgressionRecord

PatientRecord

PatientResponse

PatientRiskFactorRecord

VaccineAdjuvantRecord

VaccineComponentRecord

VariantMutationTypeRecord

VariantProteinRecord

VariantRecord

VariantTable