Reference Data and Results

Reference data and Results classes for the KCDB API.

These classes represent the xs:complexType and xs:simpleType definitions in the KCDB XSD Schema.

AbsoluteRelative

Bases: Enum

CRM uncertainty mode.

Attributes:

Name	Type	Description
ABSOLUTE	str	"Absolute"
RELATIVE	str	"Relative"

Analyte dataclass

Analyte(id, label, value)

Bases: ReferenceData

An analyte of Chemistry and Biology.

Attributes:

Name	Type	Description
id	int	Analyte identity. Example: 1
label	str	Analyte label. Example: "nitrogen"
value	str	Analyte value. Example: "nitrogen"

Branch dataclass

Branch(id, label, value, metrology_area)

Bases: ReferenceData

A branch of General Physics or Ionizing Radiation.

Attributes:

Name	Type	Description
id	int	Branch identity. Example: 21
label	str	Branch label. Example: "PR/Fibre"
metrology_area	MetrologyArea	The metrology area that the branch belongs to.
value	str	Branch value. Example: "Fibre optics"

Category dataclass

Category(id, label, value)

Bases: ReferenceData

A category of Chemistry and Biology.

Attributes:

Name	Type	Description
id	int	Category identity. Example: 8
label	str	Category label. Example: "2"
value	str	Category value. Example: "Inorganic solutions"

Country dataclass

Country(id, label, value)

Bases: ReferenceData

Information about a country.

Attributes:

Name	Type	Description
id	int	Country identity. Example: 58
label	str	Country label. Example: "NZ"
value	str	Country value. Example: "New Zealand"

Domain dataclass

Domain(code, name)

The domain of either General Physics, Chemistry and Biology or Ionizing Radiation.

Attributes:

Name	Type	Description
code	str	Domain code. Example: "PHYSICS"
name	str	Domain name. Example: "General physics"

IndividualService dataclass

IndividualService(
    id, label, value, physics_code, sub_service
)

Bases: ReferenceData

An individual service of General Physics.

Attributes:

Name	Type	Description
id	int	Individual service identity. Example: 225
label	str	Individual service label. Example: "1"
physics_code	str	The physics code for this individual service. Example: "11.1.1"
sub_service	SubService	The sub service that the individual service belongs to.
value	str	Individual service value. Example: "Absolute power in coaxial line"

Medium dataclass

Medium(id, label, value, branch)

Bases: ReferenceData

A medium of Ionizing Radiation.

Attributes:

Name	Type	Description
branch	Branch	The branch that the medium belongs to.
id	int	Medium identity. Example: 5
label	str	Medium label. Example: "5"
value	str	Medium value. Example: "Aerosol"

MetrologyArea dataclass

MetrologyArea(id, label, value, domain)

Bases: ReferenceData

A metrology area of a domain.

Attributes:

Name	Type	Description
domain	Domain	The domain that the metrology area belongs to.
id	int	Metrology area identity. Example: 2
label	str	Metrology area label. Example: "EM"
value	str	Metrology area value. Example: "Electricity and Magnetism"

NonIonizingQuantity dataclass

NonIonizingQuantity(id, label, value)

Bases: ReferenceData

A quantity that is not Ionizing Radiation.

Attributes:

Name	Type	Description
id	int	Non-ionizing identity. Example: 109
label	str	Always an empty string. Example: ""
value	str	Non-ionizing value. Example: "Absorbance, regular, spectral"

Nuclide dataclass

Nuclide(id, label, value)

Bases: ReferenceData

A nuclide of Ionizing Radiation.

Attributes:

Name	Type	Description
id	int	Nuclide identity. Example: 1
label	str	Nuclide label. Example: "C-14"
value	str	Nuclide value. Example: "C-14"

Quantity dataclass

Quantity(id, label, value, branch)

Bases: ReferenceData

A quantity of Ionizing Radiation.

Attributes:

