Skip to content

REST Services API

Jump to bottom
Bruce Schubert edited this page Nov 4, 2018 · 1 revision

Revisions

Name Date Change Version
Bruce Schubert 2015.07.06 Initial Document 1.0

Contents

Introduction

This document contains the WMT REST Services documentation.

Sunlight

Resource
  • URL: /rs/sunlight
  • GET
  • Example: /rs/sunlight.json?time=2015-04-13T12:50-07:00&latitude=-34.2&longitude=-119.2"
Response
#!json

{
    "observerTime": "2015-07-04T05:19:51.278-07:00[America/Los_Angeles]",
    "observerLatitude": {"type": "Latitude", "value": "34.2", "unit": "deg"},
    "observerLongitude": {"type": "Longitude", "value": "-119.2", "unit": "deg"},
    "observerAltitude": {"type": "Altitude", "value": "0.0", "unit": "m"},
    "subsolarLatitude": {"type": "subsolar_lat:deg", "value": "22.871266284130332", "unit": "deg"},
    "subsolarLongitude": {"type": "subsolar_lon:deg", "value": "-3.8697908736235718", "unit": "deg"},
    "azimuthAngle": {"type": "azimuth:deg", "value": "56.89353027163992", "unit": "deg"},
    "altitudeAngle": {"type": "altitude:deg", "value": "-6.175449369022366", "unit": "deg"},
    "zenithAngle": {"type": "zenith:deg", "value": "96.17544936902236", "unit": "deg"},
    "localHourAngle": {"type": "hour:deg", "value": "244.66979087362358", "unit": "deg"},
    "sunriseHourAngle": {"type": "sunrise_hour:deg", "value": "-107.86718940052833", "unit": "deg"},
    "sunsetHourAngle": {"type": "sunset_hour:deg", "value": "107.83565447548936", "unit": "deg"},
    "sunriseTime": "05:49:57-07:00",
    "sunsetTime": "20:12:25-07:00",
    "sunTransitTime": "13:01:13-07:00"
}

Weather

Resource

  • URL: /rs/weather/pointforecast

  • GET:

  • URL: /rs/weather/areaobservations

  • GET:

Response
#!json

{
    "airTemperature":{"type":"air_temp:F","value":"65.0","unit":"fahrenheit"},
    "relativeHumidity":{"type":"rel_humidity:%","value":"20.0","unit":"%"},
    "windSpeed":{"type":"wind_speed:kts","value":"15.0","unit":"kt"},
    "windDirection":{"type":"wind_dir:deg","value":"270.0","unit":"deg"},
    "cloudCover":{"type":"cloud_cover:%","value":"10.0","unit":"%"}
}

Terrain (deprecated)

Resource
  • URL: /rs/terrain
  • GET Example:
Response
#!json

{
     "aspect":{"type":"aspect:deg","value":"0.0","unit":"deg"},
     "slope":{"type":"slope:deg","value":"0.0","unit":"deg"},
     "elevation":{"type":"elevation:m","value":"0.0","unit":"m"}
}

Fuel Models

Resource

  • URL: /rs/fuelmodels

  • GET

  • Example: /rs/fuelmodels/?category=all"

  • URL: /rs/fuelmodels/{modelNo}

  • GET

  • Example: /rs/fuelmode/{modelNo}?modelNo=6"

Response
#!json

{
   "modelNo":"6",
   "modelCode":"#6",
   "modelName":"Dormant brush, hardwood slash",
   "modelGroup":"Original 13",
   "dynamic":"false",
   "dead1HrFuelLoad":{"type":"fuel_load:kg/m2","value":"0.33625400183829446"},
   "dead10HrFuelLoad":{"type":"fuel_load:kg/m2","value":"0.5604233363971574"},
   "dead100HrFuelLoad":{"type":"fuel_load:kg/m2","value":"0.4483386691177259"},
   "liveHerbFuelLoad":{"type":"fuel_load:kg/m2","value":"0.0"},
   "liveWoodyFuelLoad":{"type":"fuel_load:kg/m2","value":"0.0"},
   "dead1HrSAVRatio":{"type":"surface_to_volume:m2/m3","value":"5741.469816272966"},
   "dead10HrSAVRatio":{"type":"surface_to_volume:m2/m3","value":"357.6115485564305"},
   "dead100HrSAVRatio":{"type":"surface_to_volume:m2/m3","value":"98.4251968503937"},
   "liveHerbSAVRatio":{"type":"surface_to_volume:m2/m3","value":"0.0"},
   "liveWoodySAVRatio":{"type":"surface_to_volume:m2/m3","value":"0.0"},
   "fuelBedDepth":{"type":"fuel_depth:m","value":"0.7619999999999999","unit":"m"},
   "moistureOfExtinction":{"type":"moisture_of_extinction:%","value":"25.0","unit":"%"},
   "lowHeatContent":{"type":"heat_content:kJ/kg","value":"18608.0"},
   "burnable":"true"
}

