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
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
eventExternalIdentifier: string
Maximum Length:
120
Unique identifier of the event from the external application, which must match the ID for the event that is being updated. -
postOutcomeList: array
postOutcomeList
Nested Schema : items
Type:
Show Source
object
-
errorMessage: string
Maximum Length:
100
Optional error message sent when posting an error outcome, which includes all outcomes other than D1SP. -
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. -
outcome: string
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 participationExample:D1SP
-
participationEndDateTime: string
(date-time)
Participation end datetime is the end of a device's participation period for the event.
-
participationStartDateTime: string
(date-time)
Participation start datetime is the beginning of a device's participation period for the event.
Root Schema : schema
Type:
Show Source
object
-
eventExternalIdentifier: string
Maximum Length:
120
Unique identifier of the event from the external application, which must match the ID for the event that is being updated. -
postOutcomeList: array
postOutcomeList
Nested Schema : items
Type:
Show Source
object
-
errorMessage: string
Maximum Length:
100
Optional error message sent when posting an error outcome, which includes all outcomes other than D1SP. -
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. -
outcome: string
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 participationExample:D1SP
-
participationEndDateTime: string
(date-time)
Participation end datetime is the end of a device's participation period for the event.
-
participationStartDateTime: string
(date-time)
Participation start datetime is the beginning of a device's participation period for the event.
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : X1_PstEvtOut
Type:
Show Source
object
-
eventExternalIdentifier: string
Maximum Length:
120
Unique identifier of the event from the external application. -
postOutcomeList: array
postOutcomeList
Nested Schema : items
Type:
Show Source
object
-
errorMessage: string
Maximum Length:
100
Optional error message sent when posting an error outcome, which includes all outcomes other than D1SP. -
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. -
outcome: string
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 participationExample:D1SP
-
participationEndDateTime: string
(date-time)
Participation end datetime is the end of a device's participation period for the event.
-
participationStartDateTime: string
(date-time)
Participation start datetime is the beginning of a device's participation period for the event.
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.