Retrieve a location status

Authorizations

Authorization

string

header

required

Authenticate with bearer_token you obtained from /login endpoint.

Path Parameters

string

required

FlatPeak location_id

Response

200 - application/json

account_id

string

required

FlatPeak account ID.

string

required

FlatPeak unique location Id

live_mode

boolean

default:

true

required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

object

string

required

Represents the object’s type. I.e. location_status.

time_created

string

required

Indicates time when this location was created.

tariff_status

object

Tariff status object.

tariff_status.commodity_export

object

Status of commodity export tariff.

tariff_status.commodity_export.connection_type

string

Represents tariff connection type. Set automatically by FlatPeak depending on how tariff was created.

tariff_status.commodity_export.provider

object

Information about the provider of the tariff element.

tariff_status.commodity_export.provider.display_name

string

Provider display name.

tariff_status.commodity_export.provider.id

string

FlatPeak ID of the provider this tariff belongs to.

tariff_status.commodity_export.provider.logo_url

string

Image URL for the logo of the provider.

tariff_status.commodity_export.status

string

Status of tariff element. Possible values are CONNECTED, NOT_CONNECTED or ERROR.

tariff_status.commodity_export.tariff

object

Information about the the tariff element.

tariff_status.commodity_export.tariff.contract_end_date

string

Indicates end date of the energy supply contract between customer and provider.

tariff_status.commodity_export.tariff.display_name

string

Tariff display name.

tariff_status.commodity_export.tariff.id

string

Unique tariff element ID.

tariff_status.commodity_export.tariff.structure_type

string

FIXED - a flat rate tariff; TIME_OF_DAY - a tariff that varies based on specific times of day or other cyclical factors (e.g., day of the week, month, or season); MARKET - a tariff based on the market rate; DYNAMIC - a continuously changing tariff that is not directly tied to the market rate.

tariff_status.commodity_import

object

Status of commodity import tariff.

tariff_status.commodity_import.connection_type

string

Represents tariff connection type. Set automatically by FlatPeak depending on how tariff was created.

tariff_status.commodity_import.provider

object

Information about the provider of the tariff element.

tariff_status.commodity_import.provider.display_name

string

Provider display name.

tariff_status.commodity_import.provider.id

string

FlatPeak ID of the provider this tariff belongs to.

tariff_status.commodity_import.provider.logo_url

string

Image URL for the logo of the provider.

tariff_status.commodity_import.status

string

Status of tariff element. Possible values are CONNECTED, NOT_CONNECTED or ERROR.

tariff_status.commodity_import.tariff

object

Information about the the tariff element.

tariff_status.commodity_import.tariff.contract_end_date

string

Indicates end date of the energy supply contract between customer and provider.

tariff_status.commodity_import.tariff.display_name

string

Tariff display name.

tariff_status.commodity_import.tariff.id

string

Unique tariff element ID.

tariff_status.commodity_import.tariff.structure_type

string

tariff_status.local

object

Status of local generation tariff which is in beta.

tariff_status.local.status

string

Status of tariff element which is currently NOT_SUPPORTED.

tariff_status.non_commodity_export

object

Status of non commodity export tariff which is disabled as there are no known cases of this tariff type.

tariff_status.non_commodity_export.status

string

Status of tariff element which is currently NOT_SUPPORTED.

tariff_status.non_commodity_import

object

Status of non commodity import tariff.

tariff_status.non_commodity_import.connection_type

string

Represents tariff connection type. Set automatically by FlatPeak depending on how tariff was created.

tariff_status.non_commodity_import.provider

object

Information about the provider of the tariff element.

tariff_status.non_commodity_import.provider.display_name

string

Provider display name.

tariff_status.non_commodity_import.provider.id

string

FlatPeak ID of the provider this tariff belongs to.

tariff_status.non_commodity_import.provider.logo_url

string

Image URL for the logo of the provider.

tariff_status.non_commodity_import.status

string

Status of tariff element. Possible values are CONNECTED, NOT_CONNECTED or ERROR.

tariff_status.non_commodity_import.tariff

object

Information about the the tariff element.

tariff_status.non_commodity_import.tariff.contract_end_date

string

Indicates end date of the energy supply contract between customer and provider.

tariff_status.non_commodity_import.tariff.display_name

string

Tariff display name.

tariff_status.non_commodity_import.tariff.id

string

Unique tariff element ID.

tariff_status.non_commodity_import.tariff.structure_type

string

Service objects

Reporting

Planning

Retrieve a location status

Authorizations

Path Parameters

Response