Fuel Moisture Scenarios

Resource
  • URL: /rs/fuelmoisture/scenarios
  • GET
Response

The array in the following example has been elided for brevity:

#!json

{
 "scenario" : [ {
    "name" : "Very Low Dead, Fully Cured Herb",
    "fuelMoisture" : {
      "dead1HrFuelMoisture" : { "type" : "fuel_moisture_1h:%", "value" : "3.0", "unit" : "%" },
      "dead10HrFuelMoisture" : { "type" : "fuel_moisture_10h:%", "value" : "4.0", "unit" : "%" },
      "dead100HrFuelMoisture" : { "type" : "fuel_moisture_100h:%", "value" : "5.0", "unit" : "%" },
      "liveHerbFuelMoisture" : { "type" : "fuel_moisture_herb:%", "value" : "30.0", "unit" : "%" },
      "liveWoodyFuelMoisture" : { "type" : "fuel_moisture_woody:%", "value" : "60.0", "unit" : "%" }
    }
  }, {
    "name" : "Very Low Dead, 2/3 Cured Herb",
    "fuelMoisture" : {
      "dead1HrFuelMoisture" : { "type" : "fuel_moisture_1h:%", "value" : "3.0", "unit" : "%" },
      "dead10HrFuelMoisture" : { "type" : "fuel_moisture_10h:%", "value" : "4.0", "unit" : "%" },
      "dead100HrFuelMoisture" : { "type" : "fuel_moisture_100h:%", "value" : "5.0", "unit" : "%" },
      "liveHerbFuelMoisture" : { "type" : "fuel_moisture_herb:%", "value" : "60.0", "unit" : "%" },
      "liveWoodyFuelMoisture" : { "type" : "fuel_moisture_woody:%", "value" : "90.0", "unit" : "%" }
    }
  } ]
}

Surface Fuel

Resource
  • URL: /rs/surfacefuel
  • POST
Response
#!json

