Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The request process typically works in the following manner:

...

Status

Response

200

Example responses will be shown below-

{
    "projectName": "Some project name",
    "projectId": "est_ocp_test4",
    "status": "Active",
    "projectCategory": "Whole building",
    "constructionTypeName": "New construction",
    "officeLocation": "Colonia Office",
    "country": "UY",
    "state": "Colonia",
    "city": "Colonia del Sacramento",
    "zipcode": "70000",
    "climateZone": null,
    "designEnergyCode": "ASHRAE 90.1-2001",
    "baselineEUI": 99.8,
    "estimatedOccupancyYear": 2025,
    "energyTarget": 20.2energyTarget": 20.2,
    "renewables": null,
    "useType1": "Parking",
    "renewablesuseType1Area": null1000,

    "

useType1

updatedAt": "

Parking

2022-01-24T19:37:47.000Z",
    "createdAt"

useType1Area

: "

: 1000

2021-01-12T19:51:01.000Z",

   "design_phases": [
    {
       "reportingYear": 2020,
       "projectPhase": "Concept",
       "energyModelingTool": null,
       "predictedEUI": 51.896,
       "lightingPowerDensity": 23.15,
       "windowToWallRatio": 40,
       "electricityProducedOffSite": null,
       "naturalGasCombustedOnSite": null,
       "districtSteam": null,
       "diesel": null,
       "electricityFromRenewablesOnSite": null,
       "occupancySensorsIncluded": "NO",
       "daylightingSensorsIncluded": "NO",
       "chillerType": null
    }
   ]
}

400

{"error": {message: "Invalid Value or Mandatory values are missing."} }

Note: List of all error messages provided in appendix below

401

{"message": "Invalid Auth Token."}

401

{"message": "Auth Token Expired."}

404{"message": "Project not found."}

500

{"error":"Something went wrong. Please try again later."}

...

Status

Response

200

Example responses will be shown below-

[{
    "projectName": "Some project name",
    "projectId": "est_ocp_test4",
    "status": "Active",
    "projectCategory": "Whole building",
    "constructionTypeName": "New construction",
    "officeLocation": "Colonia Office",
    "country": "UY",
    "state": "Colonia",
    "city": "Colonia del Sacramento",
    "zipcode": "70000",
    "climateZone": null,
    "designEnergyCode": "ASHRAE 90.1-2001",
    "baselineEUI": 99.8,
    "estimatedOccupancyYear": 2025,
    "energyTarget": 20.2,
    "renewables": null,
    "useType1": "Parking",
    "useType1Area": 1000,

   "updatedAt": "2022-01-24T19:37:47.000Z",
   "createdAt": "2021-01-12T19:51:01.000Z",
   "design_phases": [
    {
       "reportingYear": 2020,
       "projectPhase": "Concept",
       "energyModelingTool": null,
       "predictedEUI": 51.896,
       "lightingPowerDensity": 23.15,
       "windowToWallRatio": 40,
       "electricityProducedOffSite": null,
       "naturalGasCombustedOnSite": null,
       "districtSteam": null,
       "diesel": null,
       "electricityFromRenewablesOnSite": null,
       "occupancySensorsIncluded": "NO",
       "daylightingSensorsIncluded": "NO",
       "chillerType": null
    }
   ]
}, ...]

400

{"error": {message: "Invalid Value or Mandatory values are missing."} }

Note: List of all error messages provided in appendix below

401

{"message": "Invalid Auth Token."}

401

{"message": "Auth Token Expired."}

404{"message": "Project not found."}

500

{"error":"Something went wrong. Please try again later."}

...