Create Program Event Participation
post
https://server:port/rest/apis/cross/service/programEventParticipation/reserveDevice
This REST web service creates a program event and reserves a list of controllable devices enrolled in the program for the upcoming program event.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
deviceList: array
deviceList
-
eventEndDateTime: string
(date-time)
Event end datetime indicates the scheduled end time for the event received from the external source application such as the Grid Edge Distributed Energy Resource Management System.Example:
10-15-2022 05:00:00PM
-
eventExternalIdentifier: string
Maximum Length:
120
Unique identifier of the event from the external source application such as the Grid Edge Distributed Energy Resource Management System. Each event requires an identifier that is associated with it during the event creation. -
eventStartDateTime: string
(date-time)
Event start datetime indicates the scheduled start time for the event received from the external source application such as the Grid Edge Distributed Energy Resource Management System.
-
eventType: string
Allowed Values:
[ "X1EC", "X1EM" ]
Event type is defined in the external source application such as the Grid Edge Distributed Energy Resource Management System during creation of a demand response event. * `X1EC` - Economic, * `X1EM` - EmergencyExample:X1EC
Nested Schema : items
Type:
Show Source
object
-
headEndSystem: string
Maximum Length:
50
Head end system, along with the Network Interface Card identifier, is used to uniquely identify the device to reserve for the event or to post event outcome. -
nicId: string
Maximum Length:
100
Head end system, along with the Network Interface Card identifier, is used to uniquely identify the device to reserve for the event or to post event outcome. -
reservationEndDateTime: string
(date-time)
Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime.
-
reservationStartDateTime: string
(date-time)
Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime.
Root Schema : schema
Type:
Show Source
object
-
deviceList: array
deviceList
-
eventEndDateTime: string
(date-time)
Event end datetime indicates the scheduled end time for the event received from the external source application such as the Grid Edge Distributed Energy Resource Management System.Example:
10-15-2022 05:00:00PM
-
eventExternalIdentifier: string
Maximum Length:
120
Unique identifier of the event from the external source application such as the Grid Edge Distributed Energy Resource Management System. Each event requires an identifier that is associated with it during the event creation. -
eventStartDateTime: string
(date-time)
Event start datetime indicates the scheduled start time for the event received from the external source application such as the Grid Edge Distributed Energy Resource Management System.
-
eventType: string
Allowed Values:
[ "X1EC", "X1EM" ]
Event type is defined in the external source application such as the Grid Edge Distributed Energy Resource Management System during creation of a demand response event. * `X1EC` - Economic, * `X1EM` - EmergencyExample:X1EC
Nested Schema : items
Type:
Show Source
object
-
headEndSystem: string
Maximum Length:
50
Head end system, along with the Network Interface Card identifier, is used to uniquely identify the device to reserve for the event or to post event outcome. -
nicId: string
Maximum Length:
100
Head end system, along with the Network Interface Card identifier, is used to uniquely identify the device to reserve for the event or to post event outcome. -
reservationEndDateTime: string
(date-time)
Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime.
-
reservationStartDateTime: string
(date-time)
Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime.
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1_ReserDvc
Type:
Show Source
object
-
deviceList: array
deviceList
-
eventEndDateTime: string
(date-time)
Event end datetime indicates the scheduled end time for the event received from the external source application such as the Grid Edge Distributed Energy Resource Management System.Example:
10-15-2022 05:00:00PM
-
eventExternalIdentifier: string
Maximum Length:
120
Unique identifier of the event from the external source application such as the Grid Edge Distributed Energy Resource Management System. Each event requires an identifier that is associated with it during the event creation. -
eventStartDateTime: string
(date-time)
Event start datetime indicates the scheduled start time for the event received from the external source application such as the Grid Edge Distributed Energy Resource Management System.
-
eventType: string
Allowed Values:
[ "X1EC", "X1EM" ]
Event type is defined in the external source application such as the Grid Edge Distributed Energy Resource Management System during creation of a demand response event. * `X1EC` - Economic, * `X1EM` - EmergencyExample:X1EC
Nested Schema : items
Type:
Show Source
object
-
headEndSystem: string
Maximum Length:
50
Head end system, along with the Network Interface Card identifier, is used to uniquely identify the device to reserve for the event or to post event outcome. -
nicId: string
Maximum Length:
100
Head end system, along with the Network Interface Card identifier, is used to uniquely identify the device to reserve for the event or to post event outcome. -
reservationEndDateTime: string
(date-time)
Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime
-
reservationStartDateTime: string
(date-time)
Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
problemDetailDocument_serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : problemDetailDocument_serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
problemDetailDocument_serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : problemDetailDocument_serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.