Skip Navigation Bar
WISER Sharing and Collaboration API

As of version 6.0, WISER provides a sharing and collaboration API that is accessed via hyperlinks. All WISER platforms now support this API, leveraging these links to share substance information, material information, or reference documentation. All WISER links use the https protocol and webwiser.nlm.nih.gov domain. By default, all links point to WebWISER, the web version of WISER. If the user does not have WISER installed or is using the Mac or Windows platform, accessing a shared link will open WebWISER and display the indicated content. If the user has the iOS or Android version of WISER installed on their device, a shared link will be treated as a universal link or app link and open directly in the respective application. Links can be shared freely between WISER platforms via common text-based messaging channels, such as SMS or email. Alternatively, these links may be created manually using the specification below, allowing partners and external developers to access WISER content directly through this API.

For questions or comments regarding this API, please contact us using this form. The WISER team strives to make this API accessible and valuable to the developer community. If you are using it, please let us know!

Default URL Components

These components are required of all WISER API links.

URL component Value
Protocol https
Domain webwiser.nlm.nih.gov
Path See below. Examples include substance, material, or tools/referenceViewer

Note that all parameters and values are case sensitive. Make sure to replace spaces with the "%20" unicode character.

Substance Sharing

All substance links require either a substance ID or identification data (identifier and/or identifier type). If more than one substance matches the supplied identification data (e.g. multiple substances match UN/NA 1075), the result will be a set of WISER search results, regardless of the additional parameters that are supplied (they are ignored). If the result is unique, additional parameters noted in the sections below may be supplied to customize the type and display of the substance data. Note that only substanceId is guaranteed to be unique.

URL Path: substance

Parameter Description Required? Default Value
substanceId Unique ID of the desired substance

Note that the substanceId paramater always takes precedence. If identification information is also supplied (identifier, identifierType), it is checked for validity. If this identifying information is valid, it will be used as the identification metadata for the substance with the specified substanceId. If it is invalid, it is ignored.

Either the substanceId or identifier parameter must be provided N/A
identifier Common identifier for the substance

Identifiers supported by WISER:

  • name
  • alias
  • UN/NA
  • STCC
  • CAS RN

Either the substanceId or identifier parameter must be provided substance name
identifierType Type of identifier being used

Possible values:

  • name
  • alias
  • unna
  • stcc
  • casrn

No name

Substance Data

Show a specific piece of information for the given substance, such as key info or treatment data. These parameters must be used in combination with substance identification parameters.

Parameter Description Required? Default Value
catId Unique ID of the desired data page to be displayed Yes N/A
menuItemId This is the unique ID of the menu item used to navigate to the provided catId. For instance, in some profiles, protective distance is shown as a top-level leaf node in the menu; however, it also appears in the "Hazmat" collection of data categories. Though the category ID is the same in both of these cases (and thus the displayed data is the same as well), the menu item ID is different. No First menu item matching the provided category ID

Examples
Substance Imagery

Show medical imagery for the given substance. These parameters must be used in combination with substance identification parameters. Note that the catId parameter must be set to 186.

Parameter Description Required? Default Value
catId Unique ID for substance image data; must equal 186 Yes N/A
image Unique OID for the image No N/A

Chemical Reactivity

Show a chemical reaction for the given substance and a mix of substances and reactivity groups. These parameters must be used in combination with substance identification parameters. Note that the catId parameter must be set to 188.

Parameter Description Required? Default Value
catId Unique ID for substance chemical reactivity data; must equal 188 Yes N/A
subMix Comma-separated list of substance group IDs No N/A
groupMix Comma-separated list of reactivity group IDs No N/A

Examples
Protective Distance Data and Maps

Show the protective distance data for the given substance. These parameters must be used in combination with substance identification parameters. Note that the catId parameter must be set to 165.

Parameter Description Required? Default Value
catId Unique ID for protective distance data; must equal 165 Yes N/A
lat Latitude of the location in signed degrees format

Valid range is a decimal from -90.0 degrees to 90.0 degrees.

Yes* N/A
lon Longitude of the location in signed degrees format

Valid range is a decimal from -180.0 degrees to 180.0 degrees.

Yes* N/A
windDir This paremeter specifies the wind direction where the spill is taking place. Wind direction is reported by the direction from which it originates. For example, a northerly wind blows from the north to the south, and would have a windDir value of 0. Wind direction is usually reported in cardinal directions or in azimuth degrees. Wind direction is measured in degrees clockwise from due north.

Valid range is an integer from 0 degrees to 360 degrees.

Yes* N/A
showMap

Flag that signifies whether or not to display the map or protective distance data for the given substance.

true - Show the actual protective distance map.

false - Show the default protective distance data. All other protective distance parameters are ignored.

Yes* false
materialUn This parameter specifies the UN of the associated material and is paired with materialName. If materialUn is provided, materialName must also be provided. No Worst-case UN
materialName This parameter specifies the name of the associated material. Note that multiple materials can have the same UN, but no two materials will have the same UN and name. If materialName is provided, materialUn must also be provided. No Worst-case name
spillSize Specifies the size of the spill

Possible values:

  • small
  • large

No large
timeOfDay Specifies the time of day during which the spill occurred

Possible values:

  • day
  • night

No night
whereSpilled The surface on which the spill occurred; important for water-reactive materials

Possible values:

  • land
  • water

No land
containerType

The type of container

Possible values:

  • Rail tank car
  • Highway tank truck or trailer
  • Agricultural nurse tank
  • Multiple small cylinders
  • Multiple ton cylinders
  • Multiple small cylinders or single ton cylinder

No First available container
windSpeed The wind speed at the spill location

Possible values:

  • low
  • moderate
  • high

No low
mapType The type of 2D map to display

Possible values:

  • normal
  • satellite
  • hybrid

No normal
color This parameter represents the ARGB value for the color and opacity of the protective distance cone. ARGB values are expressed using 8 hexadecimal digits, with each pair of the hexadecimal digits representing the values of the Alpha, Red, Green and Blue channel, respectively. For example, 80FFFF00 represents 50.2% opaque yellow. No 50FFA500
hideLabels Flag that specifies whether or not to show the protective distance labels on the cone; available in WebWISER only

true - labels will be hidden.

false - labels will be shown

No false

* These parameters are only required and valid if you choose to display the protective distance map (set showMap equal to true). By default, only the data is displayed, making the map detail irrelevant.

Material Sharing

Materials within WISER are defined as substances found within the Department of Transportation's Emergency Response Guidebook (ERG). If desired, these materials may be displayed directly, resulting in the ERG reference page for that material. Material references require a UN and name. Material searches are not supported.

URL Path: material

Parameter Description Required? Default Value
materialUn This parameter specifies the UN of the associated material and is paired with materialName. Yes N/A
materialName This parameter specifies the name of the associated material. Note that multiple materials can have the same UN, but no two materials will have the same UN and name. Yes N/A

Reference Document Sharing

Reference documentation is supporting documentation provided within the WISER application. TThis category includes a wide range of content, including documentation from disparate resources (e.g. CHEMM, REMM, or ERG documentation).

Note that if both the topic and doc parameters are provided, the topic will be used.

URL Path: tools/referenceViewer

Parameter Description Required? Default Value
topic The unique ID for the displayed reference topic One of the topic or doc parameters must be provided N/A
doc The unique ID for the displayed reference document One of the topic or doc parameters must be provided N/A