Other endpoints

A district's burn status, its permit catalog, and current conditions.

GET

https://api.stationworks.app

/v1/permits/agencies/{id}/status

A district's burn status, its permit catalog, and current conditions. › path Parameters

id

string · uuid · required

A district's burn status, its permit catalog, and current conditions. › Responses

AgencyStatus

Agency · required

Verdict · required

The board's "Can I have a fire today?" answer.

required

Null when the district has no current season window.

fireDanger

string | null · enum · required

New values may be added; treat an unknown value as unknown. Null when no fire-danger level is set.

Enum values:

low

moderate

high

very_high

extreme

Status[] · required

Permit[] · required

required

Current air quality near the district, from AirNow. Null when AirNow has no usable reading, or is unreachable.

required

Current wind, weather, and fire alerts near the district, from the National Weather Service. Null when NWS has no usable reading.

generatedAt

string · date-time · required

When this response was built, not when a state last changed.

GET/v1/permits/agencies/{id}/status

curl 'https://api.stationworks.app/v1/permits/agencies/:id/status?key=<api-key>'

Example Responses

{
  "agency": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name",
    "url": "https://www.example.com/path/to/resource"
  },
  "verdict": {
    "value": "open",
    "label": "label"
  },
  "season": {
    "start": "2024-08-25",
    "end": "2024-08-25"
  },
  "fireDanger": "low",
  "statuses": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "label": "label",
      "state": "open",
      "kind": "permit",
      "heading": "heading",
      "description": "description",
      "stateReason": "stateReason",
      "rulesMarkdown": "rulesMarkdown",
      "source": {
        "url": "https://www.example.com/path/to/resource",
        "says": "says",
        "staleSince": "2024-08-25T15:00:00Z"
      },
      "linkUrl": "https://www.example.com/path/to/resource",
      "permitId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "permits": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "name",
      "description": "description",
      "rulesMarkdown": "rulesMarkdown",
      "price": {
        "amountCents": 0,
        "currency": "currency"
      },
      "validity": {
        "kind": "season",
        "start": "2024-08-25",
        "end": "2024-08-25",
        "maxDays": 0
      },
      "requiresApproval": true,
      "onSale": true,
      "offSaleNote": "offSaleNote",
      "statusId": "00000000-0000-0000-0000-000000000000",
      "buyUrl": "https://www.example.com/path/to/resource"
    }
  ],
  "airQuality": {
    "station": "station",
    "pm25Aqi": 0,
    "category": "category",
    "categoryNumber": 0,
    "observedAt": "2024-08-25T15:00:00Z",
    "linkUrl": "https://www.example.com/path/to/resource",
    "ozoneAqi": 0,
    "pm10Aqi": 0
  },
  "fireWeather": {
    "windMph": 0,
    "windGustMph": 0,
    "windDirectionDeg": 0,
    "windDirectionCardinal": "windDirectionCardinal",
    "tempF": 0,
    "dewpointF": 0,
    "relativeHumidityPct": 0,
    "twentyFootWindMph": 0,
    "twentyFootWindDirectionDeg": 0,
    "twentyFootWindDirectionCardinal": "twentyFootWindDirectionCardinal",
    "mixingHeightFt": 0,
    "transportWindMph": 0,
    "sunrise": "2024-08-25T15:00:00Z",
    "sunset": "2024-08-25T15:00:00Z",
    "redFlagWarning": {
      "headline": "headline",
      "expires": "2024-08-25T15:00:00Z"
    },
    "advisories": [
      {
        "event": "event",
        "headline": "headline",
        "expires": "2024-08-25T15:00:00Z"
      }
    ]
  },
  "generatedAt": "2024-08-25T15:00:00Z"
}

json

application/json