api.json•5.39 kB
{
"swagger": "2.0",
"info": {
"title": "EIM Weather Proximity API",
"description": "<html><head></head><body lang=EN-US link=\"#0563C1\" vlink=\"#954F72\"><p>The weather proximity service makes use of the CIWS-VIL product. VIL stands for Vertically Integrated Liquid Water and is used to determine intensity of precipitation as a column from the ground up. For each point, a bounding box is created with a configured offset and the largest VIL value is taken within that bounding box. These values are then converted to a human readable form.</p><p>Values within the VIL files are given in kg/m^2 units and are normalized to be made understandable. The table below shows these values as well as miscellaneous values used by the proximity service:</p><table><tbody><tr><td><strong>Normalized Value</strong></td><td><strong>Meaning</strong></td></tr><tr><td>-1</td><td><p>Clear skies</p></td></tr><tr><td>0</td><td><p>Very Light precipitation</p></td></tr><tr><td>1</td><td><p>Light precipitation</p></td></tr><tr><td>2</td><td><p>Light to moderate rain</p></td></tr><tr><td>3</td><td><p>Moderate to heavy rain</p></td></tr><tr><td>4</td><td><p>Heavy rain</p></td></tr><tr><td>5</td><td><p>Very heavy rain; hail possible</p></td></tr><tr><td>6</td><td><p>Very heavy rain and hail; large hail possible</p></td></tr><tr><td><strong>Code Value</strong></td><td><strong>Meaning</strong></td></tr><tr><td>-99</td><td><p>No VIL value found</p></td></tr><tr><td>-97</td><td><p>No weather data available</p></td></tr></tbody></table><p>The Weather Proximity API allows a user to query EIM with a series of points and times to get precipitation intensities corresponding to those points.</p></body></html>",
"version": "1.0"
},
"host": "{domain}",
"basePath": "/eim/services",
"schemes": [
"https"
],
"x-amf-baseUriParameters": {
"domain": {
"displayName": "Domain Name (by environment)",
"default": "external-api.faa.gov",
"enum": [
"internal-api-dev.faa.gov",
"api-stage.faa.gov",
"external-api.faa.gov"
],
"type": "string"
}
},
"paths": {
"/proximityList": {
"post": {
"description": "The Weather Proximity API allows a user to query EIM with a series of points and times to get precipitation intensities corresponding to those points.",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"name": "lat",
"description": "latitude of point",
"required": true,
"in": "query",
"type": "number"
},
{
"name": "lon",
"description": "longitude of point",
"required": true,
"in": "query",
"type": "number"
},
{
"name": "timeStr",
"description": "timestring of point. Standard ISO 8601 UTC string – yyyyMMddTHHmmss where yyyy – year, MM – month, dd – day of month, T – time string follows, HH – hour in 24 hour time, mm – minute, ss – second",
"required": true,
"in": "query",
"type": "string"
},
{
"name": "prodId",
"description": "product used to determine proximity intensity",
"required": true,
"in": "query",
"type": "string"
},
{
"name": "client_id",
"required": true,
"in": "header",
"type": "string"
},
{
"name": "client_secret",
"required": true,
"in": "header",
"type": "string"
},
{
"x-amf-mediaType": "application/json",
"in": "body",
"name": "generated",
"schema": {
"example": [
{
"lat": 39.450187683,
"lon": -74.56523895,
"timeStr": "20191020T133129",
"prodId": "VIL"
},
{
"lat": 39.450187683,
"lon": -74.56523895,
"timeStr": "20191020T133129",
"prodId": "VIL"
},
{
"lat": 39.450187683,
"lon": -74.56523895,
"timeStr": "20191020T133129",
"prodId": "VIL"
},
{
"lat": 39.450187683,
"lon": -74.56523895,
"timeStr": "20191020T133129",
"prodId": "VIL"
},
{
"lat": 39.450187683,
"lon": -74.56523895,
"timeStr": "20191020T133129",
"prodId": "VIL"
}
]
}
}
],
"responses": {
"200": {
"description": "",
"x-amf-mediaType": "application/json",
"schema": {
"example": [
-97,
-97,
-97,
-97,
-97,
-97,
-97,
-97
]
}
}
}
}
}
}
}