Inspection Sync Examples

Modified on Thu, 3 Feb, 2022 at 4:55 PM

Example JSON Import Files

Example 1: A minimal example making an update to just one field

[
  {
    "projectId": "proj1111",
    "ratingDate": "2020-09-05"
  }
]

Some things to note from this example:

All fields are optional except for "projectId".
The singleton project object is still required to be inside of array brackets.

Example 2: A single JSON file with field data for multiple projects

[
  {
    "projectId": "Proj1111",
    "nBedrooms": "5",
    "hasEvReadySpace": true,
    "orientation": "Southwest",
    "wallColor": "REFLECTIVE",
    "roofColor": "LIGHT",
    "constructionYear": "2013",
    "floorsOnOrAboveGrade": "3"
  },
  {
    "projectId": "Proj2222",
    "constructionYear": "2021",
    "raterOfRecordRTIN": "0001234",
    "orientation": "North"
  }
]

Some things to note from this example:

One file can contain field data for multiple projects.
The second project object is not followed by a comma, as this would break JSON syntax.
The objects for the different projects need not have all the same fields. They are totally independent.
Numeric values can be double-quoted strings.
Two objects in one file cannot have the same "projectId" values.

Example 3: A hypothetical real use

[
  {
    "projectId": "proj3333",
    "constructionYear": 2021,
    "hasEvReadySpace": true,
    "hasGarage": true,
    "orientation": "East",
    "wallColor": "DARK",
    "roofColor": "MEDIUM",
    "aboveGradeWalls": [
      {
        "index": 0,
        "cavityInsulationGrade": "II",
        "cavityInsulationR": 12,
        "continuousInsulationR": 3
      },
      {
        "index": 1,
        "cavityInsulationGrade": "I",
        "cavityInsulationR": 16,
        "continuousInsulationR": 5
      }
    ],
    "ceilingsAndRoofs": [
      {
        "index": 0,
        "cavityInsulationGrade": "II"
      }
    ],
    "windows": [
      {
        "index": 0,
        "remove": true
      },
      {
        "index": 1,
        "windowArea": 325.5
      }
    ],
    "mechanicalEquipments": [
      {
        "index": 0,
        "modelNumber": "MDLNBR-12345678",
        "percentHeatingLoad": 100,
        "perentCoolingLoad": 20
      },
      {
        "index": 1,
        "modelNumber": "MDLNBR-23456789",
        "percentCoolingLoad": 80,
        "location": "AMBIENT"
      },
      {
        "index": 2,
        "modelNumber": "MDLNBR-23456789",
        "percentHotWaterLoad": 100,
        "location": "AMBIENT"
      }
    ],
    "hasCeilingFan": true,
    "ceilingFanCfmPerWatt": 70.123,
    "infiltrationUnit": "ACH_NATURAL",
    "infiltrationValue": 3.2,
    "lighting": {
      "percentInteriorFluorescent": 25,
      "percentInteriorLED": 75
    },
    "mandatoryItems": {
      "iecc2012MandatoryChecklist": true
    }
  }
]

Some things to note from this example:

Fields are designed to be pick-and-choose to fit a variety of needs.
Numeric values can be plain numbers and floating point fields do not require a decimal point.
true/false values can be plain (not surrounded by quotation marks).

Example 4: An example using all available fields

