Marriott Finance Status Notifier API

{"openapi":"3.0.0","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"}],"info":{"version":"1.0.2","title":"Finance Status Notifier Application","description":"This app will be consumed by Finance system to push the processing status of the files generated by the finance adapters."},"security":[{"application":["write"]}],"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"}}}},"/retrieveConfigsMonitoredByConfigWatcher":{"get":{"summary":"Retrieves configuration details monitored by the Spring config watcher","description":"Retrieves configuration details monitored by the Spring config watcher","operationId":"retrieveConfigsMonitoredByConfigWatcher","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigWatcherResponse"}}}},"400":{"description":"No Content"}}}},"/actuator/loggers/ROOT":{"post":{"summary":"Change ROOT logger level","description":"This operation changes the ROOT log level of the app","operationId":"changeLogger","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggersResponse"}}},"required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Invalid Input Data"}}}},"/data":{"post":{"summary":"Operation to create/load the performance test data to the respective docdb collection based on the count provided for each adapter","description":"This is to create/load adapter processing status data to perform performance testing based on input count for each adapter provided it is enabled for the environment. It will return the array of property codes for which the data has been created. Property codes should be in the format of GLXXX and BTXXX where XXX is any combination of alphabets only.","operationId":"createAdapterProcessingStatusPefTestData","requestBody":{"description":"Request body detailing what data and how much needs to be created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerfTestData"}}},"required":true},"responses":{"200":{"description":"Returns an array of property codes for which data is created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyCodeArray"}}}},"400":{"description":"Error Ocurred while loading the data in the DB"},"404":{"description":"The data endpoint is not available for this environment"}}},"delete":{"summary":"Operation to delete performance test data based on the adapter list provided in the request body","description":"This operation deletes the documents from the document database for the specified adapters.","operationId":"deletePerfTestData","parameters":[{"name":"adapters","in":"query","schema":{"type":"array","items":{"type":"string"}},"description":"List of adapters for which the performance test data should be deleted","example":"BTR,GL"}],"responses":{"200":{"description":"OK"},"400":{"description":"Error in deleting data"},"404":{"description":"The data endpoint is not available for this environment"}}}}},"components":{"schemas":{"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"}}},"ProcessingStatusEnum":{"type":"string","description":"Possible values for processing status","enum":["SUCCESS","ERROR","SUCCESS_WITH_WARNING","ERROR_WITH_WARNING"]},"SystemIdentifierEnum":{"type":"string","description":"Possible values for system identifier","enum":["GL1","GL2","GL3","OFB","BTR"]},"ConfigWatcherResponse":{"type":"object","properties":{"configWatcherVariable":{"type":"integer"}}},"LoggersResponse":{"type":"object","properties":{"configuredLevel":{"type":"string"}}},"PerfTestData":{"type":"object","properties":{"glCount":{"type":"integer","description":"Count to add the file processing status for GL","example":6},"btrCount":{"type":"integer","description":"Count to add the file processing status for BTR","example":5},"businessDate":{"type":"string","format":"MMDDYYYY","example":"06112025"}}},"PropertyCodeArray":{"type":"array","items":{"type":"string","description":"Property code in the format GLXXX, OFXXX, or BTXXX where XXX is any combination of alphabets."},"description":"Array of Property codes.","example":["GLABC","BTRXYZ"]}},"securitySchemes":{"application":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"http://example.com/oauth/token","scopes":{"write":"allows modifying resources"}}}}}}}