Jump to

• Request
• Response

Post Event Outcome

post

/rest/apis/cross/service/programEventParticipation/postEventOutcome

This operation posts the outcome of a concluded program event participation.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• postOutcomeList: array postOutcomeList

{
    "type":"object",
    "properties":{
        "postOutcomeList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventExternalIdentifier":{
                        "type":"string",
                        "maxLength":120,
                        "description":"Unique identifier of the event from the external application."
                    },
                    "nicId":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
                    },
                    "headEndSystem":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
                    },
                    "participationStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Participation start/end date/time will be the device's actual participation period for the event."
                    },
                    "participationEndDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Participation start/end date/time will be the device's actual participation period for the event."
                    },
                    "outcome":{
                        "type":"string",
                        "enum":[
                            "D1CN",
                            "D1ER",
                            "D1IO",
                            "D1ND",
                            "D1SP"
                        ],
                        "description":"Device's participation outcome for the event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participation\n* `D1CN` - Cancelled,\n* `D1ER` - Error,\n* `D1IO` - In-flight override,\n* `D1ND` - Non-responsive device,\n* `D1SP` - Successful participation",
                        "example":"D1SP"
                    },
                    "errorMessage":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Optional error message sent when posting an error outcome."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1_PstEvtOut"
    }
}

Nested Schema : postOutcomeList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventExternalIdentifier":{
                "type":"string",
                "maxLength":120,
                "description":"Unique identifier of the event from the external application."
            },
            "nicId":{
                "type":"string",
                "maxLength":100,
                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
            },
            "headEndSystem":{
                "type":"string",
                "maxLength":50,
                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
            },
            "participationStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Participation start/end date/time will be the device's actual participation period for the event."
            },
            "participationEndDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Participation start/end date/time will be the device's actual participation period for the event."
            },
            "outcome":{
                "type":"string",
                "enum":[
                    "D1CN",
                    "D1ER",
                    "D1IO",
                    "D1ND",
                    "D1SP"
                ],
                "description":"Device's participation outcome for the event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participation\n* `D1CN` - Cancelled,\n* `D1ER` - Error,\n* `D1IO` - In-flight override,\n* `D1ND` - Non-responsive device,\n* `D1SP` - Successful participation",
                "example":"D1SP"
            },
            "errorMessage":{
                "type":"string",
                "maxLength":100,
                "description":"Optional error message sent when posting an error outcome."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• errorMessage: string
  Maximum Length: 100

  Optional error message sent when posting an error outcome.
• eventExternalIdentifier: string
  Maximum Length: 120

  Unique identifier of the event from the external application.
• headEndSystem: string
  Maximum Length: 50

  Head 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: 100

  Head 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 participation * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participation

  Example: 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.

{
    "type":"object",
    "properties":{
        "eventExternalIdentifier":{
            "type":"string",
            "maxLength":120,
            "description":"Unique identifier of the event from the external application."
        },
        "nicId":{
            "type":"string",
            "maxLength":100,
            "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
        },
        "headEndSystem":{
            "type":"string",
            "maxLength":50,
            "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
        },
        "participationStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Participation start/end date/time will be the device's actual participation period for the event."
        },
        "participationEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Participation start/end date/time will be the device's actual participation period for the event."
        },
        "outcome":{
            "type":"string",
            "enum":[
                "D1CN",
                "D1ER",
                "D1IO",
                "D1ND",
                "D1SP"
            ],
            "description":"Device's participation outcome for the event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participation\n* `D1CN` - Cancelled,\n* `D1ER` - Error,\n* `D1IO` - In-flight override,\n* `D1ND` - Non-responsive device,\n* `D1SP` - Successful participation",
            "example":"D1SP"
        },
        "errorMessage":{
            "type":"string",
            "maxLength":100,
            "description":"Optional error message sent when posting an error outcome."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• postOutcomeList: array postOutcomeList

{
    "type":"object",
    "properties":{
        "postOutcomeList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventExternalIdentifier":{
                        "type":"string",
                        "maxLength":120,
                        "description":"Unique identifier of the event from the external application."
                    },
                    "nicId":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
                    },
                    "headEndSystem":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
                    },
                    "participationStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Participation start/end date/time will be the device's actual participation period for the event."
                    },
                    "participationEndDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Participation start/end date/time will be the device's actual participation period for the event."
                    },
                    "outcome":{
                        "type":"string",
                        "enum":[
                            "D1CN",
                            "D1ER",
                            "D1IO",
                            "D1ND",
                            "D1SP"
                        ],
                        "description":"Device's participation outcome for the event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participation\n* `D1CN` - Cancelled,\n* `D1ER` - Error,\n* `D1IO` - In-flight override,\n* `D1ND` - Non-responsive device,\n* `D1SP` - Successful participation",
                        "example":"D1SP"
                    },
                    "errorMessage":{
                        "type":"string",
                        "maxLength":100,
                        "description":"Optional error message sent when posting an error outcome."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1_PstEvtOut"
    }
}

