Get user profile history

Updated on 30 Apr 2020

Description

The user or External entity acting as a User with Role Permissions: USER_VIEWER, USER_MANAGER, PROFILE_MANAGER can access the list of System Users, pick up a particular User and request a profile history for some date range.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User with the following Role Permissions: USER_VIEWER, USER_MANAGER, PROFILE_MANAGER.
  2. System Operator running “SDK.Finance” software and exposing portfolio of financial APIs.

Preconditions

  1. The user must have a System Operator profile.

Basic Flow

By default, this flow assumes that External Entity sends Requests to System Operator Endpoints and System Operator sends back Responses to External Entity.

  1. Perform all steps of Use Case “Get user profile”.
  2. External Entity sends a request to Endpoint “Get profile history”.

API endpoint: https://sdkfinance.app/api/ui/#!/Operator_profile_management/getHistory

Parameter: userId

Request body example:



   "dateFrom":"2018-07-25T12:12:32.409Z",

   "dateTo":"2018-07-25T12:12:32.409Z"

}
  1. System Operator returns requested information to External Entity. (See Result example below)

Optional Flow with Web Browser UI

  1. Perform all steps of Use Case “Get user profile”.
  2. A user sends a request to Endpoint “Get profile history”.

API endpoint: https://sdkfinance.app/api/ui/#!/Operator_profile_management/getHistory

Parameter: userId

Request body example:



   "dateFrom":"2018-07-25T12:12:32.409Z",

   "dateTo":"2018-07-25T12:12:32.409Z"

}
  1. System Operator returns requested information to External Entity. (See Result example below)

Post Conditions

History is available to the requestor.

Response example



   "profileHistory":{ 

      "personHistory":{ 

 

      },

      "contactHistory":{ 

 

      },

      "typeHistory":{ 

 

      },

      "statusHistory":{ 

 

      },

      "businessHistory":{ 

 

      },

      "addressHistory":{ 

 

      },

      "additionalHistory":{ 

 

      }

   },

   "status":"ok",

   "message":"string"

}