CSV API version 2

The CSV API is used for uploading outages to the POCP. For downloading please see the REST API reference.

For a complete definition of each field, please see the XML API Reference.

Authentication

Version 2 authentication for uploading via CSV is done via logging in as an authorised user on the main platform.

CSV upload format

Field # Field name Format
1 Outage ID Anything less than 255 characters long
2 Outage start time YYYY-MM-DD HH:MM:SS or DD/MM/YYYY HH:MM:SS
3 Outage end time YYYY-MM-DD HH:MM:SS or DD/MM/YYYY HH:MM:SS
4 Status TENTATIVE, CONFIRMED, CANCELLED, COMPLETE
5 Asset type GENERATION, TRANSMISSION, DIRECT CONNECTION, DISTRIBUTION, EMBEDDED_GENERATION
6 Recall time HH:MM:SS
7 Coordination Notes Free form, avoid control characters and line feeds
8 Outage block Description of equipment to be removed from service, i.e, NPL_T8, ROX_1. For a station outage the suffix stn is to used, i.e, CYD_stn
9 Outage time type Daily, continuous: State whether the outage is continuous between start and end date and time or whether it will be removed on a daily basis between start and end times
10 Transmission outage nature Empty if not transmission
11 Megawatt output loss Empty, zero or a positive number (decimals permitted)
12 Megawatt output remaining Empty, zero or a positive number (decimals permitted)
13 MVar output remaining Empty, zero or a positive number (decimals permitted)
14 Reason for outage Empty, or a string of arbitrary length
15 Asset Description Empty, or a string of arbitrary length
16 Group Empty, or a string up to 255 characters
17 GIP/GXP Use station code where generation is connected and offered in at or where equipment or load is connected to the system. No bus number required. The station should exist within the master list stored on the POCP
18 Another GIP/GXP As necessary, additional GIP/GXPs can be added in a similar fashion

The following is an example CSV:

"TESTID0001","2003-01-01 09:00:00","2003-01-01 11:00:00","TENTATIVE","GENERATION","02:00:00","Test unit 1","ABC_FO","continuous","","8","20","10","Reason for outage", "A description of the asset", "GROUP-001", "ABC"

Upgrading from Version 1

When upgrading from version 1, the following changes apply:

  • Removed field 7 "Confidential" (remember to adjust your output for the removed field)
  • Field 7 Comments is now Coordination Notes. In practice no change is necessary
  • Field 8 Plant is now Outage block. In practice no change is necessary
  • New field 14, Reason for outage
  • New field 15, Asset Description
  • New field 16, Group ID
  • Additional categories: DISTRIBUTION and EMBEDDED_GENERATION
  • Additional planning status: COMPLETED

Each of the new fields can be empty without issue, so a trivial upgrade to version 2 is possible simply by adding three blank columns after "MVar output remaining".