{ "opencollection": "1.0.0", "info": { "name": "CDR Energy API", "version": "1.36.0" }, "items": [ { "info": { "name": "Energy Accounts", "type": "folder" }, "items": [ { "info": { "name": "Get Energy Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/accounts", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "open-status", "value": "", "type": "query", "description": "Used to filter results according to open/closed status. Values can be `OPEN`, `CLOSED` or `ALL`. If absent then `ALL` is assumed." }, { "name": "page", "value": "", "type": "query", "description": "Page of results to request (standard pagination)." }, { "name": "page-size", "value": "", "type": "query", "description": "Page size to request. Default is 25 (standard pagination)." } ] }, "docs": "Obtain the list of energy accounts available under the authorised consent.\n\nOther Versions: [v1](includes/obsolete/get-energy-accounts-v1.html)." }, { "info": { "name": "Get Energy Account Detail", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/accounts/:accountId", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints." } ] }, "docs": "Obtain detailed information for a specific energy account.\n\nOther Versions: [v1](includes/obsolete/get-energy-account-detail-v1.html), [v2](includes/obsolete/get-energy-account-detail-v2.html), [v3](includes/obsolete/get-energy-account-detail-v3.html)." }, { "info": { "name": "Get Concessions", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/accounts/:accountId/concessions", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints." } ] }, "docs": "Obtain the details of any concessions or arrangements applied to a specific energy account." }, { "info": { "name": "Get Agreed Payment Schedule", "type": "http" }, "http": { "method": "GET", "url": "https://mtls.dh.example.com/cds-au/v1/energy/accounts/:accountId/payment-schedule", "headers": [ { "name": "x-v", "value": "" }, { "name": "x-min-v", "value": "" }, { "name": "x-fapi-interaction-id", "value": "" }, { "name": "x-fapi-auth-date", "value": "" }, { "name": "x-fapi-customer-ip-address", "value": "" }, { "name": "x-cds-client-headers", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The _accountId_ to obtain data for. _accountId_ values are returned by account list endpoints." } ] }, "docs": "Obtain the agreed payment schedule and details, if any, for a specific energy account.\n\nSome general notes about this endpoint:\n\n