ICP connection data v2

API change history

The ICP connection data API provides three functions to get data on Installation Control Points (ICP):

  • The GET action - a search function, allows searching by via address filters and returns matching results allowing the correct ICP to be identified.
  • The GET action - get by id, takes a single ICP and returns detailed information about it.
  • The GET action - get by id list, takes a single or comma separated list of ICPs and returns detailed information about them.

A management policy is set on this API restricting users to 250 calls per minute for ‘search’ and ‘get by id’ calls while calls for multiple ICPs ‘get by id list’ are restricted to 10 calls per minute and/or 60 MB of data per hour.

NOTE - in order to use the ICP connection data you must subscribe to the ICP connection data API product to receive your API key.

Get by id

Provide a single valid ICP to return its details. This will always return a list. Any lower case characters in the ICP will be converted to upper case.

A valid ICP is a 15 character string, comprised of 10 digits, 2 characters, and 3 hexi-decimal characters.

Try it

Request

Request URL

Request parameters

  • string

    A valid ICP is a 15 character string, comprised of 10 digits, 2 characters, and 3 hexi-decimal characters.

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Success

Representations

{
  "ICPIdentifier": "string",
  "ICPStatus": 0,
  "Address": {
    "PropertyNameOrDescription": "string",
    "PhysicalAddressUnit": "string",
    "PhysicalAddressNumber": "string",
    "PhysicalAddressStreet": "string",
    "PhysicalAddressSuburb": "string",
    "PhysicalAddressTown": "string",
    "PhysicalAddressRegion": "string",
    "PhysicalAddressPostCode": 0,
    "GPS_Easting": 0.086597829994870867,
    "GPS_Northing": 0.089592538769447838
  },
  "Network": {
    "NetworkParticipantID": "string",
    "NetworkParticipantName": "string",
    "POC": "string",
    "ReconciliationType": "string",
    "InitialElectricallyConnectedDate": "string",
    "GenerationCapacity": 0.59222133055867521,
    "FuelType": "string",
    "DirectBilledStatus": "string"
  },
  "Pricing": {
    "DistributorPriceCategoryCode": "string",
    "DistributorLossCategoryCode": "string",
    "ChargeableCapacity": 0.74166837179270262,
    "DistributorInstallationDetails": "string"
  },
  "Trader": {
    "TraderSwitchInProgress": false,
    "TraderParticipantID": "string",
    "TraderParticipantName": "string",
    "ProfileCode": "string",
    "ANZSICcode": "string",
    "DailyUnmeteredkWh": "string",
    "UnmeteredLoadDetails": "string"
  },
  "Metering": {
    "MeteringEquipmentProviderParticipantID": "string",
    "MeteringEquipmentProviderParticipantName": "string",
    "InstallationInformation": [
      {
        "MeteringInstallationCategory": 0,
        "MeteringInstallationType": "string",
        "CertificationExpiryDate": "string",
        "ComponentInformation": [
          {
            "ComponentType": "string",
            "MeteringComponentSerialNumber": "string",
            "MeterType": "string",
            "AMIFlag": false,
            "CompensationFactor": 0.68670529385750934,
            "ChannelInformation": [
              {
                "MeteringComponentSerialNumber": "string",
                "ChannelNumber": 0,
                "RegisterContentCode": "string",
                "PeriodOfAvailability": "string",
                "UnitOfMeasurement": "string",
                "EnergyFlowDirection": "string",
                "AccumulatorType": "string",
                "SwitchReadIndicator": false
              }
            ]
          }
        ]
      }
    ]
  },
  "Messages": [
    "string"
  ]
}
{
  "type": "object",
  "properties": {
    "ICPIdentifier": {
      "type": "string"
    },
    "ICPStatus": {
      "format": "int32",
      "type": "integer"
    },
    "Address": {
      "type": "object",
      "properties": {
        "PropertyNameOrDescription": {
          "type": "string"
        },
        "PhysicalAddressUnit": {
          "type": "string"
        },
        "PhysicalAddressNumber": {
          "type": "string"
        },
        "PhysicalAddressStreet": {
          "type": "string"
        },
        "PhysicalAddressSuburb": {
          "type": "string"
        },
        "PhysicalAddressTown": {
          "type": "string"
        },
        "PhysicalAddressRegion": {
          "type": "string"
        },
        "PhysicalAddressPostCode": {
          "format": "int32",
          "type": "integer"
        },
        "GPS_Easting": {
          "format": "double",
          "type": "number"
        },
        "GPS_Northing": {
          "format": "double",
          "type": "number"
        }
      },
      "example": {
        "PropertyNameOrDescription": "string",
        "PhysicalAddressUnit": "string",
        "PhysicalAddressNumber": "string",
        "PhysicalAddressStreet": "string",
        "PhysicalAddressSuburb": "string",
        "PhysicalAddressTown": "string",
        "PhysicalAddressRegion": "string",
        "PhysicalAddressPostCode": 0,
        "GPS_Easting": 0.1778884353872654,
        "GPS_Northing": 0.24947440612677929
      }
    },
    "Network": {
      "type": "object",
      "properties": {
        "NetworkParticipantID": {
          "type": "string"
        },
        "NetworkParticipantName": {
          "type": "string"
        },
        "POC": {
          "type": "string"
        },
        "ReconciliationType": {
          "type": "string"
        },
        "InitialElectricallyConnectedDate": {
          "type": "string"
        },
        "GenerationCapacity": {
          "format": "double",
          "type": "number"
        },
        "FuelType": {
          "type": "string"
        },
        "DirectBilledStatus": {
          "type": "string"
        }
      },
      "example": {
        "NetworkParticipantID": "string",
        "NetworkParticipantName": "string",
        "POC": "string",
        "ReconciliationType": "string",
        "InitialElectricallyConnectedDate": "string",
        "GenerationCapacity": 0.57073710342848116,
        "FuelType": "string",
        "DirectBilledStatus": "string"
      }
    },
    "Pricing": {
      "type": "object",
      "properties": {
        "DistributorPriceCategoryCode": {
          "type": "string"
        },
        "DistributorLossCategoryCode": {
          "type": "string"
        },
        "ChargeableCapacity": {
          "format": "double",
          "type": "number"
        },
        "DistributorInstallationDetails": {
          "type": "string"
        }
      }
    },
    "Trader": {
      "type": "object",
      "properties": {
        "TraderSwitchInProgress": {
          "type": "boolean"
        },
        "TraderParticipantID": {
          "type": "string"
        },
        "TraderParticipantName": {
          "type": "string"
        },
        "ProfileCode": {
          "type": "string"
        },
        "ANZSICcode": {
          "type": "string"
        },
        "DailyUnmeteredkWh": {
          "type": "string"
        },
        "UnmeteredLoadDetails": {
          "type": "string"
        }
      },
      "example": {
        "TraderSwitchInProgress": false,
        "TraderParticipantID": "string",
        "TraderParticipantName": "string",
        "ProfileCode": "string",
        "ANZSICcode": "string",
        "DailyUnmeteredkWh": "string",
        "UnmeteredLoadDetails": "string"
      }
    },
    "Metering": {
      "type": "object",
      "properties": {
        "MeteringEquipmentProviderParticipantID": {
          "type": "string"
        },
        "MeteringEquipmentProviderParticipantName": {
          "type": "string"
        },
        "InstallationInformation": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "MeteringInstallationCategory": {
                "format": "int32",
                "type": "integer"
              },
              "MeteringInstallationType": {
                "type": "string"
              },
              "CertificationExpiryDate": {
                "type": "string"
              },
              "ComponentInformation": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "ComponentType": {
                      "type": "string"
                    },
                    "MeteringComponentSerialNumber": {
                      "type": "string"
                    },
                    "MeterType": {
                      "type": "string"
                    },
                    "AMIFlag": {
                      "type": "boolean"
                    },
                    "CompensationFactor": {
                      "format": "double",
                      "type": "number"
                    },
                    "ChannelInformation": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "MeteringComponentSerialNumber": {
                            "type": "string"
                          },
                          "ChannelNumber": {
                            "format": "int32",
                            "type": "integer"
                          },
                          "RegisterContentCode": {
                            "type": "string"
                          },
                          "PeriodOfAvailability": {
                            "type": "string"
                          },
                          "UnitOfMeasurement": {
                            "type": "string"
                          },
                          "EnergyFlowDirection": {
                            "type": "string"
                          },
                          "AccumulatorType": {
                            "type": "string"
                          },
                          "SwitchReadIndicator": {
                            "type": "boolean"
                          }
                        },
                        "example": {
                          "MeteringComponentSerialNumber": "string",
                          "ChannelNumber": 0,
                          "RegisterContentCode": "string",
                          "PeriodOfAvailability": "string",
                          "UnitOfMeasurement": "string",
                          "EnergyFlowDirection": "string",
                          "AccumulatorType": "string",
                          "SwitchReadIndicator": false
                        }
                      }
                    }
                  },
                  "example": {
                    "ComponentType": "string",
                    "MeteringComponentSerialNumber": "string",
                    "MeterType": "string",
                    "AMIFlag": false,
                    "CompensationFactor": 0.25155401565176239,
                    "ChannelInformation": [
                      {
                        "MeteringComponentSerialNumber": "string",
                        "ChannelNumber": 0,
                        "RegisterContentCode": "string",
                        "PeriodOfAvailability": "string",
                        "UnitOfMeasurement": "string",
                        "EnergyFlowDirection": "string",
                        "AccumulatorType": "string"
                      }
                    ]
                  }
                }
              }
            },
            "example": {
              "MeteringInstallationCategory": 0,
              "MeteringInstallationType": "string",
              "CertificationExpiryDate": "string",
              "ComponentInformation": [
                {
                  "ComponentType": "string",
                  "MeteringComponentSerialNumber": "string",
                  "MeterType": "string",
                  "AMIFlag": false,
                  "CompensationFactor": 0.30470565157413709,
                  "ChannelInformation": [
                    {
                      "MeteringComponentSerialNumber": "string",
                      "ChannelNumber": 0,
                      "RegisterContentCode": "string",
                      "PeriodOfAvailability": "string",
                      "UnitOfMeasurement": "string",
                      "EnergyFlowDirection": "string",
                      "AccumulatorType": "string"
                    }
                  ]
                }
              ]
            }
          }
        }
      },
      "example": {
        "MeteringEquipmentProviderParticipantID": "string",
        "MeteringEquipmentProviderParticipantName": "string",
        "InstallationInformation": [
          {
            "MeteringInstallationCategory": 0,
            "MeteringInstallationType": "string",
            "CertificationExpiryDate": "string",
            "ComponentInformation": [
              {
                "ComponentType": "string",
                "MeteringComponentSerialNumber": "string",
                "MeterType": "string",
                "AMIFlag": false,
                "CompensationFactor": 0.070918096825621335,
                "ChannelInformation": [
                  {
                    "MeteringComponentSerialNumber": "string",
                    "ChannelNumber": 0,
                    "RegisterContentCode": "string",
                    "PeriodOfAvailability": "string",
                    "UnitOfMeasurement": "string",
                    "EnergyFlowDirection": "string",
                    "AccumulatorType": "string",
                    "SwitchReadIndicator": false
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "Messages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "example": {
    "ICPIdentifier": "string",
    "ICPStatus": 0,
    "Address": {
      "PropertyNameOrDescription": "string",
      "PhysicalAddressStreet": "string",
      "PhysicalAddressSuburb": "string",
      "PhysicalAddressTown": "string",
      "PhysicalAddressRegion": "string",
      "PhysicalAddressPostCode": 0,
      "GPS_Easting": 0.086597829994870867,
      "GPS_Northing": 0.089592538769447838
    },
    "Network": {
      "NetworkParticipantID": "string",
      "NetworkParticipantName": "string",
      "POC": "string",
      "ReconciliationType": "string",
      "InitialElectricallyConnectedDate": "string",
      "GenerationCapacity": 0.59222133055867521,
      "FuelType": "string",
      "DirectBilledStatus": "string"
    },
    "Pricing": {
      "DistributorPriceCategoryCode": "string",
      "DistributorLossCategoryCode": "string",
      "ChargeableCapacity": 0.74166837179270262,
      "DistributorInstallationDetails": "string"
    },
    "Trader": {
      "TraderSwitchInProgress": false,
      "TraderParticipantID": "string",
      "TraderParticipantName": "string",
      "ProfileCode": "string",
      "ANZSICcode": "string",
      "DailyUnmeteredkWh": "string",
      "UnmeteredLoadDetails": "string"
    },
    "Metering": {
      "MeteringEquipmentProviderParticipantID": "string",
      "MeteringEquipmentProviderParticipantName": "string",
      "InstallationInformation": [
        {
          "MeteringInstallationCategory": 0,
          "MeteringInstallationType": "string",
          "CertificationExpiryDate": "string",
          "ComponentInformation": [
            {
              "ComponentType": "string",
              "MeteringComponentSerialNumber": "string",
              "MeterType": "string",
              "AMIFlag": false,
              "CompensationFactor": 0.68670529385750934,
              "ChannelInformation": [
                {
                  "MeteringComponentSerialNumber": "string",
                  "ChannelNumber": 0,
                  "RegisterContentCode": "string",
                  "PeriodOfAvailability": "string",
                  "UnitOfMeasurement": "string",
                  "EnergyFlowDirection": "string",
                  "AccumulatorType": "string",
                  "SwitchReadIndicator": false
                }
              ]
            }
          ]
        }
      ]
    },
    "RegistryMessages": [
      "string"
    ]
  }
}

400 Bad Request

Invalid ICP. An ICP is a 15 character string, comprised of 10 digits, 2 characters, and 3 hexi-decimal characters.

eg 0000123456ZZAF0

Representations

{
  "ICPIdentifier": "XXXXXX",
  "ICPStatus": 0,
  "Address": null,
  "Network": null,
  "Pricing": null,
  "Trader": null,
  "Metering": null,
  "Messages": [
    {
      "Code": 400,
      "Message": "Invalid ICP. An ICP is a 15 character string, comprised of 10 digits, 2 characters, and 3 hexi-decimal characters."
    }
  ]
}
{
  "type": "object",
  "properties": {
    "ICPIdentifier": {
      "type": "string"
    },
    "ICPStatus": {
      "format": "int32",
      "type": "integer"
    },
    "Address": {
      "type": "object",
      "properties": {
        "PropertyNameOrDescription": {
          "type": "string"
        },
        "PhysicalAddressUnit": {
          "type": "string"
        },
        "PhysicalAddressNumber": {
          "type": "string"
        },
        "PhysicalAddressStreet": {
          "type": "string"
        },
        "PhysicalAddressSuburb": {
          "type": "string"
        },
        "PhysicalAddressTown": {
          "type": "string"
        },
        "PhysicalAddressRegion": {
          "type": "string"
        },
        "PhysicalAddressPostCode": {
          "format": "int32",
          "type": "integer"
        },
        "GPS_Easting": {
          "format": "double",
          "type": "number"
        },
        "GPS_Northing": {
          "format": "double",
          "type": "number"
        }
      },
      "example": {
        "PropertyNameOrDescription": "string",
        "PhysicalAddressUnit": "string",
        "PhysicalAddressNumber": "string",
        "PhysicalAddressStreet": "string",
        "PhysicalAddressSuburb": "string",
        "PhysicalAddressTown": "string",
        "PhysicalAddressRegion": "string",
        "PhysicalAddressPostCode": 0,
        "GPS_Easting": 0.1778884353872654,
        "GPS_Northing": 0.24947440612677929
      }
    },
    "Network": {
      "type": "object",
      "properties": {
        "NetworkParticipantID": {
          "type": "string"
        },
        "NetworkParticipantName": {
          "type": "string"
        },
        "POC": {
          "type": "string"
        },
        "ReconciliationType": {
          "type": "string"
        },
        "InitialElectricallyConnectedDate": {
          "type": "string"
        },
        "GenerationCapacity": {
          "format": "double",
          "type": "number"
        },
        "FuelType": {
          "type": "string"
        },
        "DirectBilledStatus": {
          "type": "string"
        }
      },
      "example": {
        "NetworkParticipantID": "string",
        "NetworkParticipantName": "string",
        "POC": "string",
        "ReconciliationType": "string",
        "InitialElectricallyConnectedDate": "string",
        "GenerationCapacity": 0.57073710342848116,
        "FuelType": "string",
        "DirectBilledStatus": "string"
      }
    },
    "Pricing": {
      "type": "object",
      "properties": {
        "DistributorPriceCategoryCode": {
          "type": "string"
        },
        "DistributorLossCategoryCode": {
          "type": "string"
        },
        "ChargeableCapacity": {
          "format": "double",
          "type": "number"
        },
        "DistributorInstallationDetails": {
          "type": "string"
        }
      }
    },
    "Trader": {
      "type": "object",
      "properties": {
        "TraderSwitchInProgress": {
          "type": "boolean"
        },
        "TraderParticipantID": {
          "type": "string"
        },
        "TraderParticipantName": {
          "type": "string"
        },
        "ProfileCode": {
          "type": "string"
        },
        "ANZSICcode": {
          "type": "string"
        },
        "DailyUnmeteredkWh": {
          "type": "string"
        },
        "UnmeteredLoadDetails": {
          "type": "string"
        }
      },
      "example": {
        "TraderSwitchInProgress": false,
        "TraderParticipantID": "string",
        "TraderParticipantName": "string",
        "ProfileCode": "string",
        "ANZSICcode": "string",
        "DailyUnmeteredkWh": "string",
        "UnmeteredLoadDetails": "string"
      }
    },
    "Metering": {
      "type": "object",
      "properties": {
        "MeteringEquipmentProviderParticipantID": {
          "type": "string"
        },
        "MeteringEquipmentProviderParticipantName": {
          "type": "string"
        },
        "InstallationInformation": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "MeteringInstallationCategory": {
                "format": "int32",
                "type": "integer"
              },
              "MeteringInstallationType": {
                "type": "string"
              },
              "CertificationExpiryDate": {
                "type": "string"
              },
              "ComponentInformation": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "ComponentType": {
                      "type": "string"
                    },
                    "MeteringComponentSerialNumber": {
                      "type": "string"
                    },
                    "MeterType": {
                      "type": "string"
                    },
                    "AMIFlag": {
                      "type": "boolean"
                    },
                    "CompensationFactor": {
                      "format": "double",
                      "type": "number"
                    },
                    "ChannelInformation": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "MeteringComponentSerialNumber": {
                            "type": "string"
                          },
                          "ChannelNumber": {
                            "format": "int32",
                            "type": "integer"
                          },
                          "RegisterContentCode": {
                            "type": "string"
                          },
                          "PeriodOfAvailability": {
                            "type": "string"
                          },
                          "UnitOfMeasurement": {
                            "type": "string"
                          },
                          "EnergyFlowDirection": {
                            "type": "string"
                          },
                          "AccumulatorType": {
                            "type": "string"
                          },
                          "SwitchReadIndicator": {
                            "type": "boolean"
                          }
                        },
                        "example": {
                          "MeteringComponentSerialNumber": "string",
                          "ChannelNumber": 0,
                          "RegisterContentCode": "string",
                          "PeriodOfAvailability": "string",
                          "UnitOfMeasurement": "string",
                          "EnergyFlowDirection": "string",
                          "AccumulatorType": "string",
                          "SwitchReadIndicator": false
                        }
                      }
                    }
                  },
                  "example": {
                    "ComponentType": "string",
                    "MeteringComponentSerialNumber": "string",
                    "MeterType": "string",
                    "AMIFlag": false,
                    "CompensationFactor": 0.25155401565176239,
                    "ChannelInformation": [
                      {
                        "MeteringComponentSerialNumber": "string",
                        "ChannelNumber": 0,
                        "RegisterContentCode": "string",
                        "PeriodOfAvailability": "string",
                        "UnitOfMeasurement": "string",
                        "EnergyFlowDirection": "string",
                        "AccumulatorType": "string"
                      }
                    ]
                  }
                }
              }
            },
            "example": {
              "MeteringInstallationCategory": 0,
              "MeteringInstallationType": "string",
              "CertificationExpiryDate": "string",
              "ComponentInformation": [
                {
                  "ComponentType": "string",
                  "MeteringComponentSerialNumber": "string",
                  "MeterType": "string",
                  "AMIFlag": false,
                  "CompensationFactor": 0.30470565157413709,
                  "ChannelInformation": [
                    {
                      "MeteringComponentSerialNumber": "string",
                      "ChannelNumber": 0,
                      "RegisterContentCode": "string",
                      "PeriodOfAvailability": "string",
                      "UnitOfMeasurement": "string",
                      "EnergyFlowDirection": "string",
                      "AccumulatorType": "string"
                    }
                  ]
                }
              ]
            }
          }
        }
      },
      "example": {
        "MeteringEquipmentProviderParticipantID": "string",
        "MeteringEquipmentProviderParticipantName": "string",
        "InstallationInformation": [
          {
            "MeteringInstallationCategory": 0,
            "MeteringInstallationType": "string",
            "CertificationExpiryDate": "string",
            "ComponentInformation": [
              {
                "ComponentType": "string",
                "MeteringComponentSerialNumber": "string",
                "MeterType": "string",
                "AMIFlag": false,
                "CompensationFactor": 0.070918096825621335,
                "ChannelInformation": [
                  {
                    "MeteringComponentSerialNumber": "string",
                    "ChannelNumber": 0,
                    "RegisterContentCode": "string",
                    "PeriodOfAvailability": "string",
                    "UnitOfMeasurement": "string",
                    "EnergyFlowDirection": "string",
                    "AccumulatorType": "string",
                    "SwitchReadIndicator": false
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "Messages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "example": {
    "ICPIdentifier": "string",
    "ICPStatus": 0,
    "Address": {
      "PropertyNameOrDescription": "string",
      "PhysicalAddressStreet": "string",
      "PhysicalAddressSuburb": "string",
      "PhysicalAddressTown": "string",
      "PhysicalAddressRegion": "string",
      "PhysicalAddressPostCode": 0,
      "GPS_Easting": 0.086597829994870867,
      "GPS_Northing": 0.089592538769447838
    },
    "Network": {
      "NetworkParticipantID": "string",
      "NetworkParticipantName": "string",
      "POC": "string",
      "ReconciliationType": "string",
      "InitialElectricallyConnectedDate": "string",
      "GenerationCapacity": 0.59222133055867521,
      "FuelType": "string",
      "DirectBilledStatus": "string"
    },
    "Pricing": {
      "DistributorPriceCategoryCode": "string",
      "DistributorLossCategoryCode": "string",
      "ChargeableCapacity": 0.74166837179270262,
      "DistributorInstallationDetails": "string"
    },
    "Trader": {
      "TraderSwitchInProgress": false,
      "TraderParticipantID": "string",
      "TraderParticipantName": "string",
      "ProfileCode": "string",
      "ANZSICcode": "string",
      "DailyUnmeteredkWh": "string",
      "UnmeteredLoadDetails": "string"
    },
    "Metering": {
      "MeteringEquipmentProviderParticipantID": "string",
      "MeteringEquipmentProviderParticipantName": "string",
      "InstallationInformation": [
        {
          "MeteringInstallationCategory": 0,
          "MeteringInstallationType": "string",
          "CertificationExpiryDate": "string",
          "ComponentInformation": [
            {
              "ComponentType": "string",
              "MeteringComponentSerialNumber": "string",
              "MeterType": "string",
              "AMIFlag": false,
              "CompensationFactor": 0.68670529385750934,
              "ChannelInformation": [
                {
                  "MeteringComponentSerialNumber": "string",
                  "ChannelNumber": 0,
                  "RegisterContentCode": "string",
                  "PeriodOfAvailability": "string",
                  "UnitOfMeasurement": "string",
                  "EnergyFlowDirection": "string",
                  "AccumulatorType": "string",
                  "SwitchReadIndicator": false
                }
              ]
            }
          ]
        }
      ]
    },
    "RegistryMessages": [
      "string"
    ]
  }
}

403 Forbidden

Forbidden

Representations

{
  "statusCode": 0,
  "message": "string"
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "integer"
    },
    "message": {
      "type": "string"
    }
  },
  "example": {
    "statusCode": 0,
    "message": "string"
  }
}

404 Not Found

ICP not found in the registry.

Representations

{
  "ICPIdentifier": "1234567890AA111",
  "ICPStatus": 0,
  "Address": null,
  "Network": null,
  "Pricing": null,
  "Trader": null,
  "Metering": null,
  "Messages": [
    {
      "Code": 404,
      "Message": "ICP not found in the registry."
    }
  ]
}
{
  "type": "object",
  "properties": {
    "ICPIdentifier": {
      "type": "string"
    },
    "ICPStatus": {
      "format": "int32",
      "type": "integer"
    },
    "Address": {
      "type": "object",
      "properties": {
        "PropertyNameOrDescription": {
          "type": "string"
        },
        "PhysicalAddressUnit": {
          "type": "string"
        },
        "PhysicalAddressNumber": {
          "type": "string"
        },
        "PhysicalAddressStreet": {
          "type": "string"
        },
        "PhysicalAddressSuburb": {
          "type": "string"
        },
        "PhysicalAddressTown": {
          "type": "string"
        },
        "PhysicalAddressRegion": {
          "type": "string"
        },
        "PhysicalAddressPostCode": {
          "format": "int32",
          "type": "integer"
        },
        "GPS_Easting": {
          "format": "double",
          "type": "number"
        },
        "GPS_Northing": {
          "format": "double",
          "type": "number"
        }
      },
      "example": {
        "PropertyNameOrDescription": "string",
        "PhysicalAddressUnit": "string",
        "PhysicalAddressNumber": "string",
        "PhysicalAddressStreet": "string",
        "PhysicalAddressSuburb": "string",
        "PhysicalAddressTown": "string",
        "PhysicalAddressRegion": "string",
        "PhysicalAddressPostCode": 0,
        "GPS_Easting": 0.1778884353872654,
        "GPS_Northing": 0.24947440612677929
      }
    },
    "Network": {
      "type": "object",
      "properties": {
        "NetworkParticipantID": {
          "type": "string"
        },
        "NetworkParticipantName": {
          "type": "string"
        },
        "POC": {
          "type": "string"
        },
        "ReconciliationType": {
          "type": "string"
        },
        "InitialElectricallyConnectedDate": {
          "type": "string"
        },
        "GenerationCapacity": {
          "format": "double",
          "type": "number"
        },
        "FuelType": {
          "type": "string"
        },
        "DirectBilledStatus": {
          "type": "string"
        }
      },
      "example": {
        "NetworkParticipantID": "string",
        "NetworkParticipantName": "string",
        "POC": "string",
        "ReconciliationType": "string",
        "InitialElectricallyConnectedDate": "string",
        "GenerationCapacity": 0.57073710342848116,
        "FuelType": "string",
        "DirectBilledStatus": "string"
      }
    },
    "Pricing": {
      "type": "object",
      "properties": {
        "DistributorPriceCategoryCode": {
          "type": "string"
        },
        "DistributorLossCategoryCode": {
          "type": "string"
        },
        "ChargeableCapacity": {
          "format": "double",
          "type": "number"
        },
        "DistributorInstallationDetails": {
          "type": "string"
        }
      }
    },
    "Trader": {
      "type": "object",
      "properties": {
        "TraderSwitchInProgress": {
          "type": "boolean"
        },
        "TraderParticipantID": {
          "type": "string"
        },
        "TraderParticipantName": {
          "type": "string"
        },
        "ProfileCode": {
          "type": "string"
        },
        "ANZSICcode": {
          "type": "string"
        },
        "DailyUnmeteredkWh": {
          "type": "string"
        },
        "UnmeteredLoadDetails": {
          "type": "string"
        }
      },
      "example": {
        "TraderSwitchInProgress": false,
        "TraderParticipantID": "string",
        "TraderParticipantName": "string",
        "ProfileCode": "string",
        "ANZSICcode": "string",
        "DailyUnmeteredkWh": "string",
        "UnmeteredLoadDetails": "string"
      }
    },
    "Metering": {
      "type": "object",
      "properties": {
        "MeteringEquipmentProviderParticipantID": {
          "type": "string"
        },
        "MeteringEquipmentProviderParticipantName": {
          "type": "string"
        },
        "InstallationInformation": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "MeteringInstallationCategory": {
                "format": "int32",
                "type": "integer"
              },
              "MeteringInstallationType": {
                "type": "string"
              },
              "CertificationExpiryDate": {
                "type": "string"
              },
              "ComponentInformation": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "ComponentType": {
                      "type": "string"
                    },
                    "MeteringComponentSerialNumber": {
                      "type": "string"
                    },
                    "MeterType": {
                      "type": "string"
                    },
                    "AMIFlag": {
                      "type": "boolean"
                    },
                    "CompensationFactor": {
                      "format": "double",
                      "type": "number"
                    },
                    "ChannelInformation": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "MeteringComponentSerialNumber": {
                            "type": "string"
                          },
                          "ChannelNumber": {
                            "format": "int32",
                            "type": "integer"
                          },
                          "RegisterContentCode": {
                            "type": "string"
                          },
                          "PeriodOfAvailability": {
                            "type": "string"
                          },
                          "UnitOfMeasurement": {
                            "type": "string"
                          },
                          "EnergyFlowDirection": {
                            "type": "string"
                          },
                          "AccumulatorType": {
                            "type": "string"
                          },
                          "SwitchReadIndicator": {
                            "type": "boolean"
                          }
                        },
                        "example": {
                          "MeteringComponentSerialNumber": "string",
                          "ChannelNumber": 0,
                          "RegisterContentCode": "string",
                          "PeriodOfAvailability": "string",
                          "UnitOfMeasurement": "string",
                          "EnergyFlowDirection": "string",
                          "AccumulatorType": "string",
                          "SwitchReadIndicator": false
                        }
                      }
                    }
                  },
                  "example": {
                    "ComponentType": "string",
                    "MeteringComponentSerialNumber": "string",
                    "MeterType": "string",
                    "AMIFlag": false,
                    "CompensationFactor": 0.25155401565176239,
                    "ChannelInformation": [
                      {
                        "MeteringComponentSerialNumber": "string",
                        "ChannelNumber": 0,
                        "RegisterContentCode": "string",
                        "PeriodOfAvailability": "string",
                        "UnitOfMeasurement": "string",
                        "EnergyFlowDirection": "string",
                        "AccumulatorType": "string"
                      }
                    ]
                  }
                }
              }
            },
            "example": {
              "MeteringInstallationCategory": 0,
              "MeteringInstallationType": "string",
              "CertificationExpiryDate": "string",
              "ComponentInformation": [
                {
                  "ComponentType": "string",
                  "MeteringComponentSerialNumber": "string",
                  "MeterType": "string",
                  "AMIFlag": false,
                  "CompensationFactor": 0.30470565157413709,
                  "ChannelInformation": [
                    {
                      "MeteringComponentSerialNumber": "string",
                      "ChannelNumber": 0,
                      "RegisterContentCode": "string",
                      "PeriodOfAvailability": "string",
                      "UnitOfMeasurement": "string",
                      "EnergyFlowDirection": "string",
                      "AccumulatorType": "string"
                    }
                  ]
                }
              ]
            }
          }
        }
      },
      "example": {
        "MeteringEquipmentProviderParticipantID": "string",
        "MeteringEquipmentProviderParticipantName": "string",
        "InstallationInformation": [
          {
            "MeteringInstallationCategory": 0,
            "MeteringInstallationType": "string",
            "CertificationExpiryDate": "string",
            "ComponentInformation": [
              {
                "ComponentType": "string",
                "MeteringComponentSerialNumber": "string",
                "MeterType": "string",
                "AMIFlag": false,
                "CompensationFactor": 0.070918096825621335,
                "ChannelInformation": [
                  {
                    "MeteringComponentSerialNumber": "string",
                    "ChannelNumber": 0,
                    "RegisterContentCode": "string",
                    "PeriodOfAvailability": "string",
                    "UnitOfMeasurement": "string",
                    "EnergyFlowDirection": "string",
                    "AccumulatorType": "string",
                    "SwitchReadIndicator": false
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "Messages": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "example": {
    "ICPIdentifier": "string",
    "ICPStatus": 0,
    "Address": {
      "PropertyNameOrDescription": "string",
      "PhysicalAddressStreet": "string",
      "PhysicalAddressSuburb": "string",
      "PhysicalAddressTown": "string",
      "PhysicalAddressRegion": "string",
      "PhysicalAddressPostCode": 0,
      "GPS_Easting": 0.086597829994870867,
      "GPS_Northing": 0.089592538769447838
    },
    "Network": {
      "NetworkParticipantID": "string",
      "NetworkParticipantName": "string",
      "POC": "string",
      "ReconciliationType": "string",
      "InitialElectricallyConnectedDate": "string",
      "GenerationCapacity": 0.59222133055867521,
      "FuelType": "string",
      "DirectBilledStatus": "string"
    },
    "Pricing": {
      "DistributorPriceCategoryCode": "string",
      "DistributorLossCategoryCode": "string",
      "ChargeableCapacity": 0.74166837179270262,
      "DistributorInstallationDetails": "string"
    },
    "Trader": {
      "TraderSwitchInProgress": false,
      "TraderParticipantID": "string",
      "TraderParticipantName": "string",
      "ProfileCode": "string",
      "ANZSICcode": "string",
      "DailyUnmeteredkWh": "string",
      "UnmeteredLoadDetails": "string"
    },
    "Metering": {
      "MeteringEquipmentProviderParticipantID": "string",
      "MeteringEquipmentProviderParticipantName": "string",
      "InstallationInformation": [
        {
          "MeteringInstallationCategory": 0,
          "MeteringInstallationType": "string",
          "CertificationExpiryDate": "string",
          "ComponentInformation": [
            {
              "ComponentType": "string",
              "MeteringComponentSerialNumber": "string",
              "MeterType": "string",
              "AMIFlag": false,
              "CompensationFactor": 0.68670529385750934,
              "ChannelInformation": [
                {
                  "MeteringComponentSerialNumber": "string",
                  "ChannelNumber": 0,
                  "RegisterContentCode": "string",
                  "PeriodOfAvailability": "string",
                  "UnitOfMeasurement": "string",
                  "EnergyFlowDirection": "string",
                  "AccumulatorType": "string",
                  "SwitchReadIndicator": false
                }
              ]
            }
          ]
        }
      ]
    },
    "RegistryMessages": [
      "string"
    ]
  }
}

429 Too many requests

The management policy has been exceeded on the API. See the EMI API website for policy details.

Representations

{
  "Message": "string"
}
{
  "type": "object",
  "properties": {
    "Message": {
      "type": "string"
    }
  },
  "example": {
    "Message": "string"
  }
}

503 Service Unavailable

Problems connecting to underlying service

Representations

{
  "Message": "string"
}
{
  "type": "object",
  "properties": {
    "Message": {
      "type": "string"
    }
  },
  "example": {
    "Message": "string"
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://emi.azure-api.net/ICPConnectionData/v2/single/?ICP={ICP}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://emi.azure-api.net/ICPConnectionData/v2/single/?ICP={ICP}&" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://emi.azure-api.net/ICPConnectionData/v2/single/?ICP={ICP}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://emi.azure-api.net/ICPConnectionData/v2/single/?ICP={ICP}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://emi.azure-api.net/ICPConnectionData/v2/single/?ICP={ICP}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://emi.azure-api.net/ICPConnectionData/v2/single/?ICP={ICP}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('emi.azure-api.net')
    conn.request("GET", "/ICPConnectionData/v2/single/?ICP={ICP}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('emi.azure-api.net')
    conn.request("GET", "/ICPConnectionData/v2/single/?ICP={ICP}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://emi.azure-api.net/ICPConnectionData/v2/single/?ICP={ICP}')

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body