public interface EnergyApi
| Modifier and Type | Method and Description |
|---|---|
org.springframework.http.ResponseEntity<EnergyAccountDetailResponse> |
getAccount(String accountId,
Integer xV,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/accounts/{accountId} : Get Energy Account Detail
Obtain detailed information for a specific energy account
|
org.springframework.http.ResponseEntity<EnergyBalanceResponse> |
getBalanceForAccount(String accountId,
Integer xV,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/accounts/{accountId}/balance : Get Balance For Energy Account
Obtain the current balance for a specific account
|
org.springframework.http.ResponseEntity<EnergyBillingListResponse> |
getBillingForAccount(String accountId,
Integer xV,
Integer xMinV,
@Valid String newestTime,
@Valid String oldestTime,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/accounts/{accountId}/billing : Get Billing For Account
Obtain the billing transactions for a specific account
|
org.springframework.http.ResponseEntity<EnergyConcessionsResponse> |
getConcessions(String accountId,
Integer xV,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/accounts/{accountId}/concessions : Get Concessions
Obtain the details of any concessions or arrangements applied to a specific energy account
|
org.springframework.http.ResponseEntity<EnergyDerDetailResponse> |
getDERForServicePoint(String servicePointId,
Integer xV,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/electricity/servicepoints/{servicePointId}/der : Get DER For Service Point
Obtain a list of DER data from a particular service point
|
org.springframework.http.ResponseEntity<EnergyInvoiceListResponse> |
getInvoicesForAccount(String accountId,
Integer xV,
Integer xMinV,
@Valid String newestDate,
@Valid String oldestDate,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/accounts/{accountId}/invoices : Get Invoices For Account
Obtain the invoices for a specific account
|
org.springframework.http.ResponseEntity<EnergyPaymentScheduleResponse> |
getPaymentSchedule(String accountId,
Integer xV,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/accounts/{accountId}/payment-schedule : Get Agreed Payment Schedule
Obtain the agreed payment schedule and details, if any, for a specific energy account.
|
org.springframework.http.ResponseEntity<EnergyPlanResponse> |
getPlan(String planId,
Integer xV,
Integer xMinV)
GET /energy/plans/{planId} : Get Generic Plan Detail
Obtain detailed information on a single energy plan offered openly to the market
|
org.springframework.http.ResponseEntity<EnergyServicePointDetailResponse> |
getServicePoint(String servicePointId,
Integer xV,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/electricity/servicepoints/{servicePointId} : Get Service Point Detail
Obtain detailed standing information for a specific service point that is owned by the customer that has authorised the current session
|
org.springframework.http.ResponseEntity<EnergyUsageListResponse> |
getUsageForServicePoint(String servicePointId,
Integer xV,
Integer xMinV,
@Valid String oldestDate,
@Valid String newestDate,
@Valid ParamIntervalReadsEnum intervalReads,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/electricity/servicepoints/{servicePointId}/usage : Get Usage For Service Point
Obtain a list of electricity usage data from a particular service point
|
org.springframework.http.ResponseEntity<EnergyAccountListResponse> |
listAccounts(ParamAccountOpenStatus openStatus,
Integer xV,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/accounts : Get Energy Accounts
Obtain the list of energy accounts available under the authorised consent
|
org.springframework.http.ResponseEntity<EnergyBalanceListResponse> |
listBalancesBulk(Integer xV,
Integer xMinV,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/accounts/balances : Get Bulk Balances for Energy
Obtain the current balance for all accounts
|
org.springframework.http.ResponseEntity<EnergyBalanceListResponse> |
listBalancesForAccounts(Integer xV,
Integer xMinV,
@Valid RequestAccountIds accountIdList,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
POST /energy/accounts/balances : Get Balances For Specific Energy Accounts
Obtain the current balance for a specified set of accounts
|
org.springframework.http.ResponseEntity<EnergyBillingListResponse> |
listBillingBulk(Integer xV,
Integer xMinV,
@Valid String newestTime,
@Valid String oldestTime,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/accounts/billing : Get Bulk Billing
Obtain billing transactions for all accounts
|
org.springframework.http.ResponseEntity<EnergyBillingListResponse> |
listBillingForAccounts(Integer xV,
Integer xMinV,
@Valid RequestAccountIds accountIdList,
@Valid String newestTime,
@Valid String oldestTime,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders,
@Valid ParamIntervalReadsEnum intervalReads)
POST /energy/accounts/billing : Get Billing For Specific Accounts
Obtain billing for a specified set of accounts
|
org.springframework.http.ResponseEntity<EnergyDerListResponse> |
listDERBulk(Integer xV,
Integer xMinV,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/electricity/servicepoints/der : Get Bulk DER
Obtain DER data for all service points associated with the customer
|
org.springframework.http.ResponseEntity<EnergyDerListResponse> |
listDERForServicePoints(Integer xV,
Integer xMinV,
@Valid RequestServicePointIds servicePointIdList,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
POST /energy/electricity/servicepoints/der : Get DER For Specific Service Points
Obtain DER data for a specific set of service points
|
org.springframework.http.ResponseEntity<EnergyInvoiceListResponse> |
listInvoicesBulk(Integer xV,
Integer xMinV,
@Valid String newestDate,
@Valid String oldestDate,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/accounts/invoices : Get Bulk Invoices
Obtain the invoices for all accounts
|
org.springframework.http.ResponseEntity<EnergyInvoiceListResponse> |
listInvoicesForAccounts(Integer xV,
Integer xMinV,
@Valid RequestAccountIds accountIdList,
@Valid String newestDate,
@Valid String oldestDate,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
POST /energy/accounts/invoices : Get Invoices For Specific Accounts
Obtain invoices for a specified set of accounts
|
org.springframework.http.ResponseEntity<EnergyPlanListResponse> |
listPlans(Integer xV,
Integer xMinV,
@Valid ParamTypeEnum type,
@Valid ParamFuelTypeEnum fuelType,
@Valid ParamEffective effective,
@Valid java.time.OffsetDateTime updatedSince,
@Valid String brand,
@Valid Integer page,
@Valid Integer pageSize)
GET /energy/plans : Get Generic Plans
Obtain a list of energy plans that are currently offered to the market.
|
org.springframework.http.ResponseEntity<EnergyServicePointListResponse> |
listServicePoints(Integer xV,
Integer xMinV,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /energy/electricity/servicepoints : Get Service Points
Obtain a list of service points owned by the customer that has authorised the current session
|
org.springframework.http.ResponseEntity<EnergyUsageListResponse> |
listUsageBulk(Integer xV,
Integer xMinV,
@Valid String oldestDate,
@Valid String newestDate,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders,
@Valid ParamIntervalReadsEnum intervalReads)
GET /energy/electricity/servicepoints/usage : Get Bulk Usage
Obtain usage data for all service points associated with the customer
|
org.springframework.http.ResponseEntity<EnergyUsageListResponse> |
listUsageForServicePoints(Integer xV,
Integer xMinV,
@Valid RequestServicePointIds servicePointIdList,
@Valid String oldestDate,
@Valid String newestDate,
@Valid Integer page,
@Valid Integer pageSize,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders,
@Valid ParamIntervalReadsEnum intervalReads)
POST /energy/electricity/servicepoints/usage : Get Usage For Specific Service Points
Obtain the electricity usage data for a specific set of service points
|
@RequestMapping(method=GET,
value="/energy/accounts/{accountId}",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:accounts.detail:read\')")
org.springframework.http.ResponseEntity<EnergyAccountDetailResponse> getAccount(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
accountId - ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List end point. (required)xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/accounts/{accountId}/balance",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:billing:read\')")
org.springframework.http.ResponseEntity<EnergyBalanceResponse> getBalanceForAccount(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
accountId - ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List end point. (required)xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/accounts/{accountId}/billing",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:billing:read\')")
org.springframework.http.ResponseEntity<EnergyBillingListResponse> getBillingForAccount(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestParam(value="newest-time",required=false)
@Valid String newestTime,
@Valid @RequestParam(value="oldest-time",required=false)
@Valid String oldestTime,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
accountId - ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List end point. (required)xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)newestTime - Constrain the request to records with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type (optional)oldestTime - Constrain the request to records with effective time at or after this date/time. If absent defaults to newest-time minus 12 months. Format is aligned to DateTimeString common type (optional)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/accounts/{accountId}/concessions",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:accounts.concessions:read\')")
org.springframework.http.ResponseEntity<EnergyConcessionsResponse> getConcessions(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
accountId - ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List end point. (required)xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/electricity/servicepoints/{servicePointId}/der",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:electricity.der:read\')")
org.springframework.http.ResponseEntity<EnergyDerDetailResponse> getDERForServicePoint(@PathVariable(value="servicePointId")
String servicePointId,
@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
servicePointId - ID of the specific service point requested. This is a tokenised ID previous obtained from the Service Point List Data end point. Note that it is not a nationalMeteringId. (required)xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/accounts/{accountId}/invoices",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:billing:read\')")
org.springframework.http.ResponseEntity<EnergyInvoiceListResponse> getInvoicesForAccount(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestParam(value="newest-date",required=false)
@Valid String newestDate,
@Valid @RequestParam(value="oldest-date",required=false)
@Valid String oldestDate,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
accountId - ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List end point. (required)xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)newestDate - Constrain the request to records with issue date at or before this date. If absent defaults to current date. Format is aligned to DateString common type (optional)oldestDate - Constrain the request to records with issue date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type (optional)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/accounts/{accountId}/payment-schedule",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:accounts.paymentschedule:read\')")
org.springframework.http.ResponseEntity<EnergyPaymentScheduleResponse> getPaymentSchedule(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
accountId - ID of a specific account to obtain data for. This is a tokenised ID previous obtained from the Account List end point. (required)xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/plans/{planId}",
produces="application/json")
org.springframework.http.ResponseEntity<EnergyPlanResponse> getPlan(@PathVariable(value="planId")
String planId,
@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV)
planId - ID of the specific plan requested (required)xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)@RequestMapping(method=GET,
value="/energy/electricity/servicepoints/{servicePointId}",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:electricity.servicepoints.detail:read\')")
org.springframework.http.ResponseEntity<EnergyServicePointDetailResponse> getServicePoint(@PathVariable(value="servicePointId")
String servicePointId,
@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
servicePointId - ID of the specific service point requested. This is a tokenised ID previous obtained from the Service Point List Data end point. Note that it is not a nationalMeteringId. (required)xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/electricity/servicepoints/{servicePointId}/usage",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:electricity.usage:read\')")
org.springframework.http.ResponseEntity<EnergyUsageListResponse> getUsageForServicePoint(@PathVariable(value="servicePointId")
String servicePointId,
@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestParam(value="oldest-date",required=false)
@Valid String oldestDate,
@Valid @RequestParam(value="newest-date",required=false)
@Valid String newestDate,
@Valid @RequestParam(value="interval-reads",defaultValue="NONE")
@Valid ParamIntervalReadsEnum intervalReads,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
servicePointId - ID of the specific service point requested. This is a tokenised ID previous obtained from the Service Point List Data end point. Note that it is not a nationalMeteringId. (required)xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)oldestDate - Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type (optional)newestDate - Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type (optional)intervalReads - Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONEpage - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/accounts",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:accounts.basic:read\')")
org.springframework.http.ResponseEntity<EnergyAccountListResponse> listAccounts(@RequestParam(value="open-status",required=false,defaultValue="ALL")
ParamAccountOpenStatus openStatus,
@RequestHeader(value="x-v",required=false)
Integer xV,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
openStatus - Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed (optional)xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/accounts/balances",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:billing:read\')")
org.springframework.http.ResponseEntity<EnergyBalanceListResponse> listBalancesBulk(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=POST,
value="/energy/accounts/balances",
produces="application/json",
consumes="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:billing:read\')")
org.springframework.http.ResponseEntity<EnergyBalanceListResponse> listBalancesForAccounts(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestBody
@Valid RequestAccountIds accountIdList,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)accountIdList - Request payload containing list of specific Accounts to obtain data for (required)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/accounts/billing",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:billing:read\')")
org.springframework.http.ResponseEntity<EnergyBillingListResponse> listBillingBulk(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestParam(value="newest-time",required=false)
@Valid String newestTime,
@Valid @RequestParam(value="oldest-time",required=false)
@Valid String oldestTime,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)newestTime - Constrain the request to records with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type (optional)oldestTime - Constrain the request to records with effective time at or after this date/time. If absent defaults to newest-time minus 12 months. Format is aligned to DateTimeString common type (optional)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=POST,
value="/energy/accounts/billing",
produces="application/json",
consumes="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:billing:read\')")
org.springframework.http.ResponseEntity<EnergyBillingListResponse> listBillingForAccounts(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestBody
@Valid RequestAccountIds accountIdList,
@Valid @RequestParam(value="newest-time",required=false)
@Valid String newestTime,
@Valid @RequestParam(value="oldest-time",required=false)
@Valid String oldestTime,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders,
@Valid @RequestParam(value="interval-reads",defaultValue="NONE")
@Valid ParamIntervalReadsEnum intervalReads)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)accountIdList - Request payload containing list of specific Accounts to obtain data for (required)newestTime - Constrain the request to records with effective time at or before this date/time. If absent defaults to current date/time. Format is aligned to DateTimeString common type (optional)oldestTime - Constrain the request to records with effective time at or after this date/time. If absent defaults to newest-time minus 12 months. Format is aligned to DateTimeString common type (optional)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)intervalReads - Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE@RequestMapping(method=GET,
value="/energy/electricity/servicepoints/der",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:electricity.der:read\')")
org.springframework.http.ResponseEntity<EnergyDerListResponse> listDERBulk(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=POST,
value="/energy/electricity/servicepoints/der",
produces="application/json",
consumes="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:electricity.der:read\')")
org.springframework.http.ResponseEntity<EnergyDerListResponse> listDERForServicePoints(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestBody
@Valid RequestServicePointIds servicePointIdList,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)servicePointIdList - Request payload containing list of specific Service Points to obtain data for (required)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/accounts/invoices",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:billing:read\')")
org.springframework.http.ResponseEntity<EnergyInvoiceListResponse> listInvoicesBulk(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestParam(value="newest-date",required=false)
@Valid String newestDate,
@Valid @RequestParam(value="oldest-date",required=false)
@Valid String oldestDate,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)newestDate - Constrain the request to records with issue date at or before this date. If absent defaults to current date. Format is aligned to DateString common type (optional)oldestDate - Constrain the request to records with issue date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type (optional)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=POST,
value="/energy/accounts/invoices",
produces="application/json",
consumes="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:billing:read\')")
org.springframework.http.ResponseEntity<EnergyInvoiceListResponse> listInvoicesForAccounts(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestBody
@Valid RequestAccountIds accountIdList,
@Valid @RequestParam(value="newest-date",required=false)
@Valid String newestDate,
@Valid @RequestParam(value="oldest-date",required=false)
@Valid String oldestDate,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)accountIdList - Request payload containing list of specific Accounts to obtain data for (required)newestDate - Constrain the request to records with issue date at or before this date. If absent defaults to current date. Format is aligned to DateString common type (optional)oldestDate - Constrain the request to records with issue date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type (optional)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/plans",
produces="application/json")
org.springframework.http.ResponseEntity<EnergyPlanListResponse> listPlans(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestParam(value="type",required=false,defaultValue="ALL")
@Valid ParamTypeEnum type,
@Valid @RequestParam(value="fuelType",required=false,defaultValue="ALL")
@Valid ParamFuelTypeEnum fuelType,
@Valid @RequestParam(value="effective",required=false,defaultValue="CURRENT")
@Valid ParamEffective effective,
@Valid @RequestParam(value="updated-since",required=false) @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@Valid java.time.OffsetDateTime updatedSince,
@Valid @RequestParam(value="brand",required=false)
@Valid String brand,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)type - Used to filter results on the type field. Any one of the valid values for this field can be supplied plus 'ALL'. If absent defaults to 'ALL' (optional, default to ALL)fuelType - Used to filter results on the fuelType field. Any one of the valid values for this field can be supplied plus 'ALL'. If absent defaults to 'ALL' (optional, default to ALL)effective - Allows for the filtering of plans based on whether the current time is within the period of time defined as effective by the effectiveFrom and effectiveTo fields. Valid values are ‘CURRENT’, ‘FUTURE’ and ‘ALL’. If absent defaults to 'CURRENT' (optional, default to CURRENT)updatedSince - Only include plans that have been updated after the specified date and time. If absent defaults to include all plans (optional)brand - Used to filter results on the brand field. If absent defaults to include all plans (optional)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)@RequestMapping(method=GET,
value="/energy/electricity/servicepoints",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:electricity.servicepoints.basic:read\')")
org.springframework.http.ResponseEntity<EnergyServicePointListResponse> listServicePoints(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)@RequestMapping(method=GET,
value="/energy/electricity/servicepoints/usage",
produces="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:electricity.usage:read\')")
org.springframework.http.ResponseEntity<EnergyUsageListResponse> listUsageBulk(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestParam(value="oldest-date",required=false)
@Valid String oldestDate,
@Valid @RequestParam(value="newest-date",required=false)
@Valid String newestDate,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders,
@Valid @RequestParam(value="interval-reads",defaultValue="NONE")
@Valid ParamIntervalReadsEnum intervalReads)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)oldestDate - Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type (optional)newestDate - Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type (optional)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)intervalReads - Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONE@RequestMapping(method=POST,
value="/energy/electricity/servicepoints/usage",
produces="application/json",
consumes="application/json")
@PreAuthorize(value="hasAuthority(\'SCOPE_energy:electricity.usage:read\')")
org.springframework.http.ResponseEntity<EnergyUsageListResponse> listUsageForServicePoints(@RequestHeader(value="x-v",required=false)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV,
@Valid @RequestBody
@Valid RequestServicePointIds servicePointIdList,
@Valid @RequestParam(value="oldest-date",required=false)
@Valid String oldestDate,
@Valid @RequestParam(value="newest-date",required=false)
@Valid String newestDate,
@Valid @RequestParam(value="page",required=false)
@Valid Integer page,
@Valid @RequestParam(value="page-size",required=false)
@Valid Integer pageSize,
@RequestHeader(value="x-fapi-interaction-id",required=false)
UUID xFapiInteractionId,
@RequestHeader(value="x-fapi-auth-date",required=false) @NotNull @DateTimeFormat(iso=DATE_TIME,fallbackPatterns="EEE, dd MMM yyyy HH:mm:ss z")
@NotNull Date xFapiAuthDate,
@RequestHeader(value="x-fapi-customer-ip-address",required=false)
String xFapiCustomerIpAddress,
@RequestHeader(value="x-cds-client-headers",required=false)
String xCdsClientHeaders,
@Valid @RequestParam(value="interval-reads",defaultValue="NONE")
@Valid ParamIntervalReadsEnum intervalReads)
xV - Version of the API end point requested by the client. Must be set to a positive integer. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If the value of [x-min-v](#request-headers) is equal to or higher than the value of [x-v](#request-headers) then the [x-min-v](#request-headers) header should be treated as absent. If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. See [HTTP Headers](#request-headers) (required)xMinV - Minimum version of the API end point requested by the client. Must be set to a positive integer if provided. The data holder should respond with the highest supported version between [x-min-v](#request-headers) and [x-v](#request-headers). If all versions requested are not supported then the data holder must respond with a 406 Not Acceptable. (optional)servicePointIdList - Request payload containing list of specific Service Points to obtain data for (required)oldestDate - Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months. Format is aligned to DateString common type (optional)newestDate - Constrain the request to records with effective date at or before this date. If absent defaults to current date. Format is aligned to DateString common type (optional)page - Page of results to request (standard pagination) (optional)pageSize - Page size to request. Default is 25 (standard pagination) (optional)xFapiInteractionId - An [RFC4122](https://tools.ietf.org/html/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. (optional)xFapiAuthDate - The time when the customer last logged in to the Data Recipient Software Product as described in **[[FAPI-R-Draft]](#nref-FAPI-R-Draft)**. Required for all resource calls (customer present and unattended). Not required for unauthenticated calls. (optional)xFapiCustomerIpAddress - 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. (optional)xCdsClientHeaders - The customer's original standard http headers [Base64](#common-field-types) 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. (optional)intervalReads - Type of interval reads. Any one of the valid values for this field can be supplied. If absent defaults to NONECopyright © 2023. All rights reserved.