openapi: 3.2.0
info:
  version: 1.0.2
  title: Finance Notifier Application Status API
  description: This app will be consumed by Finance system to push the processing status of the files generated by the finance adapters.
servers:
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/marriott-api/finance-all-statusnotifier/1.0.2
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/marriott-api/fas-oauthapp/1.0.0 - To be updated
security:
- application:
  - write
tags:
- name: Status
paths:
  /status:
    put:
      summary: Operation to push the file processing status from the Finance system
      description: This is the operation to push the file processing status from the Finance system to have all the relevant status related information colocated in document db
      operationId: updateProcessingStatus
      requestBody:
        description: Update the file processing status
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Status'
        required: true
      responses:
        '200':
          description: OK
        '400':
          description: Invalid Input Data
        '401':
          description: Unauthorized
        '404':
          description: Adapter entry for desired file could not found
      tags:
      - Status
components:
  schemas:
    SystemIdentifierEnum:
      type: string
      description: Possible values for system identifier
      enum:
      - GL1
      - GL2
      - GL3
      - OFB
      - BTR
    ProcessingStatusEnum:
      type: string
      description: Possible values for processing status
      enum:
      - SUCCESS
      - ERROR
      - SUCCESS_WITH_WARNING
      - ERROR_WITH_WARNING
    Status:
      type: object
      properties:
        propertyCode:
          type: string
          description: Property code or Marsha Code. It is optional in case of OFB.
          example: LHRHR
        businessDate:
          type: string
          format: date
          description: Business date or Transaction posting date
          example: 04172023 i.e. mmddyyyy format
        processingStatus:
          $ref: '#/components/schemas/ProcessingStatusEnum'
        errorCode:
          type: string
          description: Error code that caused the file processing to fail
        errorDescription:
          type: string
          description: Error code that caused the file processing to fail
        systemId:
          $ref: '#/components/schemas/SystemIdentifierEnum'
        databaseId:
          type: string
          description: Database name. It confirms where the message came from, particularly useful for the environments with multiple instances.
        processInstance:
          type: string
          description: Finance process instance. Identifies the process identifier executed or reported the status
        processName:
          type: string
          description: Finance process name. PeopleSoft SQR, App Engine or script name
        operatorId:
          type: string
          description: Finance user ID. The user that executed the Finance process
        operatingUnit:
          type: string
          description: Finance hotel identifier
  securitySchemes:
    application:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: http://example.com/oauth/token
          scopes:
            write: allows modifying resources