POST api/CommodityApi/GetCustomerHomeDetails

Request Information

URI Parameters

None.

Body Parameters

ApiParamOfCustomerHomeDetailsCriteriaAndObject

Name	Type	Additional information
AuthKey	AuthenticationKey	Required
Criteria	CustomerHomeDetailsCriteria	Required
Data	Object	Required

Request Formats

application/json, text/json

Sample:

{
  "AuthKey": {
    "WebServiceKey": "sample string 1",
    "CompanyID": 1,
    "AppSource": "sample string 2",
    "AppSourceTeam": "sample string 3"
  },
  "Criteria": {
    "CompanyID": 1,
    "RefID": "sample string 1",
    "CustomerID": "sample string 2",
    "UserID": "sample string 3"
  },
  "Data": {}
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiOutputCommonOfListOfCustomerHomeDetails

Name	Type	Additional information
ResponseCode	string	None.
ResponseMessage	string	None.
Data	Collection of CustomerHomeDetails	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2",
  "Data": [
    {
      "PremiseID": "sample string 1",
      "UserID": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "EmaiID": "sample string 5",
      "FamilyHeadCount": 1,
      "IsExistingElectricCustomer": true,
      "IsExistingGasCustomer": true,
      "ElectricPremiseID": "sample string 6",
      "ElectricityRate": 1.0,
      "ElectricInvoiceAmount": 1.0,
      "ElectricInvoiceUsage": 1.0,
      "ElectricUtilityCharges": 1.0,
      "ElectricUtilityName": "sample string 7",
      "ElectricUtilityLabel": [
        {
          "UtilName": "sample string 1",
          "UtilCode": "sample string 2",
          "AccountMaskComment": "sample string 3",
          "CommodityTypeIdentifier": "sample string 4",
          "AccountLabel": "sample string 5",
          "FriendlyName": "sample string 6",
          "IsActive": "sample string 7",
          "JurisdictionShortIdentifier": "sample string 8",
          "MarketParticipantIdentifier": "sample string 9",
          "MarketParticipantShortIdentifier": "sample string 10",
          "AccountValidationRegularExpression": "sample string 11",
          "AccountMaskpublic": "sample string 12"
        },
        {
          "UtilName": "sample string 1",
          "UtilCode": "sample string 2",
          "AccountMaskComment": "sample string 3",
          "CommodityTypeIdentifier": "sample string 4",
          "AccountLabel": "sample string 5",
          "FriendlyName": "sample string 6",
          "IsActive": "sample string 7",
          "JurisdictionShortIdentifier": "sample string 8",
          "MarketParticipantIdentifier": "sample string 9",
          "MarketParticipantShortIdentifier": "sample string 10",
          "AccountValidationRegularExpression": "sample string 11",
          "AccountMaskpublic": "sample string 12"
        }
      ],
      "ElectricInvoiceDate": "2025-05-02T11:15:38.0754543-04:00",
      "GasCustomerID": "sample string 8",
      "GasPremiseID": "sample string 9",
      "GasRate": 1.0,
      "GasInvoiceAmount": 1.0,
      "GasInvoiceUsage": 1.0,
      "GasUtilityCharges": 1.0,
      "GasUtilityName": "sample string 10",
      "GasUtilityLabel": [
        {
          "UtilName": "sample string 1",
          "UtilCode": "sample string 2",
          "AccountMaskComment": "sample string 3",
          "CommodityTypeIdentifier": "sample string 4",
          "AccountLabel": "sample string 5",
          "FriendlyName": "sample string 6",
          "IsActive": "sample string 7",
          "JurisdictionShortIdentifier": "sample string 8",
          "MarketParticipantIdentifier": "sample string 9",
          "MarketParticipantShortIdentifier": "sample string 10",
          "AccountValidationRegularExpression": "sample string 11",
          "AccountMaskpublic": "sample string 12"
        },
        {
          "UtilName": "sample string 1",
          "UtilCode": "sample string 2",
          "AccountMaskComment": "sample string 3",
          "CommodityTypeIdentifier": "sample string 4",
          "AccountLabel": "sample string 5",
          "FriendlyName": "sample string 6",
          "IsActive": "sample string 7",
          "JurisdictionShortIdentifier": "sample string 8",
          "MarketParticipantIdentifier": "sample string 9",
          "MarketParticipantShortIdentifier": "sample string 10",
          "AccountValidationRegularExpression": "sample string 11",
          "AccountMaskpublic": "sample string 12"
        }
      ],
      "GasInvoiceDate": "2025-05-02T11:15:38.0754543-04:00",
      "ServiceAddress1": "sample string 11",
      "ServiceAddress2": "sample string 12",
      "ServiceCity": "sample string 13",
      "ServiceState": "sample string 14",
      "ServiceZip": "sample string 15",
      "ServiceCountry": "sample string 16",
      "HomeType": "sample string 17",
      "PremiseAreaSQFTExact": "sample string 18",
      "PremiseAreaInSQFTRange": "sample string 19",
      "CustomerHouseAgeInYearsRange": "sample string 20",
      "CustomerHouseAgeInYearsExact": "sample string 21",
      "IsRentedPremise": true,
      "IsHeatPumpInstalled": true,
      "HeatPumpAgeInYear": 1.0,
      "HeatPumpCapacityRange": "sample string 22",
      "HeatPumpPhoto": "sample string 23",
      "HeatPumpType": "sample string 24",
      "IsACInstalled": true,
      "ACAgeInYear1": 1.0,
      "ACCapacityInTonsRange1": "sample string 25",
      "ACPhoto1": "sample string 26",
      "ACAgeInYear2": 1.0,
      "ACCapacityInTonsRange2": "sample string 27",
      "ACPhoto2": "sample string 28",
      "ACAgeInYear3": "sample string 29",
      "ACCapacityInTonsRange3": "sample string 30",
      "ACPhoto3": "sample string 31",
      "ACAgeInYear4": "sample string 32",
      "ACCapacityInTonsRange4": "sample string 33",
      "ACPhoto4": "sample string 34",
      "GasOrElectricHeatInstalled": "sample string 35",
      "FurnaceAgeInYear": 1.0,
      "FurnaceCapacityInBTURange": "sample string 36",
      "FurnacePhoto": "sample string 37",
      "FilterAgeInYear": 1.0,
      "FilterSizeInInch": "sample string 38",
      "FilterPhoto": "sample string 39",
      "FilterAgeInYear2": "sample string 40",
      "FilterSizeInInch2": "sample string 41",
      "FilterPhoto2": "sample string 42",
      "FilterAgeInYear3": "sample string 43",
      "FilterSizeInInch3": "sample string 44",
      "FilterPhoto3": "sample string 45",
      "FilterAgeInYear4": "sample string 46",
      "FilterSizeInInch4": "sample string 47",
      "FilterPhoto4": "sample string 48",
      "IsRadiantInFloorHeating": true,
      "TanklessWaterHeaterAgeInYear": 1.0,
      "TanklessWaterHeaterPhoto": "sample string 49",
      "TanklessWaterHeaterAgeInYear2": "sample string 50",
      "TanklessWaterHeaterPhoto2": "sample string 51",
      "TanklessWaterHeaterAgeInYear3": "sample string 52",
      "TanklessWaterHeaterPhoto3": "sample string 53",
      "TanklessWaterHeaterAgeInYear4": "sample string 54",
      "TanklessWaterHeaterPhoto4": "sample string 55",
      "ElectricWaterHeaterAgeInYear": 1.0,
      "ElectricWaterHeaterPhoto": "sample string 56",
      "ElectricWaterHeaterAgeInYear2": "sample string 57",
      "ElectricWaterHeaterPhoto2": "sample string 58",
      "ElectricWaterHeaterAgeInYear3": "sample string 59",
      "ElectricWaterHeaterPhoto3": "sample string 60",
      "ElectricWaterHeaterAgeInYear4": "sample string 61",
      "ElectricWaterHeaterPhoto4": "sample string 62",
      "GasTankWaterHeaterAgeInYear": 1.0,
      "GasTankWaterHeaterPhoto": "sample string 63",
      "GasTankWaterHeaterAgeInYear2": "sample string 64",
      "GasTankWaterHeaterPhoto2": "sample string 65",
      "GasTankWaterHeaterAgeInYear3": "sample string 66",
      "GasTankWaterHeaterPhoto3": "sample string 67",
      "GasTankWaterHeaterAgeInYear4": "sample string 68",
      "GasTankWaterHeaterPhoto4": "sample string 69",
      "IsSolarPannelInstalled": true,
      "SolarPanelPhoto": "sample string 70",
      "SolarPanelInstalledCount": 1,
      "IsHotTubInstalled": true,
      "IsPoolFacility": true,
      "ThermostatsInstalledCount": 1,
      "SmartThermostatsInstalledCount": 1,
      "SmokeDetectorInstalledCount": 1,
      "CarbonMonoxideDetectorInstalledCount": 1,
      "VendorCode": "sample string 71",
      "ID": 1,
      "ContractID": "sample string 72",
      "CompanyID": 1,
      "CustomerID": "sample string 73",
      "RefID": "sample string 74",
      "IsActive": true,
      "UpdatedBy": "sample string 75",
      "UpdatedDate": "2025-05-02T11:15:38.0754543-04:00",
      "CreatedBy": "sample string 76",
      "CreatedDate": "2025-05-02T11:15:38.0754543-04:00"
    },
    {
      "PremiseID": "sample string 1",
      "UserID": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "EmaiID": "sample string 5",
      "FamilyHeadCount": 1,
      "IsExistingElectricCustomer": true,
      "IsExistingGasCustomer": true,
      "ElectricPremiseID": "sample string 6",
      "ElectricityRate": 1.0,
      "ElectricInvoiceAmount": 1.0,
      "ElectricInvoiceUsage": 1.0,
      "ElectricUtilityCharges": 1.0,
      "ElectricUtilityName": "sample string 7",
      "ElectricUtilityLabel": [
        {
          "UtilName": "sample string 1",
          "UtilCode": "sample string 2",
          "AccountMaskComment": "sample string 3",
          "CommodityTypeIdentifier": "sample string 4",
          "AccountLabel": "sample string 5",
          "FriendlyName": "sample string 6",
          "IsActive": "sample string 7",
          "JurisdictionShortIdentifier": "sample string 8",
          "MarketParticipantIdentifier": "sample string 9",
          "MarketParticipantShortIdentifier": "sample string 10",
          "AccountValidationRegularExpression": "sample string 11",
          "AccountMaskpublic": "sample string 12"
        },
        {
          "UtilName": "sample string 1",
          "UtilCode": "sample string 2",
          "AccountMaskComment": "sample string 3",
          "CommodityTypeIdentifier": "sample string 4",
          "AccountLabel": "sample string 5",
          "FriendlyName": "sample string 6",
          "IsActive": "sample string 7",
          "JurisdictionShortIdentifier": "sample string 8",
          "MarketParticipantIdentifier": "sample string 9",
          "MarketParticipantShortIdentifier": "sample string 10",
          "AccountValidationRegularExpression": "sample string 11",
          "AccountMaskpublic": "sample string 12"
        }
      ],
      "ElectricInvoiceDate": "2025-05-02T11:15:38.0754543-04:00",
      "GasCustomerID": "sample string 8",
      "GasPremiseID": "sample string 9",
      "GasRate": 1.0,
      "GasInvoiceAmount": 1.0,
      "GasInvoiceUsage": 1.0,
      "GasUtilityCharges": 1.0,
      "GasUtilityName": "sample string 10",
      "GasUtilityLabel": [
        {
          "UtilName": "sample string 1",
          "UtilCode": "sample string 2",
          "AccountMaskComment": "sample string 3",
          "CommodityTypeIdentifier": "sample string 4",
          "AccountLabel": "sample string 5",
          "FriendlyName": "sample string 6",
          "IsActive": "sample string 7",
          "JurisdictionShortIdentifier": "sample string 8",
          "MarketParticipantIdentifier": "sample string 9",
          "MarketParticipantShortIdentifier": "sample string 10",
          "AccountValidationRegularExpression": "sample string 11",
          "AccountMaskpublic": "sample string 12"
        },
        {
          "UtilName": "sample string 1",
          "UtilCode": "sample string 2",
          "AccountMaskComment": "sample string 3",
          "CommodityTypeIdentifier": "sample string 4",
          "AccountLabel": "sample string 5",
          "FriendlyName": "sample string 6",
          "IsActive": "sample string 7",
          "JurisdictionShortIdentifier": "sample string 8",
          "MarketParticipantIdentifier": "sample string 9",
          "MarketParticipantShortIdentifier": "sample string 10",
          "AccountValidationRegularExpression": "sample string 11",
          "AccountMaskpublic": "sample string 12"
        }
      ],
      "GasInvoiceDate": "2025-05-02T11:15:38.0754543-04:00",
      "ServiceAddress1": "sample string 11",
      "ServiceAddress2": "sample string 12",
      "ServiceCity": "sample string 13",
      "ServiceState": "sample string 14",
      "ServiceZip": "sample string 15",
      "ServiceCountry": "sample string 16",
      "HomeType": "sample string 17",
      "PremiseAreaSQFTExact": "sample string 18",
      "PremiseAreaInSQFTRange": "sample string 19",
      "CustomerHouseAgeInYearsRange": "sample string 20",
      "CustomerHouseAgeInYearsExact": "sample string 21",
      "IsRentedPremise": true,
      "IsHeatPumpInstalled": true,
      "HeatPumpAgeInYear": 1.0,
      "HeatPumpCapacityRange": "sample string 22",
      "HeatPumpPhoto": "sample string 23",
      "HeatPumpType": "sample string 24",
      "IsACInstalled": true,
      "ACAgeInYear1": 1.0,
      "ACCapacityInTonsRange1": "sample string 25",
      "ACPhoto1": "sample string 26",
      "ACAgeInYear2": 1.0,
      "ACCapacityInTonsRange2": "sample string 27",
      "ACPhoto2": "sample string 28",
      "ACAgeInYear3": "sample string 29",
      "ACCapacityInTonsRange3": "sample string 30",
      "ACPhoto3": "sample string 31",
      "ACAgeInYear4": "sample string 32",
      "ACCapacityInTonsRange4": "sample string 33",
      "ACPhoto4": "sample string 34",
      "GasOrElectricHeatInstalled": "sample string 35",
      "FurnaceAgeInYear": 1.0,
      "FurnaceCapacityInBTURange": "sample string 36",
      "FurnacePhoto": "sample string 37",
      "FilterAgeInYear": 1.0,
      "FilterSizeInInch": "sample string 38",
      "FilterPhoto": "sample string 39",
      "FilterAgeInYear2": "sample string 40",
      "FilterSizeInInch2": "sample string 41",
      "FilterPhoto2": "sample string 42",
      "FilterAgeInYear3": "sample string 43",
      "FilterSizeInInch3": "sample string 44",
      "FilterPhoto3": "sample string 45",
      "FilterAgeInYear4": "sample string 46",
      "FilterSizeInInch4": "sample string 47",
      "FilterPhoto4": "sample string 48",
      "IsRadiantInFloorHeating": true,
      "TanklessWaterHeaterAgeInYear": 1.0,
      "TanklessWaterHeaterPhoto": "sample string 49",
      "TanklessWaterHeaterAgeInYear2": "sample string 50",
      "TanklessWaterHeaterPhoto2": "sample string 51",
      "TanklessWaterHeaterAgeInYear3": "sample string 52",
      "TanklessWaterHeaterPhoto3": "sample string 53",
      "TanklessWaterHeaterAgeInYear4": "sample string 54",
      "TanklessWaterHeaterPhoto4": "sample string 55",
      "ElectricWaterHeaterAgeInYear": 1.0,
      "ElectricWaterHeaterPhoto": "sample string 56",
      "ElectricWaterHeaterAgeInYear2": "sample string 57",
      "ElectricWaterHeaterPhoto2": "sample string 58",
      "ElectricWaterHeaterAgeInYear3": "sample string 59",
      "ElectricWaterHeaterPhoto3": "sample string 60",
      "ElectricWaterHeaterAgeInYear4": "sample string 61",
      "ElectricWaterHeaterPhoto4": "sample string 62",
      "GasTankWaterHeaterAgeInYear": 1.0,
      "GasTankWaterHeaterPhoto": "sample string 63",
      "GasTankWaterHeaterAgeInYear2": "sample string 64",
      "GasTankWaterHeaterPhoto2": "sample string 65",
      "GasTankWaterHeaterAgeInYear3": "sample string 66",
      "GasTankWaterHeaterPhoto3": "sample string 67",
      "GasTankWaterHeaterAgeInYear4": "sample string 68",
      "GasTankWaterHeaterPhoto4": "sample string 69",
      "IsSolarPannelInstalled": true,
      "SolarPanelPhoto": "sample string 70",
      "SolarPanelInstalledCount": 1,
      "IsHotTubInstalled": true,
      "IsPoolFacility": true,
      "ThermostatsInstalledCount": 1,
      "SmartThermostatsInstalledCount": 1,
      "SmokeDetectorInstalledCount": 1,
      "CarbonMonoxideDetectorInstalledCount": 1,
      "VendorCode": "sample string 71",
      "ID": 1,
      "ContractID": "sample string 72",
      "CompanyID": 1,
      "CustomerID": "sample string 73",
      "RefID": "sample string 74",
      "IsActive": true,
      "UpdatedBy": "sample string 75",
      "UpdatedDate": "2025-05-02T11:15:38.0754543-04:00",
      "CreatedBy": "sample string 76",
      "CreatedDate": "2025-05-02T11:15:38.0754543-04:00"
    }
  ]
}