Get Service Points V1

This page documents version 1 of the Get Service Points endpoint.

Data Holders can retire this version after March 16th 2026. Data Recipients must update to newer versions prior to this date.

Get Service Points

Code samples

GET https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints HTTP/1.1
Host: mtls.dh.example.com
Accept: application/json
x-v: string
x-min-v: string
x-fapi-interaction-id: string
x-fapi-auth-date: string
x-fapi-customer-ip-address: string
x-cds-client-headers: string

const fetch = require('node-fetch');
const headers = {
  'Accept':'application/json',
  'x-v':'string',
  'x-min-v':'string',
  'x-fapi-interaction-id':'string',
  'x-fapi-auth-date':'string',
  'x-fapi-customer-ip-address':'string',
  'x-cds-client-headers':'string'
};

fetch('https://mtls.dh.example.com/cds-au/v1/energy/electricity/servicepoints', {
  method: 'GET',
  headers: headers
}).then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /energy/electricity/servicepoints

Obtain a list of service points owned by the customer that has authorised the current session.

Endpoint Version


Version	1

Parameters

Name	In	Type	Required	Default	Description
page	query	PositiveInteger	optional	`1`	Page of results to request (standard pagination).
page-size	query	PositiveInteger	optional	`25`	Page size to request. Default is 25 (standard pagination).
x-v	header	string	mandatory		Version of the API endpoint requested by the client. Must be set to a positive integer. The endpoint should respond with the highest supported version between x-min-v and x-v. If the value of x-min-v is equal to or higher than the value of x-v then the x-min-v header should be treated as absent. If all versions requested are not supported then the endpoint MUST respond with a `406 Not Acceptable`. See HTTP Headers.
x-min-v	header	string	optional		Minimum version of the API endpoint requested by the client. Must be set to a positive integer if provided. The endpoint should respond with the highest supported version between x-min-v and x-v. If all versions requested are not supported then the endpoint MUST respond with a `406 Not Acceptable`.
x-fapi-interaction-id	header	string	optional		An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
x-fapi-auth-date	header	string	conditional		The time when the customer last logged in to the Data Recipient Software Product as described in [FAPI-1.0-Baseline]. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls.
x-fapi-customer-ip-address	header	string	optional		The customer's original IP address if the customer is currently logged in to the data recipient. The presence of this header indicates that the API is being called in a customer present context. Not to be included for unauthenticated calls.
x-cds-client-headers	header	Base64	conditional		The customer's original standard http headers Base64 encoded, including the original User-Agent header, if the customer is currently logged in to the data recipient. Mandatory for customer present calls. Not required for unattended or unauthenticated calls.

Example responses

200 Response