{
    "fuelModel": {
       "modelNo": "4",
       "modelCode": "#4",
       "modelName": "Chaparral (6 feet)",
       "modelGroup": "Original 13",
       "dynamic": "false",
       "dead1HrFuelLoad": {"type": "fuel_load:kg/m2", "value": "1.1230883661399034"},
       "dead10HrFuelLoad": {"type": "fuel_load:kg/m2", "value": "0.8989190315810404"},
       "dead100HrFuelLoad": {"type": "fuel_load:kg/m2", "value": "0.4483386691177259"},
       "liveHerbFuelLoad": {"type": "fuel_load:kg/m2", "value": "0.0"},
       "liveWoodyFuelLoad": {"type": "fuel_load:kg/m2", "value": "1.1230883661399034"},
       "dead1HrSAVRatio": {"type": "surface_to_volume:m2/m3", "value": "6561.679790026247"},
       "dead10HrSAVRatio": {"type": "surface_to_volume:m2/m3", "value": "357.6115485564305"},
       "dead100HrSAVRatio": {"type": "surface_to_volume:m2/m3", "value": "98.4251968503937"},
       "liveHerbSAVRatio": {"type": "surface_to_volume:m2/m3", "value": "0.0"},
       "liveWoodySAVRatio": {"type": "surface_to_volume:m2/m3", "value": "4921.259842519685"},
       "fuelBedDepth": {"type": "fuel_depth:m", "value": "1.8287999999999998", "unit": "m"},
       "moistureOfExtinction": {"type": "moisture_of_extinction:%", "value": "20.0", "unit": "%"},
       "lowHeatContent": {"type": "heat_content:kJ/kg", "value": "18608.0"}, "burnable": "true"},
   "fuelMoisture": {
       "dead1HrFuelMoisture": {"type": "fuel_moisture_1h:%", "value": "3.0", "unit": "%"},
       "dead10HrFuelMoisture": {"type": "fuel_moisture_10h:%", "value": "4.0", "unit": "%"},
       "dead100HrFuelMoisture": {"type": "fuel_moisture_100h:%", "value": "5.0", "unit": "%"},
       "liveHerbFuelMoisture": {"type": "fuel_moisture_herb:%", "value": "30.0", "unit": "%"},
       "liveWoodyFuelMoisture": {"type": "fuel_moisture_woody:%", "value": "60.0", "unit": "%"}},
   "fuelTemperature": {"type": "fuel_temp:F", "value": "NaN", "unit": "fahrenheit"},
   "meanBulkDensity": {"type": "bulk_density:lb/ft3", "value": "0.12266556382050901"},
   "fuelParticleDensity": {"type": "particle_density:lb/ft3", "value": "32.0"},
   "meanPackingRatio": {"type": "mean_packing_ratio", "value": "0.0038332988693909067", "unit": ""},
   "optimalPackingRatio": {"type": "optimal_packing_ratio", "value": "0.007434592860248393", "unit": ""},
   "relativePackingRatio": {"type": "relative_packing_ratio", "value": "0.5156030654868752", "unit": ""},
   "characteristicSAV": {"type": "fuel_complex:ft2/ft3", "value": "1739.2294964144478"},
   "liveMoistureOfExt": {"type": "live_moisture_of_ext:%", "value": "372.7662233555347", "unit": "%"},
   "mineralDamping": {"type": "mineral_damping_coefficient", "value": "0.4173969279093913", "unit": ""},
   "moistureDamping": {"type": "moisture_damping_coefficient", "value": "0.3051252202538136", "unit": ""},
   "lowHeatContent": {"type": "heat_content:Btu/lb", "value": "8000.0"},
   "reactionVelocity": {"type": "reaction_velocity:1/min", "value": "14.155533132296872", "unit": ""},
   "reactionIntensity": {"type": "reaction_intensity:BTU/ft2/min", "value": "14422.600430267765"},
   "flameResidenceTime": {"type": "GENERIC_REAL", "value": "0.22078742385156463", "unit": "UniversalUnit"},
   "heatRelease": {"type": "GENERIC_REAL", "value": "3184.3287942392876", "unit": "UniversalUnit"},
   "propagatingFluxRatio": {"type": "GENERIC_REAL", "value": "0.03220906883716744", "unit": "UniversalUnit"},
   "heatSink": {"type": "GENERIC_REAL", "value": "61.16207627186109", "unit": "UniversalUnit"},
   "burnable": "true"
}

Surface Fire

Resource
Response
#!json

