Activities

Monitor the status of asynchronous authentication or aggregation activities

Changed on

Determine if asynchronous activities are in progress for the authenticated investor. The endpoint can monitor activities for just the current session, or it can include other sessions of the user depending on the scope parameter setting. Asynchronous activities include: </br> </br><span>•</span> authenticating credentials </br> <span>•</span> discovering, adding, and aggregating accounts</br> <span>•</span> aggregating accounts </br></br>This endpoint returns a single Boolean value for activityInProgress that indicates whether asynchronous activities are in progress for the user. </br></br>The applicable scope of this endpoint is always a single authenticated investor. This endpoint can provide information on asynchronous activity for the current session or for all activity in the system. Use the scope parameter with value session to request information about activity initiated during the current session. Use the scope parameter with value global to request information for all activity in the system. When scope is global, asynchronous activity progress will be available for terminated sessions up to 15 minutes after completion of that activity. If the scope parameter is not provided, the endpoint will report on activity for the current session if there is one. If there is no current session (Morningstar Authentication) then it will report on all activity for the authenticated investor. </br></br>Response discussion </br>The JSON response for the endpoint is one of the following, depending on whether there is activity in progress or not: </br><span>•</span> {"activityInProgress":false} </br>OR</br><span>•</span> {"activityInProgress":true} </br>If scope is not set or is set to session, the value is true if any asynchronous activity is in progress for the session for at least one credential. If scope is set to global, the value is true if any asynchronous activity is in progress for the session for at least one credential or if authenticate or discovery/add/aggregate is in progress for accounts aggregating for at least one credential outside the current session. When all activity completes then the value of activityInProgress will be false.

get/activities/summary

Request

  • Base URL
    //basrvqaap6001.morningstar.com/WPDemo/webportfolio/api/v1 (relative, and the document’s source URL is not known)
  • Auth
    API key in header Authorization

Query parameters

scopestring

Scope of activity. Value can be session, to include only session-specific activity progress, or global to also include activity progress from other sessions for this user. Cannot be set to session for users authenticated with Morningstar Authentication. The default is session for session-based users and global for users authenticated by Morningstar Authentication.</br></br>Note: the global setting currently does not return status for accounts aggregating outside the current session.

Response

Ok

activityInProgressboolean

If true, aggregation is in-progress for at least one credential

Changes