Post-Event Update
post
https://server:port/rest/apis/cross/service/programEventParticipation/postEventOutcome
This service creates event participations to post the outcome of a concluded event participation.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : items
Type:
Show Source
object-
errorMessage: string
Maximum Length:
100Optional error message sent when posting an error outcome. -
eventExternalIdentifier: string
Maximum Length:
120Unique identifier of the event from the external application. -
headEndSystem: string
Maximum Length:
50Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome. -
nicId: string
Maximum Length:
100Head end system, along with the NIC Id, 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" ]Device's participation outcome for the event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participationExample:D1SP -
participationEndDateTime: string
(date-time)
Participation start/end date/time will be the device's actual participation period for the event.
-
participationStartDateTime: string
(date-time)
Participation start/end date/time will be the device's actual participation period for the event.
Nested Schema : items
Type:
Show Source
object-
errorMessage: string
Maximum Length:
100Optional error message sent when posting an error outcome. -
eventExternalIdentifier: string
Maximum Length:
120Unique identifier of the event from the external application. -
headEndSystem: string
Maximum Length:
50Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome. -
nicId: string
Maximum Length:
100Head end system, along with the NIC Id, 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" ]Device's participation outcome for the event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participationExample:D1SP -
participationEndDateTime: string
(date-time)
Participation start/end date/time will be the device's actual participation period for the event.
-
participationStartDateTime: string
(date-time)
Participation start/end date/time will be the device's actual participation period for the event.
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : items
Type:
Show Source
object-
errorMessage: string
Maximum Length:
100Optional error message sent when posting an error outcome. -
eventExternalIdentifier: string
Maximum Length:
120Unique identifier of the event from the external application. -
headEndSystem: string
Maximum Length:
50Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome. -
nicId: string
Maximum Length:
100Head end system, along with the NIC Id, 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" ]Device's participation outcome. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participationExample:D1SP -
participationEndDateTime: string
(date-time)
Participation start/end date/time will be the device's actual participation period for the event.
-
participationStartDateTime: string
(date-time)
Participation start/end date/time will be the device's actual participation period for the event.
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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
serverMessage
-
stackTrace: string
Maximum Length:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object-
detail: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0Maximum Value:9999The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60Fully 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:
60URL 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
serverMessage
-
stackTrace: string
Maximum Length:
60The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object-
callSequence: string
Maximum Length:
60Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0Maximum Value:0Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999Maximum Value:99999Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60Name of the program that encountered the error.