Sign in

v1

latestOpenAPI 3.0.02026-07-147042.6 KB
cari7

The effective dose rate calculated for a single particle type, or accumulated over all particle types.

Effective Dose is a radiation protection quantity defined by the International Commission on Radiological Protection (ICRP) and represents the stochastic health risk to the human body at low levels of radiation. It accounts for the different sensitivities of organs to ionising radiation, as well as the different effectiveness of various types of radiation. Use this endpoint if you need to estimate radiation exposures of personnel.

get/cari7/effective_dose

Query parameters

altitudenumber required
Example:11

Altitude (in km). The minimum is 0 m, the maximum is 47 km (the upper limit of the stratosphere).

latitudenumber required
Example:30

Latitude. -90 (S) to 90 (N).

longitudenumber required
Example:30

Longitude. -180 (W) to 180 (E).

yearinteger required
Example:2019

Year in YYYY.

monthinteger required
Example:12

Month in MM.

dayinteger required
Example:1

Day in DD.

utcinteger required
Example:3

Hour in 24 hour time.

particle'total' | 'neutron' | 'photon' | 'e-' | 'e+' | 'mu-' | 'mu+' | 'proton' | 'pi-' | 'pi+' | 'deuteron' | 'triton' | 'helion' | 'alpha' | 'Li' | 'Be' | 'B' | 'C' | 'N' | 'O' | 'F' | 'Ne' | 'Na' | 'Mg' | 'Al' | 'Si' | 'P' | 'S' | 'Cl' | 'Ar' | 'K' | 'Ca' | 'Sc' | 'Ti' | 'V' | 'Cr' | 'Mn' | 'Fe' required
Example:total

The particle type as a string. Specifying 'total' returns the dose for all particle types.

Response

Successful dose calculation

Example response

{
  "dose rate": {
    "units": "uSv/hr",
    "value": 2.1532952875056712
  }
}