Jump to

• Request
• Response

Cancel Program Event

post

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

This REST web service cancels an existing program event prior to the events scheduled start time.

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

• cancelMessage: string
  Maximum Length: 100

  An optional field provided to capture the event cancellation reason provided. This message can be displayed by the external application to provide context for the event cancellation.
• 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 cancelled.

{
    "type":"object",
    "properties":{
        "eventExternalIdentifier":{
            "type":"string",
            "maxLength":120,
            "description":"Unique identifier of the event from the external application, which must match the ID for the event that is being cancelled."
        },
        "cancelMessage":{
            "type":"string",
            "maxLength":100,
            "description":"An optional field provided to capture the event cancellation reason provided. This message can be displayed by the external application to provide context for the event cancellation."
        }
    },
    "xml":{
        "name":"X1_PreEvtCan"
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• cancelMessage: string
  Maximum Length: 100

  An optional field provided to capture the event cancellation reason provided. This message can be displayed by the external application to provide context for the event cancellation.
• 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 cancelled.

{
    "type":"object",
    "properties":{
        "eventExternalIdentifier":{
            "type":"string",
            "maxLength":120,
            "description":"Unique identifier of the event from the external application, which must match the ID for the event that is being cancelled."
        },
        "cancelMessage":{
            "type":"string",
            "maxLength":100,
            "description":"An optional field provided to capture the event cancellation reason provided. This message can be displayed by the external application to provide context for the event cancellation."
        }
    },
    "xml":{
        "name":"X1_PreEvtCan"
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1_PreEvtCan

Type: object

Show Source

• cancelMessage: string
  Maximum Length: 100

  An optional field provided to capture the event cancellation reason provided. This message can be displayed by the external application to provide context for the event cancellation.
• 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 cancelled.

{
    "type":"object",
    "properties":{
        "eventExternalIdentifier":{
            "type":"string",
            "maxLength":120,
            "description":"Unique identifier of the event from the external application, which must match the ID for the event that is being cancelled."
        },
        "cancelMessage":{
            "type":"string",
            "maxLength":100,
            "description":"An optional field provided to capture the event cancellation reason provided. This message can be displayed by the external application to provide context for the event cancellation."
        }
    },
    "xml":{
        "name":"X1_PreEvtCan"
    }
}

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

{
    "type":"object",
    "properties":{
        "problemType":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "maximum":9999,
            "minimum":0,
            "type":"number",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "$ref":"#/components/schemas/problemDetailDocument_serverMessage"
        }
    }
}

Nested Schema : problemDetailDocument_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":{
            "maximum":0,
            "minimum":0,
            "type":"number",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "maximum":99999,
            "minimum":-99999,
            "type":"number",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "maxLength":60,
            "type":"string",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "maxLength":60,
            "type":"string",
            "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 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "maximum":9999,
            "minimum":0,
            "type":"number",
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "maxLength":60,
            "type":"string",
            "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":{
            "maxLength":60,
            "type":"string",
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "$ref":"#/components/schemas/problemDetailDocument_serverMessage"
        }
    }
}

Nested Schema : problemDetailDocument_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":{
            "maximum":0,
            "minimum":0,
            "type":"number",
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "maximum":99999,
            "minimum":-99999,
            "type":"number",
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "maxLength":60,
            "type":"string",
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "maxLength":60,
            "type":"string",
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "maxLength":60,
            "type":"string",
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top