Jump to

• Request
• Response

Reserve Device

post

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

This REST web service creates event participations to reserve devices enrolled in program for the upcoming event.

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

• deviceList: array deviceList
• eventEndDateTime: string (date-time)
  Event end datetime indicates the scheduled end time for the event received from the external source application.

  Example: 10-15-2022 05:00:00PM
• eventExternalIdentifier: string
  Maximum Length: 120

  Unique identifier of the event from the external application.
• eventStartDateTime: string (date-time)
  Event start datetime indicates the scheduled start time for the event received from the external source application.

{
    "type":"object",
    "properties":{
        "eventStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Event start datetime  indicates the scheduled start time for the event received from the external source application."
        },
        "eventEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Event end datetime indicates the scheduled end time for the event received from the external source application.",
            "example":"10-15-2022 05:00:00PM"
        },
        "eventExternalIdentifier":{
            "type":"string",
            "maxLength":"120",
            "description":"Unique identifier of the event from the external application."
        },
        "deviceList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "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."
                    },
                    "reservationStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime. "
                    },
                    "reservationEndDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1_ReserDvc"
    }
}

Nested Schema : deviceList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "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."
            },
            "reservationStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime. "
            },
            "reservationEndDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.
• reservationEndDateTime: string (date-time)
  Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime.
• reservationStartDateTime: string (date-time)
  Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime.

{
    "type":"object",
    "properties":{
        "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."
        },
        "reservationStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime. "
        },
        "reservationEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• deviceList: array deviceList
• eventEndDateTime: string (date-time)
  Event end datetime indicates the scheduled end time for the event received from the external source application.

  Example: 10-15-2022 05:00:00PM
• eventExternalIdentifier: string
  Maximum Length: 120

  Unique identifier of the event from the external application.
• eventStartDateTime: string (date-time)
  Event start datetime indicates the scheduled start time for the event received from the external source application.

{
    "type":"object",
    "properties":{
        "eventStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Event start datetime  indicates the scheduled start time for the event received from the external source application."
        },
        "eventEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Event end datetime indicates the scheduled end time for the event received from the external source application.",
            "example":"10-15-2022 05:00:00PM"
        },
        "eventExternalIdentifier":{
            "type":"string",
            "maxLength":"120",
            "description":"Unique identifier of the event from the external application."
        },
        "deviceList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "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."
                    },
                    "reservationStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime. "
                    },
                    "reservationEndDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1_ReserDvc"
    }
}

Nested Schema : deviceList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "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."
            },
            "reservationStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime. "
            },
            "reservationEndDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.
• reservationEndDateTime: string (date-time)
  Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime.
• reservationStartDateTime: string (date-time)
  Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime.

{
    "type":"object",
    "properties":{
        "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."
        },
        "reservationStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime. "
        },
        "reservationEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : X1_ReserDvc

Type: object

Show Source

• deviceList: array deviceList
• eventEndDateTime: string (date-time)
  Event end datetime indicates the scheduled end time for the event received from the external source application.

  Example: 10-15-2022 05:00:00PM
• eventExternalIdentifier: string
  Maximum Length: 120

  Unique identifier of the event from the external application.
• eventStartDateTime: string (date-time)
  Event start datetime indicates the scheduled start time for the event received from the external source application.

{
    "type":"object",
    "properties":{
        "eventStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Event start datetime  indicates the scheduled start time for the event received from the external source application."
        },
        "eventEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Event end datetime indicates the scheduled end time for the event received from the external source application.",
            "example":"10-15-2022 05:00:00PM"
        },
        "eventExternalIdentifier":{
            "type":"string",
            "maxLength":"120",
            "description":"Unique identifier of the event from the external application."
        },
        "deviceList":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "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."
                    },
                    "reservationStartDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime. "
                    },
                    "reservationEndDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"X1_ReserDvc"
    }
}

Nested Schema : deviceList

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "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."
            },
            "reservationStartDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime. "
            },
            "reservationEndDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.
• reservationEndDateTime: string (date-time)
  Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime.
• reservationStartDateTime: string (date-time)
  Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime.

{
    "type":"object",
    "properties":{
        "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."
        },
        "reservationStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Reservation start datetime indicates each device's reservation start time for the upcoming event. If not provided, the event start datetime is applied as the reservation start datetime. "
        },
        "reservationEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Reservation end datetime indicates each device's reservation end time for the upcoming event. If not provided, the event end datetime is applied as the reservation end datetime."
        }
    }
}

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