{
  "data": {
    "servicePoints": [
      {
        "servicePointId": "string",
        "nationalMeteringId": "string",
        "servicePointClassification": "EXTERNAL_PROFILE",
        "servicePointStatus": "ACTIVE",
        "jurisdictionCode": "ALL",
        "isGenerator": false,
        "validFromDate": "string",
        "lastUpdateDateTime": "string",
        "consumerProfile": {
          "classification": "BUSINESS",
          "threshold": "LOW"
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	EnergyServicePointListResponse
400	Bad Request	The following error codes MUST be supported: 400 - Invalid Field 400 - Missing Required Field 400 - Invalid Page Size 400 - Invalid Version	ResponseErrorListV2
406	Not Acceptable	The following error codes MUST be supported: 406 - Unsupported Version	ResponseErrorListV2
422	Unprocessable Entity	The following error codes MUST be supported: 422 - Invalid Page	ResponseErrorListV2

Response Headers

Status	Header	Type	Required	Description
200	x-v	string	mandatory	The payload version that the endpoint has responded with.
200	x-fapi-interaction-id	string	mandatory	An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
400	x-fapi-interaction-id	string	mandatory	An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
406	x-fapi-interaction-id	string	mandatory	An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.
422	x-fapi-interaction-id	string	mandatory	An [RFC4122] UUID used as a correlation id. If provided, the data holder MUST play back this value in the x-fapi-interaction-id response header. If not provided a [RFC4122] UUID value is required to be provided in the response header to track the interaction.

Schemas

EnergyServicePointListResponse

{
  "data": {
    "servicePoints": [
      {
        "servicePointId": "string",
        "nationalMeteringId": "string",
        "servicePointClassification": "EXTERNAL_PROFILE",
        "servicePointStatus": "ACTIVE",
        "jurisdictionCode": "ALL",
        "isGenerator": false,
        "validFromDate": "string",
        "lastUpdateDateTime": "string",
        "consumerProfile": {
          "classification": "BUSINESS",
          "threshold": "LOW"
        }
      }
    ]
  },
  "links": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  },
  "meta": {
    "totalRecords": 0,
    "totalPages": 0
  }
}

Properties

Name	Type	Required	Description
data	object	mandatory	none
» servicePoints	[EnergyServicePoint]	mandatory	none
links	LinksPaginated	mandatory	none
meta	MetaPaginated	mandatory	none

EnergyServicePoint

{
  "servicePointId": "string",
  "nationalMeteringId": "string",
  "servicePointClassification": "EXTERNAL_PROFILE",
  "servicePointStatus": "ACTIVE",
  "jurisdictionCode": "ALL",
  "isGenerator": false,
  "validFromDate": "string",
  "lastUpdateDateTime": "string",
  "consumerProfile": {
    "classification": "BUSINESS",
    "threshold": "LOW"
  }
}

Properties

Name	Type	Required	Default	Description
servicePointId	EnergyServicePointId	mandatory		Unique identifier for the service point.
nationalMeteringId	string	mandatory		The independent ID of the service point, known in the industry as the NMI.
servicePointClassification	Enum	mandatory		The classification of the service point as defined in MSATS procedures.
servicePointStatus	Enum	mandatory		Code used to indicate the status of the service point. Note the details for the enumeration values below: `ACTIVE`: An active, energised, service point `DE_ENERGISED`: The service point exists but is deenergised `EXTINCT`: The service point has been permanently decommissioned `GREENFIELD`: Applies to a service point that has never been energised `OFF_MARKET`: Applies when the service point is no longer settled in the NEM.
jurisdictionCode	Enum	mandatory		Jurisdiction code to which the service point belongs.This code defines the jurisdictional rules which apply to the service point. Note the details of enumeration values below: `ALL`: All Jurisdictions `ACT`: Australian Capital Territory `NEM`: National Electricity Market `NSW`: New South Wales `QLD`: Queensland `SA`: South Australia `TAS`: Tasmania `VIC`: Victoria.
isGenerator	Boolean	optional	`false`	This flag determines whether the energy at this connection point is to be treated as consumer load or as a generating unit (this may include generator auxiliary loads). If absent defaults to `false`. Note: Only applicable for scheduled or semischeduled generators, does not indicate on site generation by consumer.
validFromDate	DateString	mandatory		The latest start date from which the constituent data sets of this service point became valid.
lastUpdateDateTime	DateTimeString	mandatory		The date and time that the information for this service point was modified.
consumerProfile	object	optional		none
» classification	Enum	optional		A code that defines the consumer class as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments.
» threshold	Enum	optional		A code that defines the consumption threshold as defined in the National Energy Retail Regulations, or in overriding Jurisdictional instruments. Note the details of enumeration values below: `LOW`: Consumption is less than the 'lower consumption threshold' as defined in the National Energy Retail Regulations `MEDIUM`: Consumption is equal to or greater than the 'lower consumption threshold', but less than the 'upper consumption threshold', as defined in the National Energy Retail Regulations `HIGH`: Consumption is equal to or greater than the 'upper consumption threshold' as defined in the National Energy Retail Regulations.

Enumerated Values

Property	Value
servicePointClassification	EXTERNAL_PROFILE
servicePointClassification	GENERATOR
servicePointClassification	LARGE
servicePointClassification	SMALL
servicePointClassification	WHOLESALE
servicePointClassification	NON_CONTEST_UNMETERED_LOAD
servicePointClassification	NON_REGISTERED_EMBEDDED_GENERATOR
servicePointClassification	DISTRIBUTION_WHOLESALE
servicePointStatus	ACTIVE
servicePointStatus	DE_ENERGISED
servicePointStatus	EXTINCT
servicePointStatus	GREENFIELD
servicePointStatus	OFF_MARKET
jurisdictionCode	ALL
jurisdictionCode	ACT
jurisdictionCode	NEM
jurisdictionCode	NSW
jurisdictionCode	QLD
jurisdictionCode	SA
jurisdictionCode	TAS
jurisdictionCode	VIC
classification	BUSINESS
classification	RESIDENTIAL
threshold	LOW
threshold	MEDIUM
threshold	HIGH

EnergyServicePointId

"string"

A unique identifier for an Energy service point, generated according to CDR ID Permanence requirements.

Properties

Name	Type	Required	Default	Description
anonymous	ASCIIString	mandatory		A unique identifier for an Energy service point, generated according to CDR ID Permanence requirements.

ResponseErrorListV2

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "meta": {
        "urn": "string"
      }
    }
  ]
}

Properties

Name	Type	Required	Default	Description
errors	[ErrorV2]	mandatory		List of errors.

ErrorV2

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "meta": {
    "urn": "string"
  }
}

Properties

Name	Type	Required	Description
code	string	mandatory	The code of the error encountered. Where the error is specific to the respondent, an application-specific error code, expressed as a string value. If the error is application-specific, the URN code that the specific error extends must be provided in the meta object. Otherwise, the value is the error code URN.
title	string	mandatory	A short, human-readable summary of the problem that MUST NOT change from occurrence to occurrence of the problem represented by the error code.
detail	string	mandatory	A human-readable explanation specific to this occurrence of the problem.
meta	object	conditional	Additional data for customised error codes.
» urn	string	conditional	The CDR error code URN which the application-specific error code extends. Mandatory if the error code is an application-specific error rather than a standardised error code.

LinksPaginated

{
  "self": "string",
  "first": "string",
  "prev": "string",
  "next": "string",
  "last": "string"
}

Properties

Name	Type	Required	Description
self	URIString	mandatory	Fully qualified link that generated the current response document.
first	URIString	conditional	URI to the first page of this set. Mandatory if this response is not the first page.
prev	URIString	conditional	URI to the previous page of this set. Mandatory if this response is not the first page.
next	URIString	conditional	URI to the next page of this set. Mandatory if this response is not the last page.
last	URIString	conditional	URI to the last page of this set. Mandatory if this response is not the last page.

MetaPaginated

{
  "totalRecords": 0,
  "totalPages": 0
}

Properties

Name	Type	Required	Default	Description
totalRecords	NaturalNumber	mandatory		The total number of records in the full set. See pagination.
totalPages	NaturalNumber	mandatory		The total number of pages in the full set. See pagination.