swagger.json

{
  "swagger": "2.0",
  "info": {
    "version": "2.0.0",
    "title": "Fuel Reduction Cost Simulator Web Service",
    "contact": {
      "email": "kkyli@ucdavis.edu"
    },
    "license": {
      "name": "MIT license",
      "url": "https://github.com/ucdavis/fuel-reduction-cost-simulator/blob/master/LICENSE"
    }
  },
  "paths": {
    "/frcs": {
      "post": {
        "tags": ["FRCS"],
        "summary": "Get FRCS Outputs",
        "description": "| Limits | Ground-Based Mech WT | Ground-Based CTL | Ground-Based Manual WT | Ground-Based Manual Log | Cable Manual WT/Log | Cable Manual WT | Cable Manual Log | Cable CTL | Helicopter Manual Log | Helicopter CTL |\n|-|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|\n| TreeVol Maximum CT, ft3 | 80 | 80 | 80 | 80 | 80 | 80 | 80 | 80 | 80 | 80 |\n| TreeVol Maximum SLT, ft3 | 80 | 80 | 80 | 80 | 80 | 80 | 80 | 80 | 80 | 80 |\n| TreeVol Maximum LLT, ft3 | 250 |  | 250 | 250 | 250 | 250 | 250 |  | 250 |  |\n| Maximum slope, % | 40 | 40 | 40 | 40 | 100 | 100 | 100 | 40 | 100 | 40 |\n| Maximum Yarding Dist, ft |  |  |  |  | 1300 | 1300 | 1300 | 1300 | 10000 | 10000 |\n",
        "operationId": "getFrcsOutputs",
        "produces": ["application/json"],
        "parameters": [
          {
            "in": "body",
            "name": "params",
            "schema": {
              "$ref": "#/definitions/FrcsInputs"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/FrcsOutputs"
            }
          },
          "400": {
            "description": "Invalid parameters supplied"
          }
        }
      }
    }
  },
  "definitions": {
    "FrcsInputs": {
      "type": "object",
      "properties": {
        "system": {
          "type": "string",
          "example": "Ground-Based Mech WT",
          "description": "Selected from the ten harvesting systems including four ground-based systems, four cable-yarding systems, and two helicopter systems.",
          "enum": [
            "Ground-Based Mech WT",
            "Ground-Based Manual WT",
            "Ground-Based Manual Log",
            "Ground-Based CTL",
            "Cable Manual WT/Log",
            "Cable Manual WT",
            "Cable Manual Log",
            "Cable CTL",
            "Helicopter Manual Log",
            "Helicopter CTL"
          ]
        },
        "isPartialCut": {
          "type": "boolean",
          "example": false,
          "description": "Indicate the type of harvest: if true, partial-cut; otherwise clear-cut."
        },
        "deliverToLandingDistance": {
          "type": "number",
          "format": "float",
          "example": 553.905970179181,
          "description": "Distance that trees or logs are moved from the stump to be delivered to the landing. Subject to the selected harvesting system, trees or logs can be yarded, skidded, or forwarded to the landing."
        },
        "slope": {
          "type": "number",
          "format": "float",
          "example": 12.4204116232628,
          "description": "Average fall-line slope (%) of the harvest unit"
        },
        "elevation": {
          "type": "number",
          "format": "float",
          "example": 1586.29244594638,
          "description": "Elevation (ft) is required for helicopter systems."
        },
        "includeLoadingCosts": {
          "type": "boolean",
          "example": true,
          "description": "Indicate whether to include the costs of fuel loading."
        },
        "includeMoveInCosts": {
          "type": "boolean",
          "example": false,
          "description": "Indicate whether to include the costs of moving equipment to the harvest unit."
        },
        "area": {
          "type": "number",
          "format": "float",
          "example": 32.025456,
          "description": "Area (acres) of the harvest unit"
        },
        "moveInDistance": {
          "type": "number",
          "format": "float",
          "example": 0,
          "description": "One-way distance (miles) of moving harvesting equipment to the harvest unit"
        },
        "includeCostsCollectChipResidues": {
          "type": "boolean",
          "example": true,
          "description": "Indicate whether to include the costs of collecting and chipping residues."
        },
        "woodDensityCT": {
          "type": "number",
          "format": "float",
          "example": 81.08754477475162,
          "description": "Ratio (%) of chip tree green weight to green volume (pounds per cubic foot)"
        },
        "woodDensitySLT": {
          "type": "number",
          "format": "float",
          "example": 67.169795406641,
          "description": "Ratio (%) of small log tree green weight to green volume (pounds per cubic foot)"
        },
        "woodDensityLLT": {
          "type": "number",
          "format": "float",
          "example": 57.64241518721146,
          "description": "Ratio (%) of large log tree green weight to green volume (pounds per cubic foot)"
        },
        "residueFractionCT": {
          "type": "number",
          "format": "float",
          "example": 0.2695949034364167,
          "description": "Ratio of the green weight of chip tree tops and limbs to the green weight of the tree bole"
        },
        "residueFractionSLT": {
          "type": "number",
          "format": "float",
          "example": 0.2968554014193552,
          "description": "Ratio of the green weight of small log tree tops and limbs to the green weight of the tree bole"
        },
        "residueFractionLLT": {
          "type": "number",
          "format": "float",
          "example": 0.2635482997321487,
          "description": "Ratio of the green weight of large log tree tops and limbs to the green weight of the tree bole"
        },
        "hardwoodFractionCT": {
          "type": "number",
          "format": "float",
          "example": 0.2,
          "description": "Ratio of the green volume of hardwood to the total green volume of chip trees in the harvest unit"
        },
        "hardwoodFractionSLT": {
          "type": "number",
          "format": "float",
          "example": 0,
          "description": "Ratio of the green volume of hardwood to the total green volume of small log trees in the harvest unit"
        },
        "hardwoodFractionLLT": {
          "type": "number",
          "format": "float",
          "example": 0,
          "description": "Ratio of the green volume of hardwood to the total green volume of large log trees in the harvest unit"
        },
        "treesPerAcreCT": {
          "type": "number",
          "format": "float",
          "example": 77.4143957724794,
          "description": "Number of chip trees/acre"
        },
        "volumeCT": {
          "type": "number",
          "format": "float",
          "example": 2.05701405451453,
          "description": "Volume of chip trees (cf/tree)"
        },
        "treesPerAcreSLT": {
          "type": "number",
          "format": "float",
          "example": 19.6966665842466,
          "description": "Number of small log trees/acre"
        },
        "volumeSLT": {
          "type": "number",
          "format": "float",
          "example": 23.6023369439501,
          "description": "Volume of small log trees (cf/tree)"
        },
        "treesPerAcreLLT": {
          "type": "number",
          "format": "float",
          "example": 2.69861110290771,
          "description": "Number of large log trees/acre"
        },
        "volumeLLT": {
          "type": "number",
          "format": "float",
          "example": 137.702754194984,
          "description": "Volume of large log trees (cf/tree)"
        },
        "dieselFuelPrice": {
          "type": "number",
          "format": "float",
          "example": 2.24,
          "description": "Current wholesale price ($/gallon) of low-sulfur diesel fuel in the California"
        },
        "moistureContent": {
          "type": "number",
          "format": "float",
          "example": 50,
          "description": "Moisture content of biomass on a wet basis (% w.b.)"
        },
        "isBiomassSalvage": {
          "type": "boolean",
          "example": false,
          "description": "Indicate whether all trees will be utilized as feedstock for the conversion facility."
        },
        "wageFaller": {
          "type": "number",
          "format": "float",
          "example": 35.13,
          "description": "Hourly wage of faller/bucker ($/h)"
        },
        "wageOther": {
          "type": "number",
          "format": "float",
          "example": 22.07,
          "description": "Hourly wage of other workers ($/h)"
        },
        "laborBenefits": {
          "type": "number",
          "format": "float",
          "example": 35,
          "description": "Ratio (%) of benefits and overhead to wages"
        },
        "ppiCurrent": {
          "type": "number",
          "format": "float",
          "example": 284.7,
          "description": "Latest published value of the U.S. producer price index (PPI)"
        },
        "residueRecovFracWT": {
          "type": "number",
          "format": "float",
          "example": 80,
          "description": "Green weight fraction (%) of residues recovered in WT systems"
        },
        "residueRecovFracCTL": {
          "type": "number",
          "format": "float",
          "example": 50,
          "description": "Green weight fraction (%) of residues recovered in CTL systems"
        }
      },
      "required": [
        "system",
        "isPartialCut",
        "deliverToLandingDistance",
        "slope",
        "elevation",
        "includeLoadingCosts",
        "includeMoveInCosts",
        "area",
        "moveInDistance",
        "includeCostsCollectChipResidues",
        "woodDensityCT",
        "woodDensitySLT",
        "woodDensityLLT",
        "residueFractionCT",
        "residueFractionSLT",
        "residueFractionLLT",
        "hardwoodFractionCT",
        "hardwoodFractionSLT",
        "hardwoodFractionLLT",
        "treesPerAcreCT",
        "volumeCT",
        "treesPerAcreSLT",
        "volumeSLT",
        "treesPerAcreLLT",
        "volumeLLT",
        "dieselFuelPrice",
        "moistureContent",
        "isBiomassSalvage",
        "wageFaller",
        "wageOther",
        "laborBenefits",
        "ppiCurrent",
        "residueRecovFracWT",
        "residueRecovFracCTL"
      ],
      "xml": {
        "name": "FrcsInputs"
      }
    },
    "FrcsOutputs": {
      "type": "object",
      "properties": {
        "totalBiomass": {
          "$ref": "#/definitions/TotalBiomass"
        },
        "feedstock": {
          "$ref": "#/definitions/Feedstock"
        }
      },
      "xml": {
        "name": "FrcsOutputs"
      }
    },
    "TotalBiomass": {
      "type": "object",
      "properties": {
        "yieldPerAcre": {
          "type": "number",
          "format": "float",
          "example": 37.87998060825467,
          "description": "Total yield (GT/acre)"
        },
        "costPerAcre": {
          "type": "number",
          "format": "float",
          "example": 627.3814992388325,
          "description": "Total harvest cost ($/acre)"
        },
        "costPerBoleCCF": {
          "type": "number",
          "format": "float",
          "example": 63.00680825182345,
          "description": "Total harvest cost ($/CCF)"
        },
        "costPerGT": {
          "type": "number",
          "format": "float",
          "example": 16.562350063667026,
          "description": "Total harvest cost ($/GT)"
        },
        "dieselPerAcre": {
          "type": "number",
          "format": "float",
          "example": 12.648562901817883,
          "description": "Total diesel consumption (gal/acre)"
        },
        "dieselPerBoleCCF": {
          "type": "number",
          "format": "float",
          "example": 1.2702726783988008,
          "description": "Total diesel consumption (gal/CCF)"
        },
        "gasolinePerAcre": {
          "type": "number",
          "format": "float",
          "example": 0.2890999584945396,
          "description": "Total gasoline consumption (gal/acre)"
        },
        "gasolinePerBoleCCF": {
          "type": "number",
          "format": "float",
          "example": 0.02903379470477717,
          "description": "Total gasoline consumption (gal/CCF)"
        },
        "jetFuelPerAcre": {
          "type": "number",
          "format": "float",
          "example": 0,
          "description": "Total jet fuel consumption (gal/acre)"
        },
        "jetFuelPerBoleCCF": {
          "type": "number",
          "format": "float",
          "example": 0,
          "description": "Total jet fuel consumption (gal/CCF)"
        }
      },
      "xml": {
        "name": "TotalBiomass"
      }
    },
    "Feedstock": {
      "type": "object",
      "properties": {
        "yieldPerAcre": {
          "type": "number",
          "format": "float",
          "example": 11.556647235892862,
          "description": "Feedstock yield (GT/acre)"
        },
        "costPerAcre": {
          "type": "number",
          "format": "float",
          "example": 153.26147167945427,
          "description": "Feedstock harvest cost ($/acre)"
        },
        "costPerBoleCCF": {
          "type": "number",
          "format": "float",
          "example": 15.391777045091967,
          "description": "Feedstock harvest cost ($/CCF)"
        },
        "costPerGT": {
          "type": "number",
          "format": "float",
          "example": 4.04597545242819,
          "description": "Feedstock harvest cost ($/GT)"
        },
        "dieselPerAcre": {
          "type": "number",
          "format": "float",
          "example": 4.409948082301028,
          "description": "Diesel consumption associated with feedstock harvest (gal/acre)"
        },
        "dieselPerBoleCCF": {
          "type": "number",
          "format": "float",
          "example": 0.44288324338404267,
          "description": "Diesel consumption associated with feedstock harvest (gal/CCF)"
        },
        "gasolinePerAcre": {
          "type": "number",
          "format": "float",
          "example": 0,
          "description": "Gasoline consumption associated with feedstock harvest (gal/acre)"
        },
        "gasolinePerBoleCCF": {
          "type": "number",
          "format": "float",
          "example": 0,
          "description": "Gasoline consumption associated with feedstock harvest (gal/CCF)"
        },
        "jetFuelPerAcre": {
          "type": "number",
          "format": "float",
          "example": 0,
          "description": "Jet fuel consumption associated with feedstock harvest (gal/acre)"
        },
        "jetFuelPerBoleCCF": {
          "type": "number",
          "format": "float",
          "example": 0,
          "description": "Jet fuel consumption associated with feedstock harvest (gal/CCF)"
        }
      },
      "xml": {
        "name": "Feedstock"
      }
    }
  },
  "externalDocs": {
    "description": "Source code",
    "url": "https://github.com/ucdavis/fuel-reduction-cost-simulator"
  }
}