Name	Type	Description
branch	Branch	The branch that the quantity belongs to.
id	int	Quantity identity. Example: 1
label	str	Quantity label. Example: "1"
value	str	Quantity value. Example: "Absorbed dose/rate to air"

ReferenceData dataclass

ReferenceData(id, label, value)

Base class for reference data.

Attributes:

Name	Type	Description
id	int	Reference data identity. Example: 8
label	str	Reference data label. Example: "QM"
value	str	Reference data value. Example: "Chemistry and Biology"

ResultAggregation

ResultAggregation(kwargs)

Aggregation representation.

Attributes:

Name	Type	Description
name	str	Aggregation name. Example: "cmcCountries"
values	list[str]	Aggregation values. Example: ["Kazakhstan", "Portugal", "Greece"]

ResultChemistryBiology

ResultChemistryBiology(kwargs)

Bases: ResultCommon

Chemistry and Biology result.

Attributes:

Name	Type	Description
analyte_matrix	str	Analyte matrix. Example: "high purity antimony"
analyte_value	str	Analyte value. Example: "antimony"
approval_date	str	Approval date (YYYY-MM-DD).
category_label	int	Category identifier. Example: 1
category_value	str	Category value. Example: "High purity chemicals"
cmc	ResultUnit | None	CMC result unit.
cmc_base_unit	ResultUnit | None	CMC base unit.
cmc_uncertainty	ResultUnit | None	CMC uncertainty.
cmc_uncertainty_base_unit	ResultUnit | None	CMC uncertainty base unit.
comments	str	Comments.
confidence_level	float | None	Confidence level.
country_value	str	Country full name. Example: "China"
coverage_factor	float | None	Coverage factor.
crm	ResultUnit | None	CRM unit.
crm_confidence_level	float | None	CRM confidence level.
crm_coverage_factor	float | None	CRM coverage factor.
crm_uncertainty	ResultUnit | None	CRM uncertainty.
crm_uncertainty_equation	ResultEquation | None	CRM uncertainty equation.
crm_uncertainty_mode	AbsoluteRelative | None	CRM uncertainty mode.
crm_uncertainty_table	ResultTable | None	CRM uncertainty table.
domain_code	str	Domain code. Example: "CHEM-BIO"
group_identifier	str	Group identifier.
id	int	Document database id.
kcdb_code	str	Document KCDB code. Example: "APMP-QM-CN-00000JZR-1"
kcdb_service_category	str	KCDB service category. Example: "QM-5.1"
measurement_technique	str	Measurement technique. Example: "Liquid-solid extraction with SPE cleanup and bracketing LC-IDMS/MS"
mechanism	str	Mechanism. Example: "Customer service; GD-MS-200; delivery only to other NMIs"
metrology_area_label	str	Metrology area label. Example: "QM"
nmi_code	str	NMI code. Example: "NIM"
nmi_name	str	NMI name. Example: "National Institute of Metrology"
nmi_service_code	str	NMI service code. Example: "NIM/11.1.4a"
nmi_service_link	str	NMI service link.
publication_date	str	Publication date (YYYY-MM-DD).
quantity_value	str	Quantity value. Example: "Absorbed dose/rate"
rmo	str	RMO acronym. Example: "EURAMET"
status	str	CMC status. Example: "Published"
status_date	str	Last status date (YYYY-MM-DD).
sub_category_label	int	Sub category identifier. Example: 1
sub_category_value	str	Sub category value. Example: "Fresh water"
traceability_source	str	Traceability source. Example: "VSL"
uncertainty_convention	UncertaintyConvention | None	Uncertainty convention.
uncertainty_equation	ResultEquation | None	Uncertainty equation.
uncertainty_mode	AbsoluteRelative | None	Uncertainty mode.
uncertainty_table	ResultTable | None	Uncertainty table.

ResultCommon

ResultCommon(kwargs)

Common attributes for advanced search results.

Attributes:

