{ "openapi": "3.0.1", "info": { "title": "SSURGO Soil V2 (Trial)", "description": "", "version": "1.0" }, "servers": [ { "url": "https://ag-analytics.azure-api.net/ssurgo-v2-clone" } ], "paths": { "/get": { "get": { "summary": "GET SSURGO", "description": "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Parameter | \nDescription | \nExample | \nRequest | \n
---|---|---|---|
filename | \nFile name to download. From POST request. | \nresult_ssurgo_raster_proj_ 4326_res_0.0001_202007091 92551017948.tif | \n https://ag-analytics.azure-api.net/ssurgo-v2? filename=result_ssurgo_raster_proj_ 4326_ res_0.0001_20200709192551017948.tif | \n
Parameter | \nData Type | \nRequired? | \nDefault | \nOptions | \nDescription | \n
---|---|---|---|---|---|
AOI | \nString | \nYes (otherwise pass file) | \n -- | \nGeojson or esriGeometryType | \n If no spatial specification was provided, the result raster will use the Ag-Analytics default spatial reference: WGS 84, resolution at 0.0001 degree | \n
File | \nGeoTIFF or ShapeFile in a zip | \n Yes (otherwise pass AOI) | \n - | \n- | \nA GeoTiff (.TIFF,.Tif, .etc) or a Shapefile in Zip (must include shp, shx, dbf, but others files such as .prj, .xml, .cpg are recommended for better processing) | \n
Projection | \nString | \nNo | \n\"EPSG:4326\" | \nex:\"EPSG:4326\" | \nOutput projection of result GeoTIFF. | \n
Resolution | \nString | \nNo | \n\"nccpi2all\" | \nFull NRCS List | \nThe soil metric to return, see the NRCS variables PDF for full list with descriptions | \n
AOI Type | \nProjection Specified? | \n Resolution Specified? | \n Ouput Projection | \nOutput Resolution | \n
---|---|---|---|---|
Any | \nYes | \nYes | \nRequest projection | \nRequest resolution | \n
GeoTIFF | \nYes | \nNo | \nRequest projection | \nGeoTIFF resolution | \n
GeoTIFF | \nNo | \nYes | \nGeoTIFF projection | \nRequest resolution | \n
GeoTIFF | \nNo | \nNo | \nGeoTIFF projection | \nGeoTIFF resolution | \n
Shapefile | \nYes | \nNo | \nRequest projection | \nDefault resolution | \n
Shapefile | \nNo | \nYes | \nShapefile projection | \nRequest resolution | \n
Shapefile | \nNo | \nNo | \nShapefile projection | \nDefault resolution | \n
GeoJSON | \nYes | \nNo | \nRequest projection | \nDefault resolution | \n
GeoJSON | \nNo | \nYes | \nGeoJSON projection | \nRequest resolution | \n
GeoJSON | \nNo | \nNo | \nGeoJSON projection | \nDefault resolution | \n
Parameter | \nType | \nDescription | \n
---|---|---|
CellSize | \nList | \nCell size/ Resolution of result raster | \n
CoordinateSystem | \nString | \nCoordinate System of result raster | \n
Extent | \nString | \nCorner coordinates of result raster | \n
Soil_Parameter | \nString | \nSoil metric/parameter | \n
Weighted_Average | \nFloat | \nWeighted average soil matrix value | \n
pngb64 | \nString | \nBase 64 png string. | \n
Legend | \nList | \nLegend gives the following details for each range of values: 1. color: Hex color used for the crop type 2. Area: area of the Soil Type (see Soil_Type) covered in percentage 3. Count: Number of pixels from the result raster of a certain Soil_Type 4. CountAllPixels: Total number of pixels in the result raster 5. Soil_Type: Soil type in String 6. Value: Soil type in index, mukey value 7. Soil_Value: Value of requested soil matrix on current soil type | \n
Parameter | \nType | \nDescription | \n
---|---|---|
GeoJSON | \nGeoJSON | \n Return the results as a FeatureCollection. The properties are also attached to each GeoJSON object. | \n
Soil_Parameter | \nString | \n Request soil matrix/parameter | \n
Weighted_Average | \nFloat | \n Weighted average soil matrix/parameter by area | \n
Properties.SoilType | \nString | \n Soil type name in string | \n
Properties.area | \nFloat | \n Area in acreage of current soil type | \n
Properties.mukey | \nInteger | \n Soil type key as integer | \n
Properties.Request SoilParameter | \n Float | \n RequestSoilParameter will be based on the parameter in request. This parameter gives back the soil matrix/parameter value of current soil type. ex: Properties.nccpi2all | \n