public interface TelcoApi
| Modifier and Type | Method and Description |
|---|---|
org.springframework.http.ResponseEntity<TelcoAccountDetailResponse> |
getAccount(String accountId,
Integer xV,
@Valid String openStatus,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts/{accountId} : Get Telco Account Detail
Obtain detailed information for a specific telco account Other Versions: [v1](includes/obsolete/get-telco-account-detail-v1.html)
|
org.springframework.http.ResponseEntity<TelcoBalanceResponse> |
getBalanceForAccount(String accountId,
Integer xV,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts/{accountId}/balance : Get Balance For Telco Account
Obtain the current balance for a specific account
|
org.springframework.http.ResponseEntity<TelcoConcessionsResponse> |
getConcessions(String accountId,
Integer xV,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts/{accountId}/concessions : Get Telco Concessions
Obtain the details of any concessions or arrangements applied to a specific telco account
|
org.springframework.http.ResponseEntity<TelcoInvoiceListResponse> |
getInvoicesForAccount(String accountId,
Integer xV,
@Valid String newestDate,
@Valid String oldestDate,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts/{accountId}/invoices : Get Invoices For Telco Account
Obtain the invoices for a specific account
|
org.springframework.http.ResponseEntity<TelcoPaymentScheduleResponse> |
getPaymentSchedule(String accountId,
Integer xV,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts/{accountId}/payment-schedule : Get Telco Agreed Payment Schedule
Obtain the agreed payment schedule and details, if any, for a specific telco account.
|
org.springframework.http.ResponseEntity<TelcoProductResponse> |
getProduct(String productId,
Integer xV,
Integer xMinV)
GET /telco/products/{productId} : Get Telco Product Detail
Obtain detailed information on a single telco prouct offered openly to the market
|
org.springframework.http.ResponseEntity<TelcoTransactionListResponse> |
getTransactionsForAccount(String accountId,
Integer xV,
@Valid String newestTime,
@Valid String oldestTime,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts/{accountId}/transactions : Get Transactions For Telco Account
Obtain the billing transactions for a specific account
|
org.springframework.http.ResponseEntity<TelcoServiceUsageResponse> |
getUsageForService(String serviceId,
Integer xV,
@Valid String oldestDate,
@Valid String newestDate,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts/{serviceId}/usage : Get Usage For Telco Service
Obtain a usage data from a particular service Id
|
org.springframework.http.ResponseEntity<TelcoAccountListResponse> |
listAccounts(Integer xV,
@Valid String openStatus,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts : Get Telco Accounts
Obtain the list of telco accounts available under the authorised consent Other Versions: [v1](includes/obsolete/get-telco-accounts-v1.html)
|
org.springframework.http.ResponseEntity<TelcoBalanceListResponse> |
listBalance(Integer xV,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts/balance : Get Bulk Telco Balances
Obtain the current balance for all accounts
|
org.springframework.http.ResponseEntity<TelcoBalanceListResponse> |
listBalancesForAccounts(Integer xV,
@Valid RequestAccountIds accountIdList,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
POST /telco/accounts/balance : Get Balances For Specific Telco Accounts
Obtain the current balance for a specified set of accounts
|
org.springframework.http.ResponseEntity<TelcoTransactionListResponse> |
listBillingForAccounts(Integer xV,
@Valid RequestAccountIds accountIdList,
@Valid String newestTime,
@Valid String oldestTime,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
POST /telco/accounts/transactions : Get Transactions For Specific Telco Accounts
Obtain transactions for a specified set of accounts
|
org.springframework.http.ResponseEntity<TelcoInvoiceListResponse> |
listInvoices(Integer xV,
@Valid String newestDate,
@Valid String oldestDate,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts/invoices : Get Telco Invoices
Obtain the invoices for all accounts
|
org.springframework.http.ResponseEntity<TelcoInvoiceListResponse> |
listInvoicesForAccounts(Integer xV,
@Valid RequestAccountIds accountIdList,
@Valid String newestDate,
@Valid String oldestDate,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
POST /telco/accounts/invoices : Get Invoices For Specific Telco Accounts
Obtain invoices for a specified set of accounts
|
org.springframework.http.ResponseEntity<TelcoProductListResponse> |
listProducts(Integer xV,
@Valid TypeEnum type,
@Valid BillingTypeEnum billingType,
@Valid String effective,
@Valid String updatedSince,
@Valid String brand,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV)
GET /telco/products : Get Telco Products
Obtain a list of telco products that are currently offered to the market.
|
org.springframework.http.ResponseEntity<TelcoTransactionListResponse> |
listTransactions(Integer xV,
@Valid String newestTime,
@Valid String oldestTime,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts/transactions : Get Telco Transactions
Obtain billing transactions for all accounts
|
org.springframework.http.ResponseEntity<TelcoUsageListResponse> |
listUsage(Integer xV,
@Valid String oldestDate,
@Valid String newestDate,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
GET /telco/accounts/usage : Get Usage
Obtain usage data for all services associated with the customer
|
org.springframework.http.ResponseEntity<TelcoServiceUsageListResponse> |
listUsageForService(Integer xV,
@Valid RequestServiceIds serviceIdList,
@Valid String oldestDate,
@Valid String newestDate,
@Valid Integer page,
@Valid Integer pageSize,
Integer xMinV,
UUID xFapiInteractionId,
@NotNull Date xFapiAuthDate,
String xFapiCustomerIpAddress,
String xCdsClientHeaders)
POST /telco/accounts/usage : Get Usage For Specific Telco Service
Obtain usage data for a specific service
|
@RequestMapping(method=GET,
value="/telco/accounts/{accountId}",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoAccountDetailResponse> getAccount(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=true)
Integer xV,
@Valid @RequestParam(value="open-status",required=false,defaultValue="ALL")
@Valid String openStatus,
@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 previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements (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)openStatus - Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed (optional, default to ALL)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]](#nref-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]](#nref-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="/telco/accounts/{accountId}/balance",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoBalanceResponse> getBalanceForAccount(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=true)
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 previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements (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]](#nref-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]](#nref-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="/telco/accounts/{accountId}/concessions",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoConcessionsResponse> getConcessions(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=true)
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 previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements (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]](#nref-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]](#nref-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="/telco/accounts/{accountId}/invoices",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoInvoiceListResponse> getInvoicesForAccount(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=true)
Integer xV,
@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-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 previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements (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 effective 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 effective 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]](#nref-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]](#nref-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="/telco/accounts/{accountId}/payment-schedule",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoPaymentScheduleResponse> getPaymentSchedule(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=true)
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 previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements (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]](#nref-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]](#nref-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="/telco/products/{productId}",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoProductResponse> getProduct(@PathVariable(value="productId")
String productId,
@RequestHeader(value="x-v",required=true)
Integer xV,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV)
productId - ID of the specific product 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="/telco/accounts/{accountId}/transactions",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoTransactionListResponse> getTransactionsForAccount(@PathVariable(value="accountId")
String accountId,
@RequestHeader(value="x-v",required=true)
Integer xV,
@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-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 previously obtained from the Account List end point. In accordance with [CDR ID permanence](#id-permanence) requirements (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]](#nref-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]](#nref-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="/telco/accounts/{serviceId}/usage",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoServiceUsageResponse> getUsageForService(@PathVariable(value="serviceId")
String serviceId,
@RequestHeader(value="x-v",required=true)
Integer xV,
@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-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)
serviceId - ID of the specific service requested such as a mobile [MSISDN](https://www.etsi.org/deliver/etsi_gts/03/0303/05.00.00_60/gsmts_0303v050000p.pdf), [FNN](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf) or internet service e.g [NBN AVC Service ID](https://www.nbnco.com.au/content/dam/nbnco2/documents/sfaa-wba2-dictionary_FTTN-launch.pdf). This is a tokenised ID returned from the account. In accordance with [CDR ID permanence](#id-permanence) requirements (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)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]](#nref-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]](#nref-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="/telco/accounts",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoAccountListResponse> listAccounts(@RequestHeader(value="x-v",required=true)
Integer xV,
@Valid @RequestParam(value="open-status",required=false,defaultValue="ALL")
@Valid String openStatus,
@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)
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)openStatus - Used to filter results according to open/closed status. Values can be OPEN, CLOSED or ALL. If absent then ALL is assumed (optional, default to ALL)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]](#nref-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]](#nref-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="/telco/accounts/balance",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoBalanceListResponse> listBalance(@RequestHeader(value="x-v",required=true)
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)
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]](#nref-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]](#nref-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="/telco/accounts/balance",
produces="application/json",
consumes="application/json")
org.springframework.http.ResponseEntity<TelcoBalanceListResponse> listBalancesForAccounts(@RequestHeader(value="x-v",required=true)
Integer xV,
@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-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)
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]](#nref-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]](#nref-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="/telco/accounts/transactions",
produces="application/json",
consumes="application/json")
org.springframework.http.ResponseEntity<TelcoTransactionListResponse> listBillingForAccounts(@RequestHeader(value="x-v",required=true)
Integer xV,
@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-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)
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]](#nref-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]](#nref-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="/telco/accounts/invoices",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoInvoiceListResponse> listInvoices(@RequestHeader(value="x-v",required=true)
Integer xV,
@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-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)
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 effective 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 effective 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]](#nref-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]](#nref-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="/telco/accounts/invoices",
produces="application/json",
consumes="application/json")
org.springframework.http.ResponseEntity<TelcoInvoiceListResponse> listInvoicesForAccounts(@RequestHeader(value="x-v",required=true)
Integer xV,
@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-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)
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 effective 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 effective 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]](#nref-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]](#nref-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="/telco/products",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoProductListResponse> listProducts(@RequestHeader(value="x-v",required=true)
Integer xV,
@Valid @RequestParam(value="type",required=false,defaultValue="MOBILE")
@Valid TypeEnum type,
@Valid @RequestParam(value="billing-type",required=false,defaultValue="PRE_PAID")
@Valid BillingTypeEnum billingType,
@Valid @RequestParam(value="effective",required=false,defaultValue="CURRENT")
@Valid String effective,
@Valid @RequestParam(value="updated-since",required=false)
@Valid String 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,
@RequestHeader(value="x-min-v",required=false)
Integer xMinV)
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. If absent, defaults to include all products. Valid values are ‘MOBILE’, ‘BROADBAND’ (optional, default to MOBILE)billingType - Used to filter results on the billing-type field. Any one of the valid values for this field can be supplied. If absent, defaults to include all billing types. Valid values are ‘PRE_PAID’, ‘POST_PAID’, 'UPFRONT_PAID', 'OTHER' (optional, default to PRE_PAID)effective - Allows for the filtering of productd 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 products 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 products. For service providers that operate a number of mobile and internet brands (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="/telco/accounts/transactions",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoTransactionListResponse> listTransactions(@RequestHeader(value="x-v",required=true)
Integer xV,
@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-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)
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]](#nref-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]](#nref-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="/telco/accounts/usage",
produces="application/json")
org.springframework.http.ResponseEntity<TelcoUsageListResponse> listUsage(@RequestHeader(value="x-v",required=true)
Integer xV,
@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-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)
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]](#nref-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]](#nref-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="/telco/accounts/usage",
produces="application/json",
consumes="application/json")
org.springframework.http.ResponseEntity<TelcoServiceUsageListResponse> listUsageForService(@RequestHeader(value="x-v",required=true)
Integer xV,
@Valid @RequestBody
@Valid RequestServiceIds serviceIdList,
@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-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)
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)serviceIdList - 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)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]](#nref-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]](#nref-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)Copyright © 2023. All rights reserved.