v1
latestOpenAPI 3.1.02026-07-2694207444.7 KBGet Messages
Returns a paged list of messages
Query parameters
Possible values are: ProductionUnavailability, ConsumptionUnavailability, TransmissionUnavailability, OtherUnavailability, MarketInformation
Possible values are: Active, Dismissed
Use values returned from Unavailability Types, e.g. Planned, Unplanned
ISO 8601 Date Format using UTC (Zulu) time
ISO 8601 Date Format using UTC (Zulu) time
ISO 8601 Date Format using UTC (Zulu) time. For "Other market information" messages it uses the eventStart from the message root, otherwise it uses the capacity time series intervals. This is done since a message could apply to multiple non-contiguous intervals.
ISO 8601 Date Format using UTC (Zulu) time. For "Other market information" messages it uses the eventStart from the message root, otherwise it uses the capacity time series intervals. This is done since a message could apply to multiple non-contiguous intervals.
Use values from the Areas lookup
Use values from Market Participants lookup
Use values from Stations lookup
Use values from Connections lookup
Use valid Company IDs
Use values from Fuel Types
Text to search inside UnavailabilityReason and Remarks fields of message
Number of result records to skip (use for paging)
Maximum number of results to return
Leave blank or PublicationDate
Use ASC or DESC
Can be used to include outdated message versions in the response
Response
200
Example response
{
"items": [
{
"messageType": 2,
"unavailabilityType": 1,
"reasonCode": 1,
"unavailabilityReason": "Fire",
"consumptionUnits": [
{
"name": "Holmen Hallsta / Paper Mill",
"eic": "46WCU0000000003N",
"areaEic": "10Y1001A1001A46L",
"areaName": "SE3",
"installedCapacity": 230,
"timePeriods": [
{
"unavailableCapacity": 130,
"availableCapacity": 100,
"eventStart": "2017-04-18T17:40:00Z",
"eventStop": "2017-04-19T07:00:00Z"
}
]
}
],
"marketParticipants": [
{
"name": "Holmen Energi AB",
"code": "A0003865J.SE",
"acerCode": "A0003865J.SE"
}
],
"eventStatus": 1,
"messageId": "87fab39b-6834-42db-811b-a7aa5454d3d0",
"version": 1,
"publicationDate": "2017-04-18T17:40:50.588239Z",
"publisherId": "N00563",
"publisherName": "Scandem AB"
}
],
"total": 19657
}