Oracle Hospitality Content Notification API

openapi: 3.2.0
info:
  title: OPERA Cloud Distribution Content Notification API
  version: 26.2.0.0
  description: Oracle Hospitality Distribution Content notification message specification for distribution partners to receive in real time property content, channel room and rate updates.
  contact:
    email: hospitality_apis_ww_grp@oracle.com
  license:
    name: UPL
    url: https://opensource.org/licenses/upl
  termsOfService: https://www.oracle.com/legal/terms.html
servers:
- url: /notification/v1
tags:
- name: Content Notification
  description: The Content Notification service provides ability to send distribution partners with hotel property inventory level, room rates, and restrictions.
paths:
  /content:
    post:
      responses:
        '201':
          headers:
            Content-Language:
              description: Audience language
              x-example: en-GB
              schema:
                type: string
                pattern: '[a-zA-Z]{1,8}(-[a-zA-Z0-9]{1,8})*'
            Location:
              description: Location of process status resource
              schema:
                type: string
          description: Response for publishing content
        '400':
          description: Request data provided is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '405':
          description: Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '406':
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '413':
          description: Payload Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '414':
          description: URI Too Long
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDetail'
      summary: Content Notification
      operationId: postContent
      description: 'This message will provide channel property content

        OperationId:postContent'
      tags:
      - Content Notification
      parameters:
      - name: Authorization
        description: Bearer token that needs to be passed which is generated post user authentication
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChannelContent'
        required: true
components:
  schemas:
    ChannelContent:
      description: The object provides the channel content detail.
      type: object
      properties:
        moduleName:
          type: string
          example: ChannelContent
        actionType:
          type: string
          description: The action type for the event
          example: UPDATE CHANNEL ROOM TYPE
        uniqueId:
          $ref: '#/components/schemas/UniqueId'
        timeStamp:
          $ref: '#/components/schemas/Timestamp'
        enterpriseId:
          type: string
          description: The Enterprise ID of the property it belongs to
          example: ENTERPRISEID
        hotelCode:
          type: string
          description: A unique identifier value for the property/hotel associated with channel
          minLength: 1
          maxLength: 50
          example: HOTELCODE
        channelCode:
          type: string
          description: Code for the channel which is receiving published data.
          minLength: 1
          maxLength: 50
          example: CHANNELCODE
        transactionKey:
          type: array
          items:
            $ref: '#/components/schemas/TransactionKeyDetail'
    ExceptionDetail:
      type: object
      allOf:
      - $ref: '#/components/schemas/ExceptionObj'
      - type: object
        properties:
          o.errorDetails:
            type: array
            items:
              $ref: '#/components/schemas/ExceptionObj'
    UniqueId:
      type: string
      description: The unique identifier element allows the trading partners to uniquely identify each request of the same message, (i.e.  the entire message) for transaction traceability
      example: 234512-3432-234234234
    ExceptionObj:
      type: object
      properties:
        logId:
          type: integer
          example: 884366976
        title:
          type: string
          description: Short, human-readable summary of the problem.  The summary SHOULD NOT change for subsequent occurrences of the problem, except for purposes of localization.
        status:
          type: integer
          description: HTTP status code for this occurrence of the problem, set by the origin server.
          example: 400
        o.errorCode:
          type: string
          description: HDP error code, which is different from HTTP error code.
          example: DARI00001
        type:
          type: string
          description: Absolute URI [RFC3986] that identifies the problem type.  When dereferenced, it SHOULD provide a human-readable summary of the problem.
          example: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.x
        timestamp:
          type: string
          example: '2021-09-17T08:17:18.321Z'
          format: date-time
      required:
      - logId
      - title
      - status
    Timestamp:
      type: string
      format: DATE_TIME
      description: Indicates the creation date and time of the message in UTC using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ss.zzzZ with time values using the 24 hour clock (e.g. 20 November 2003, 1:59:38 pm UTC becomes 2003-11-20T13:59:38.000Z).
      example: '2021-11-20T13:59:38.000Z'
    TransactionKeyDetail:
      type: object
      properties:
        name:
          type: string
          example: roomType
        value:
          type: string
          example: ROOMTYPECODE
externalDocs:
  description: Find out more about Oracle Hospitality
  url: https://docs.oracle.com/en/industries/hospitality/integration_platforms.html