Update Post Event Outcome

post

https://server:port/rest/apis/cross/service/programEventParticipation/postEventOutcome

This REST web service updates the device outcome of a concluded 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
Nested Schema : postOutcomeList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 100
    Optional error message sent when posting an error outcome, which includes all outcomes other than D1SP.
  • 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.
  • Allowed Values: [ "D1CN", "D1ER", "D1IO", "D1ND", "D1SP" ]
    Status options explaining a device's participation outcome in an event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive devise, * `D1SP` - Successful participation
    Example: D1SP
  • Participation end datetime is the end of a device's participation period for the event.
  • Participation start datetime is the beginning of a device's participation period for the event.
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : postOutcomeList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 100
    Optional error message sent when posting an error outcome, which includes all outcomes other than D1SP.
  • 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.
  • Allowed Values: [ "D1CN", "D1ER", "D1IO", "D1ND", "D1SP" ]
    Status options explaining a device's participation outcome in an event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive devise, * `D1SP` - Successful participation
    Example: D1SP
  • Participation end datetime is the end of a device's participation period for the event.
  • Participation start datetime is the beginning of a device's participation period for the event.
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : X1_PstEvtOut
Type: object
Show Source
Nested Schema : postOutcomeList
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 100
    Optional error message sent when posting an error outcome, which includes all outcomes other than D1SP.
  • 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.
  • Allowed Values: [ "D1CN", "D1ER", "D1IO", "D1ND", "D1SP" ]
    Status options explaining a device's participation outcome in the event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive devise, * `D1SP` - Successful participation
    Example: D1SP
  • Participation end datetime is the end of a device's participation period for the event.
  • Participation start datetime is the beginning of a device's participation period for the event.

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