Name	Type	Description
approval_date	str	Approval date (YYYY-MM-DD).
cmc	ResultUnit | None	CMC result unit.
cmc_base_unit	ResultUnit | None	CMC base unit.
cmc_uncertainty	ResultUnit | None	CMC uncertainty.
cmc_uncertainty_base_unit	ResultUnit | None	CMC uncertainty base unit.
comments	str	Comments.
confidence_level	float | None	Confidence level.
country_value	str	Country full name. Example: "China"
coverage_factor	float | None	Coverage factor.
domain_code	str	Domain code. Example: "CHEM-BIO"
group_identifier	str	Group identifier.
id	int	Document database id.
kcdb_code	str	Document KCDB code. Example: "APMP-QM-CN-00000JZR-1"
metrology_area_label	str	Metrology area label. Example: "QM"
nmi_code	str	NMI code. Example: "NIM"
nmi_name	str	NMI name. Example: "National Institute of Metrology"
nmi_service_code	str	NMI service code. Example: "NIM/11.1.4a"
nmi_service_link	str	NMI service link.
publication_date	str	Publication date (YYYY-MM-DD).
quantity_value	str	Quantity value. Example: "Absorbed dose/rate"
rmo	str	RMO acronym. Example: "EURAMET"
status	str	CMC status. Example: "Published"
status_date	str	Last status date (YYYY-MM-DD).
traceability_source	str	Traceability source. Example: "VSL"
uncertainty_equation	ResultEquation | None	Uncertainty equation.
uncertainty_mode	AbsoluteRelative | None	Uncertainty mode.
uncertainty_table	ResultTable | None	Uncertainty table.

ResultEquation

ResultEquation(kwargs)

Equation representation.

Attributes:

Name	Type	Description
equation	str	Equation name.
equation_comment	str	Equation comment.

ResultFilter

ResultFilter(kwargs)

Filter representation.

Attributes:

Name	Type	Description
children	list[ResultFilter]	Filter children.
code	str	Filter code. Example: "cmcMaterial"
count	int	Filter count.
name	str	Filter name. Example: "cmcMaterial"
order	int	Filter order.

ResultParam

ResultParam(kwargs)

Parameter representation.

Attributes:

Name	Type	Description
parameter_name	str	Parameter name. Example: "S21 and S12"
parameter_value	str	Parameter value. Example: "-80 dB to 0 dB"

ResultPhysics

ResultPhysics(kwargs)

Bases: ResultCommon

General Physics result.

Attributes:

Name	Type	Description
approval_date	str	Approval date (YYYY-MM-DD).
branch_label	str	Branch label. Example: "PR/Photo"
branch_value	str	Branch value. Example: "Photometry"
cmc	ResultUnit | None	CMC result unit.
cmc_base_unit	ResultUnit | None	CMC base unit.
cmc_uncertainty	ResultUnit | None	CMC uncertainty.
cmc_uncertainty_base_unit	ResultUnit | None	CMC uncertainty base unit.
comments	str	Comments.
confidence_level	float | None	Confidence level.
country_value	str	Country full name. Example: "China"
coverage_factor	float | None	Coverage factor.
domain_code	str	Domain code. Example: "CHEM-BIO"
group_identifier	str	Group identifier.
id	int	Document database id.
individual_service_value	str	Individual service value. Example: "Tungsten source"
instrument	str	Instrument. Example: "Illuminance meter"
instrument_method	str	Instrument method. Example: "Standard lamp"
international_standard	str	International standard. Example: "EURAMET Cg19, ISO 8655-6"
kcdb_code	str	Document KCDB code. Example: "APMP-QM-CN-00000JZR-1"
kcdb_service_category	str	KCDB service category. Example: "PR/Photo/1.2.1"
metrology_area_label	str	Metrology area label. Example: "QM"
nmi_code	str	NMI code. Example: "NIM"
nmi_name	str	NMI name. Example: "National Institute of Metrology"
nmi_service_code	str	NMI service code. Example: "NIM/11.1.4a"
nmi_service_link	str	NMI service link.
parameters	list[ResultParam]	Parameters list with name and value.
physics_code	str	Physics code. Example: "1.2.1"
publication_date	str	Publication date (YYYY-MM-DD).
quantity_value	str	Quantity value. Example: "Absorbed dose/rate"
rmo	str	RMO acronym. Example: "EURAMET"
service_value	str	Service value. Example: "Photometry"
status	str	CMC status. Example: "Published"
status_date	str	Last status date (YYYY-MM-DD).
sub_service_value	str	Sub service value. Example: "Illuminance responsivity"
traceability_source	str	Traceability source. Example: "VSL"
uncertainty_equation	ResultEquation | None	Uncertainty equation.
uncertainty_mode	AbsoluteRelative | None	Uncertainty mode.
uncertainty_table	ResultTable | None	Uncertainty table.