{
   "aspect":{"type":"aspect:deg","value":"0.0","unit":"deg"},
   "directionMaxSpread":{"type":"dir_of_spread:deg","value":"90.0","unit":"deg"},
   "effectiveWindSpeed":{"type":"wind_speed:mph","value":"9.438677451444649"},
   "firelineIntensity":{"type":"fire_line_intensity:Btu/ft/s","value":"17611.45862983202"},
   "flameLength":{"type":"flame_length:ft","value":"40.39041953091098","unit":"international foot"},
   "flameLengthBacking":{"type":"flame_length:ft","value":"5.754735269314471","unit":"international foot"},
   "flameLengthFlanking":{"type":"flame_length:ft","value":"6.94185398508367","unit":"international foot"},
   "fuelBed":{"fuelModel":{
           "modelNo":"4",
           "modelCode":"#4",
           "modelName":"Chaparral (6 feet)",
           "modelGroup":"Original 13",
           "dynamic":"false",
           "dead1HrFuelLoad":{"type":"fuel_load:kg/m2","value":"1.1230883661399034"},
           "dead10HrFuelLoad":{"type":"fuel_load:kg/m2","value":"0.8989190315810404"},
           "dead100HrFuelLoad":{"type":"fuel_load:kg/m2","value":"0.4483386691177259"},
           "liveHerbFuelLoad":{"type":"fuel_load:kg/m2","value":"0.0"},
           "liveWoodyFuelLoad":{"type":"fuel_load:kg/m2","value":"1.1230883661399034"},
           "dead1HrSAVRatio":{"type":"surface_to_volume:m2/m3","value":"6561.679790026247"},
           "dead10HrSAVRatio":{"type":"surface_to_volume:m2/m3","value":"357.6115485564305"},
           "dead100HrSAVRatio":{"type":"surface_to_volume:m2/m3","value":"98.4251968503937"},
           "liveHerbSAVRatio":{"type":"surface_to_volume:m2/m3","value":"0.0"},
           "liveWoodySAVRatio":{"type":"surface_to_volume:m2/m3","value":"4921.259842519685"},
           "fuelBedDepth":{"type":"fuel_depth:m","value":"1.8287999999999998","unit":"m"},
           "moistureOfExtinction":{"type":"moisture_of_extinction:%","value":"20.0","unit":"%"},
           "lowHeatContent":{"type":"heat_content:kJ/kg","value":"18608.0"},
           "burnable":"true"},
       "fuelMoisture":{
           "dead1HrFuelMoisture":{"type":"fuel_moisture_1h:%","value":"3.0","unit":"%"},
           "dead10HrFuelMoisture":{"type":"fuel_moisture_10h:%","value":"4.0","unit":"%"},
           "dead100HrFuelMoisture":{"type":"fuel_moisture_100h:%","value":"5.0","unit":"%"},
           "liveHerbFuelMoisture":{"type":"fuel_moisture_herb:%","value":"30.0","unit":"%"},
           "liveWoodyFuelMoisture":{"type":"fuel_moisture_woody:%","value":"60.0","unit":"%"}},
       "fuelTemperature":{"type":"GENERIC_REAL","value":"NaN","unit":"UniversalUnit"},
       "meanBulkDensity":{"type":"bulk_density:lb/ft3","value":"0.12266556382050901"},
       "fuelParticleDensity":{"type":"particle_density:lb/ft3","value":"32.0"},
       "meanPackingRatio":{"type":"mean_packing_ratio","value":"0.0038332988693909067","unit":""},
       "optimalPackingRatio":{"type":"optimal_packing_ratio","value":"0.007434592860248393","unit":""},
       "relativePackingRatio":{"type":"relative_packing_ratio","value":"0.5156030654868752","unit":""},
       "characteristicSAV":{"type":"fuel_complex:ft2/ft3","value":"1739.2294964144478"},
       "liveMoistureOfExt":{"type":"live_moisture_of_ext:%","value":"372.7662233555347","unit":"%"},
       "mineralDamping":{"type":"mineral_damping_coefficient","value":"0.4173969279093913","unit":""},
       "moistureDamping":{"type":"moisture_damping_coefficient","value":"0.3051252202538136","unit":""},
       "lowHeatContent":{"type":"heat_content:Btu/lb","value":"8000.0"},
       "reactionVelocity":{"type":"reaction_velocity:1/min","value":"14.155533132296872","unit":""},
       "reactionIntensity":{"type":"reaction_intensity:BTU/ft2/min","value":"14422.600430267765"},
       "flameResidenceTime":{"type":"GENERIC_REAL","value":"0.22078742385156463","unit":"UniversalUnit"},
       "heatRelease":{"type":"GENERIC_REAL","value":"3184.3287942392876","unit":"UniversalUnit"},
       "propagatingFluxRatio":{"type":"GENERIC_REAL","value":"0.03220906883716744","unit":"UniversalUnit"},
       "heatSink":{"type":"GENERIC_REAL","value":"61.16207627186109","unit":"UniversalUnit"},
       "burnable":"true"},
   "midFlameWindSpeed":{"type":"wind_speed:mph","value":"9.43867745144465"},
   "rateOfSpreadBacking":{"type":"rate_of_spread:ft/min","value":"7.694603402126751"},
   "rateOfSpreadFlanking":{"type":"rate_of_spread:ft/min","value":"15.040453368827198"},
   "rateOfSpreadMax":{"type":"rate_of_spread:ft/min","value":"331.83995311713915"},
   "rateOfSpreadNoWindNoSlope":{"type":"rate_of_spread:ft/min","value":"7.595205368840233"},
   "slope":{"type":"slope:deg","value":"0.0","unit":"deg"},
   "windDirection":{"type":"wind_dir:deg","value":"270.0","unit":"deg"}
}
Clone this wiki locally