Nested Schema : postOutcomeList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventExternalIdentifier":{
                "type":"string",
                "maxLength":120,
                "description":"Unique identifier of the event from the external application."
            },
            "nicId":{
                "type":"string",
                "maxLength":100,
                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
            },
            "headEndSystem":{
                "type":"string",
                "maxLength":50,
                "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
            },
            "participationStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Participation start/end date/time will be the device's actual participation period for the event."
            },
            "participationEndDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Participation start/end date/time will be the device's actual participation period for the event."
            },
            "outcome":{
                "type":"string",
                "enum":[
                    "D1CN",
                    "D1ER",
                    "D1IO",
                    "D1ND",
                    "D1SP"
                ],
                "description":"Device's participation outcome for the event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participation\n* `D1CN` - Cancelled,\n* `D1ER` - Error,\n* `D1IO` - In-flight override,\n* `D1ND` - Non-responsive device,\n* `D1SP` - Successful participation",
                "example":"D1SP"
            },
            "errorMessage":{
                "type":"string",
                "maxLength":100,
                "description":"Optional error message sent when posting an error outcome."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• errorMessage: string
  Maximum Length: 100

  Optional error message sent when posting an error outcome.
• eventExternalIdentifier: string
  Maximum Length: 120

  Unique identifier of the event from the external application.
• headEndSystem: string
  Maximum Length: 50

  Head 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: 100

  Head 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 participation * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participation

  Example: 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.

{
    "type":"object",
    "properties":{
        "eventExternalIdentifier":{
            "type":"string",
            "maxLength":120,
            "description":"Unique identifier of the event from the external application."
        },
        "nicId":{
            "type":"string",
            "maxLength":100,
            "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
        },
        "headEndSystem":{
            "type":"string",
            "maxLength":50,
            "description":"Head end system, along with the NIC Id, is used to uniquely identify the device to reserve for the event or to post event outcome."
        },
        "participationStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Participation start/end date/time will be the device's actual participation period for the event."
        },
        "participationEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Participation start/end date/time will be the device's actual participation period for the event."
        },
        "outcome":{
            "type":"string",
            "enum":[
                "D1CN",
                "D1ER",
                "D1IO",
                "D1ND",
                "D1SP"
            ],
            "description":"Device's participation outcome for the event. * `D1CN` - Cancelled, * `D1ER` - Error, * `D1IO` - In-flight override, * `D1ND` - Non-responsive device, * `D1SP` - Successful participation\n* `D1CN` - Cancelled,\n* `D1ER` - Error,\n* `D1IO` - In-flight override,\n* `D1ND` - Non-responsive device,\n* `D1SP` - Successful participation",
            "example":"D1SP"
        },
        "errorMessage":{
            "type":"string",
            "maxLength":100,
            "description":"Optional error message sent when posting an error outcome."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1_PstEvtOut

Type: object

Show Source

{
    "type":"object",
    "properties":{
    },
    "xml":{
        "name":"X1_PstEvtOut"
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top