Versions Compared

Key

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

The request process typically works in the following manner:

  1. Authenticate the initiating process/user
  2. Send project parameter values to DDX
  3. Response sent to the user with the project's information, including its design data

Methods

Get a project's information

Returns a project's basic information and lists its design phases using the information passed on through the parameters.

...

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."}

API Testing & Calls

Sample API Request For User Authentication-

...

https://stg-2030ddx.aia.org/api/v1/project_detail


Production API URL for Authentication

https://2030ddx.aia.org​​​​​​​/api/v1/authenticate

Production API URL for GET Project

https://2030ddx.aia.org/api/v1/project_detail


Fetching all firms' projects

Returns all projects' basic information and lists its design phases using the information passed on through the parameters.

...

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."}

API Testing & Calls

Sample API Request For User Authentication-

...

https://stg-2030ddx.aia.org/api/v1/projects


Production API URL for Authentication

https://2030ddx.aia.org​​​​​​​/api/v1/authenticate

Production API URL for GET Project

https://2030ddx.aia.org/api/v1/projects

Status Codes

All status codes are standard HTTP status codes. The below ones are used in this API.

...