ResultRadiation

ResultRadiation(kwargs)

Bases: ResultCommon

Ionizing Radiation result.

Attributes:

Name	Type	Description
approval_date	str	Approval date (YYYY-MM-DD).
branch_label	str	Branch label. Example: "RAD"
branch_value	str	Branch value. Example: "Radioactivity"
cmc	ResultUnit | None	CMC result unit.
cmc_base_unit	ResultUnit | None	CMC base unit.
cmc_uncertainty	ResultUnit | None	CMC uncertainty.
cmc_uncertainty_base_unit	ResultUnit | None	CMC uncertainty base unit.
comments	str	Comments.
confidence_level	float | None	Confidence level.
country_value	str	Country full name. Example: "China"
coverage_factor	float | None	Coverage factor.
domain_code	str	Domain code. Example: "CHEM-BIO"
group_identifier	str	Group identifier.
id	int	Document database id.
instrument	str	Instrument. Example: "Multiple nuclide source, solution"
instrument_method	str	Instrument method. Example: "Ge detector, multichannel analyzer"
international_standard	str	International standard. Example: "EURAMET Cg19, ISO 8655-6"
kcdb_code	str	Document KCDB code. Example: "APMP-QM-CN-00000JZR-1"
kcdb_service_category	str	KCDB service category. Example: "RI/RAD-1.3.2"
medium_value	str	Medium value. Example: "Liquid"
metrology_area_label	str	Metrology area label. Example: "QM"
nmi_code	str	NMI code. Example: "NIM"
nmi_name	str	NMI name. Example: "National Institute of Metrology"
nmi_service_code	str	NMI service code. Example: "NIM/11.1.4a"
nmi_service_link	str	NMI service link.
nuclide_value	str	Nuclide value. Example: "Cr-51"
publication_date	str	Publication date (YYYY-MM-DD).
quantity_value	str	Quantity value. Example: "Absorbed dose/rate"
radiation_code	str	Radiation code separated by a dot for branch, quantity, source, medium. Example: "2.1.3.2"
radiation_specification	str	Radiation specification name. Example: "10 ml to 500 ml NMIJ/AIST standard cylindrical plastic bottle"
reference_standard	str	Reference standard. Example: "Comparison with the NMIJ/AIST standard source"
rmo	str	RMO acronym. Example: "EURAMET"
source_value	str	Source value. Example: "Multi-radionuclide source"
status	str	CMC status. Example: "Published"
status_date	str	Last status date (YYYY-MM-DD).
traceability_source	str	Traceability source. Example: "VSL"
uncertainty_equation	ResultEquation | None	Uncertainty equation.
uncertainty_mode	AbsoluteRelative | None	Uncertainty mode.
uncertainty_table	ResultTable | None	Uncertainty table.

ResultTable

ResultTable(kwargs)

Table representation.

Attributes:

Name	Type	Description
table_cols	int	Number of columns in table.
table_comment	str	Table comment.
table_contents	str	Table contents. Example: "{"row_1":{"col_1":"val1","col_2":"val2"}}"
table_name	str	Table name. Example: "CH_Scatt-Atten_Mag"
table_rows	int	Number of rows in table.

ResultUnit

ResultUnit(kwargs)

Units object definition.

Attributes:

