Create an API call for REMIT flows

build_remit_call(data_item, api_key, event_start = NULL,
  event_end = NULL, publication_from = NULL, publication_to = NULL,
  participant_id = NULL, asset_id = NULL, event_type = NULL,
  fuel_type = NULL, message_type = NULL, message_id = NULL,
  unavailability_type = NULL, active_flag = NULL, sequence_id = NULL,
  service_type = "xml", api_version = "v1")

Arguments

data_item

character string; the id of the REMIT flow

api_key

character string; api key retrieved from the Elexon portal

event_start

character string; event start (automatically cleaned by format_date)

event_end

character string; event end (automatically cleaned by format_date)

publication_from

character string; publication from (automatically cleaned by format_date)

publication_to

character string; publication to (automatically cleaned by format_date)

participant_id

character string; participant id

asset_id

character string; asset id

event_type

character string; event type

fuel_type

character string; fuel type

message_type

character string; message type

message_id

character string; message id

unavailability_type

character string; unavailability type

active_flag

character string; active flag

sequence_id

character string; sequence id

service_type

character string; file format (csv or xml)

api_version

character string; version of the api to use (currently on v1)

Value

list; created url for the call, service type and data item

See also

Other call-building functions: build_b_call, build_call, build_legacy_call

Examples

build_remit_call(data_item = "MessageListRetrieval", api_key = "12345", event_start = "14-12-2016", event_end = "15-12-2016")
#> $url #> [1] "https://api.bmreports.com/BMRS/MessageListRetrieval/v1?APIKey=12345&EventStart=2016-12-14&EventEnd=2016-12-15&ServiceType=xml" #> #> $service_type #> [1] "xml" #> #> $data_item #> [1] "MessageListRetrieval" #>
build_remit_call(data_item = "MessageDetailRetrieval", api_key = "12345", participant_id = 21, service_type = "xml")
#> $url #> [1] "https://api.bmreports.com/BMRS/MessageDetailRetrieval/v1?APIKey=12345&ParticipantID=21&ServiceType=xml" #> #> $service_type #> [1] "xml" #> #> $data_item #> [1] "MessageDetailRetrieval" #>