[
  {
    "projectId": "proj4444",
    "ratingDate": "2021-08-17",
    "constructionYear": 2021,
    "raterOfRecord": "0000001",
    "otherRaterRxIN": [
      "1234567",
      "abc123"
    ],
    "floorsOnOrAboveGrade": 3,
    "nBedrooms": 3,
    "conditionedFloorArea": 1500,
    "infiltrationVolume": 14000,
    "hasEvReadySpace": "true",
    "hasGarage": "true",
    "orientation": "West",
    "wallColor": "MEDIUM",
    "roofColor": "LIGHT",
    "foundationWalls": [
      {
        "index": 0,
        "cavityInsulationGrade": "II",
        "cavityInsulationR": 20.5,
        "continuousInsulationR": 3.2,
        "studDepth": 4.5,
        "studWidth": 1.5,
        "studSpacing": 12.5,
        "studMaterial": "CONCRETE"
      },
      {
        "index": 1,
        "continuousInsulationGrade": "I"
      }
    ],
    "aboveGradeWalls": [
      {
        "index": 0,
        "cavityInsulationGrade": "II",
        "cavityInsulationR": 20.5,
        "continuousInsulationR": 3.2,
        "studDepth": 4.5,
        "studWidth": 1.5,
        "studSpacing": 12.5,
        "studMaterial": "WOOD"
      },
      {
        "index": 1,
        "cavityInsulationGrade": "I"
      }
    ],
    "framedFloors": [
      {
        "index": 0,
        "cavityInsulationGrade": "II",
        "cavityInsulationR": 20.5,
        "continuousInsulationR": 3.2,
        "studDepth": 4.5,
        "studWidth": 1.5,
        "studSpacing": 12.5,
        "studMaterial": "STEEL"
      },
      {
        "index": 1,
        "cavityInsulationGrade": "III"
      }
    ],
    "ceilingsAndRoofs": [
      {
        "index": 0,
        "cavityInsulationGrade": "II",
        "continuousInsulationR": 3.2,
        "studDepth": 4.5,
        "studWidth": 1.5,
        "studSpacing": 12.5,
        "studMaterial": "WOOD",
        "cavityInsulationR": 20.5
      },
      {
        "index": 1,
        "cavityInsulationGrade": "II"
      }
    ],
    "windows": [
      {
        "index": 0,
        "remove": "true"
      },
      {
        "index": 1,
        "windowArea": 325.5
      }
    ],
    "mechanicalEquipments": [
      {
        "index": 0,
        "modelNumber": "MDLNBR-12345678",
        "secondModelNumber": "MDL-2-1234",
        "thirdModelNumber": "M-3-ABCD",
        "percentHeatingLoad": 100,
        "perentCoolingLoad": 25
      },
      {
        "index": 1,
        "modelNumber": "MDN-1A1A1A",
        "secondModelNumber": "MDL-2-2-2",
        "perentCoolingLoad": 75,
        "location": "UNCONDITIONED_ATTIC"
      },
      {
        "index": 2,
        "modelNumber": "MDLNBR-23456789",
        "percentHotWaterLoad": 75,
        "location": "AMBIENT"
      }
    ],
    "distributionSystems": [
      {
        "index": 0,
        "leakageToOutside": 4.5,
        "totalLeakage": 6.5,
        "leakageUnit": "CFM25"
      }
    ],
    "mechanicalVentilations": [
      {
        "index": 0,
        "ventilationType": "AIR_CYCLER",
        "measuredFlowRate": 50.5,
        "fanWatts": 35.5,
        "operationalHoursPerDay": 8.5
      }
    ],
    "hasNaturalVentilation": "true",
    "hasCeilingFan": "true",
    "ceilingFanCfmPerWatt": 70.123,
    "infiltrationUnit": "ACH_NATURAL",
    "infiltrationValue": 3.2,
    "lighting": {
      "percentInteriorFluorescent": 25,
      "percentInteriorLED": 75,
      "percentExteriorFluorescent": 50,
      "percentExteriorLED": 50,
      "percentGarageFluorescent": 0,
      "percentGarageLED": 37.5
    },
    "water": {
      "waterFixtureType": "STANDARD",
      "hotWaterPipeLength": 89.7,
      "atLeastR3PipeInsulation": "true",
      "hasRecirculationSystem": "true",
      "branchLength": 30,
      "pipeLoopLength": 40.5,
      "recirculationSystemControl": "TEMPERATURE",
      "pumpPower": 50,
      "isShared": "false"
    },
    "mandatoryItems": {
      "iecc2012MandatoryChecklist": "true",
      "iecc2015MandatoryChecklist": "true",
      "iecc2018MandatoryChecklist": "true",
      "energyStarRaterDesignReviewChecklist": "true",
      "energyStarHvacDesignReport": "false",
      "energyStarHvacCommissioningChecklist": "true",
      "energyStarWaterManagementSystemBuilderRequirements": "false"
    }
  }
]

Some things to note from this example:

Not all repeatable sections must have multiple entries.
true/false values can be double-quoted strings.
For an explanation of how mechanical equipment model number fields are used, see this article.

Attachments (4)

json

Example 1 - ....json
76 Bytes

json

Example 2 - ....json
395 Bytes

json

Example 4 - ....json
4.17 KB

json

Example 3 - ....json
1.58 KB