Name	Type	Description
lower_limit	float | None	Lower limit value.
unit	str	Unit symbol. Example: "%"
upper_limit	float | None	Upper limit value.

Results

Results(kwargs)

Attributes for advanced search results.

Attributes:

Name	Type	Description
number_of_elements	int	Number of elements on this page.
page_number	int	The page number (first page is 0) of the request.
page_size	int	The page size that was requested.
total_elements	int	Total number of elements available (in all pages).
total_pages	int	Total number of pages.
version_api_kcdb	str	KCDB API version. Example: "1.0.9"

ResultsChemistryBiology

ResultsChemistryBiology(kwargs)

Bases: Results

Chemistry and Biology search results.

Attributes:

Name	Type	Description
data	list[ResultChemistryBiology]	Chemistry and Biology result data.
number_of_elements	int	Number of elements on this page.
page_number	int	The page number (first page is 0) of the request.
page_size	int	The page size that was requested.
total_elements	int	Total number of elements available (in all pages).
total_pages	int	Total number of pages.
version_api_kcdb	str	KCDB API version. Example: "1.0.9"

ResultsPhysics

ResultsPhysics(kwargs)

Bases: Results

General Physics search results.

Attributes:

Name	Type	Description
data	list[ResultPhysics]	General Physics result data.
number_of_elements	int	Number of elements on this page.
page_number	int	The page number (first page is 0) of the request.
page_size	int	The page size that was requested.
total_elements	int	Total number of elements available (in all pages).
total_pages	int	Total number of pages.
version_api_kcdb	str	KCDB API version. Example: "1.0.9"

ResultsQuickSearch

ResultsQuickSearch(kwargs)

Bases: Results

Quick search results.

Attributes:

Name	Type	Description
aggregations	list[ResultAggregation]	The aggregations list.
data	list[Any]	The quick search result data.
filters_list	list[ResultFilter]	The filters list.
number_of_elements	int	Number of elements on this page.
page_number	int	The page number (first page is 0) of the request.
page_size	int	The page size that was requested.
total_elements	int	Total number of elements available (in all pages).
total_pages	int	Total number of pages.
version_api_kcdb	str	KCDB API version. Example: "1.0.9"

ResultsRadiation

ResultsRadiation(kwargs)

Bases: Results

Ionizing Radiation search results.

Attributes:

Name	Type	Description
data	list[ResultRadiation]	Ionizing Radiation result data.
number_of_elements	int	Number of elements on this page.
page_number	int	The page number (first page is 0) of the request.
page_size	int	The page size that was requested.
total_elements	int	Total number of elements available (in all pages).
total_pages	int	Total number of pages.
version_api_kcdb	str	KCDB API version. Example: "1.0.9"

Service dataclass

Service(id, label, value, branch, physics_code)

Bases: ReferenceData

A service of General Physics.

Attributes:

Name	Type	Description
branch	Branch	The branch that the service belongs to.
id	int	Service identity. Example: 16
label	str	Service label. Example: "6"
physics_code	str	The physics code for this service. Example: "6"
value	str	Service value. Example: "AC current"

Source dataclass

Source(id, label, value, branch)

Bases: ReferenceData

A source of Ionizing Radiation.

Attributes:

Name	Type	Description
branch	Branch	The branch that the source belongs to.
id	int	Source identity. Example: 3
label	str	Source label. Example: "3"
value	str	Source value. Example: "Beta radiation"

SubService dataclass

SubService(id, label, value, physics_code, service)

Bases: ReferenceData

A sub service of General Physics.

Attributes:

Name	Type	Description
id	int	Sub service identity. Example: 33
label	str	Sub service label. Example: "1"
physics_code	str	The physics code for this sub service. Example: "6.1"
service	Service	The service that the sub service belongs to.
value	str	Sub service value. Example: "AC-DC current transfer"

UncertaintyConvention

Bases: Enum

Chemistry and Biology uncertainty convention.

Attributes:

Name	Type	Description
ONE	str	"One"
TWO	str	"Two"