Housing Record Of Service .xslx file upload API implementation

[eric-jahn]

• The ROS upload microservice will leverage the ROS import code already available from a previous work order: https://github.com/servinglynk/hslynk-open-source/tree/master/hmis-ces-onboarding.

• This task will create a enterprise microservice that will process uploaded ROS data on demand. APIs for the upload services will be published at https://api.hslynk.com.

• The new API will only receive uploads of ROS data, and report success or error codes and messages for the calling client application to ascertain the status of the upload. There will not be an API for managing previously uploaded Excel spreadsheets as a set, but uploaded data can be deleted or modified using the existing survey Create/Read/Update/Delete APIs at https://api.hslynk.com/?urls.primaryName=Survey%20Service%20Api.

• Response messages to be implemented by the APIs (mapped to standard HTTP status codes):

  • success
  • error messages
    • file too large
    • file improperly formatted with detail as to which columns/cells are causing the error
    • other standard errors
  • progress percentage

• The upload ROS data will become normal survey data which is already synced to the data warehouse for reporting/analytics via a Hive and/or Impala view.

[logicsandeep]

The estimate to complete this task is : 40 hours. This includes 1) Creating a ROS data processor which will process ROS data and also log important information about the upload like the number of new clients discovered, the number of survey submissions created and the number of response records created. 2) New APIs to upload ROS data. 3) Admin app UI changes to upload ROS data file and show status the status of the upload and also relevant information about the ROS upload (mentioned in point#1) . 4) Syncing the data to the big data warehouse should happen by default, but it would be important to test this. 5) Testing and bug fixing.