State/Regional Report
GetPdfByState
Description:
This process generates a state- or region-level report in PDF format based on the provided FIPS code and data layer.
Note: This process is supported only for selected states and regions.
Inputs:
| Parameter | Type | Default Value | Description |
|---|---|---|---|
| layer | string | N/A | Name of the data layer (currently supports 9km/1km SMAP and SMAP anomaly products, e.g., SMAP-9KM-DAILY-TOP_2020.01.01_AVERAGE, SMAP-9KM-ANOMALY-DAILY-SUB_2021.01.01) |
| fips | string | N/A | State or regional FIPS code (e.g., 06 for the State of California, 011 for the Southern Region) |
| title | string | N/A | Title displayed at the top of the report |
| boundary | json | {"region":1,"state":1,"asd":1,"county":1} | Options for displaying administrative boundaries ("1" = on, "0" = off) |
| label | bool | true | Whether to display county labels on the map (true or false) |
Outputs:
| Parameter | Type | Default Value | Description |
|---|---|---|---|
| pdfUrl | url | N/A | URL to download the full report in PDF format |
| pdfImage | url | N/A | URL to a rendered image (PNG) of the report |
| imageUrl | url | N/A | URL to the map image only (excluding title, description, etc.) |
Example Request
Requesting a report for the SMAP 9KM Topsoil data layer for California (FIPS: 06):
Requesting a report for the SMAP 9KM Anomaly data layer for the Southern Region (FIPS: 011):