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
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
  • deviceList
  • 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
  • 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.
  • 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.
  • 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` - Emergency
    Example: X1EC
Nested Schema : deviceList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • 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.
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • deviceList
  • 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
  • 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.
  • 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.
  • 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` - Emergency
    Example: X1EC
Nested Schema : deviceList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • 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.
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : X1_ReserDvc
Type: object
Show Source
  • deviceList
  • 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
  • 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.
  • 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.
  • 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` - Emergency
    Example: X1EC
Nested Schema : deviceList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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.
  • 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.
  • 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
  • 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
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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.
  • problemDetailDocument_serverMessage
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : problemDetailDocument_serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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.
  • problemDetailDocument_serverMessage
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : problemDetailDocument_serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top