Master funds & Scopes

Definition

Quantium system allows flexibility to organize access to different sets of entities through masterfund & scope concept. In administrator dashboard menu, client administrator may organize a set of entities in different scope. Each scope may contain different:

Fund vehicles
SPVs
Investor entities
Assets
Users

📘
Access rights
Within each scope, client administrator may configure access rights to each user depending on client internal data policies in administrator dashboard menu

Retrieving a list of scopes accessible by current user

To get a list of all scopes available for the current user, you can use

	Value
HTTP Method	GET
Path	/api/scope/list/currentuser
Request parameters	None
Reference	getscopelistofcurrentuser

Example

curl -X GET "https://<Quantium Web API URL>/api/Scope/list/current" -H "accept: */*" -H "Authorization: Bearer <token>"

$.ajax({
   url: 'http://<QuantiumAPIWebUrl>/api/scope/list/currentuser',
   type: 'GET',
   contentType: 'application/json'
   headers: {
      'Authorization': 'Bearer <token>'
   },
   success: function (result) {
       var data = JSON.parse(result);
  		 console.log(data);
   },
   error: function (err) {
			console.error(err);
   }
});

var accessToken = "<Bearer token retrieved from previous section>";
using (var client = new HttpClient())
{
    var url = "https://<Quantium CORE Web API URL>/api/scope/list/currentuser";
    client.DefaultRequestHeaders.Add("Authorization", accessToken);
    var response = await client.GetStringAsync(url);
    // Parse JSON response.
    ..
}

Retrieving a list of all scopes of all users (For admin user only)

Please note that this API is only accessible by admin users. To get a list of all scopes in your system:


HTTP Method	GET
Path	/api/scope/all
Request parameters	None
Reference	getallscopes

Parsing the returned result.

The returned result of the scope list API is in Array of Scope Object format as follows:

Scope {
  internalId	string
  nullable: true
  id	integer($int32)
  companyId	integer($int32)
  masterFundId	integer($int32)
  scopeName	string
  nullable: true
  currencyCode	string
  nullable: true
  defaultMetricCurrencyCode	string
  nullable: true
  users	[...]
  fundvehicles	[...]
  assets	[...]
  investors	[...]
  spvs	[...]
  status	string
  nullable: true
  canDelete	boolean
  lastUpdatedBy	string
  nullable: true
  fundVehiclesMigrated	boolean
  assetsMigrated	boolean
  investorsMigrated	boolean
  spvsMigrated	boolean
  isDirty	boolean
}

Field	Description	Type
internalId	Scope ID : used in many request to the APIs to authorized user access to the functionality and to determine entities visibilities	Text
companyID	Your current company account ID	Number
scopeName	Scope display name	Text
currenyCode	Default displayed currency code	Text
users	a list of user names who have access to the scope	a list of texts
funvehicles	a list of fund vehicle IDs visible by the given scope	a list of texts
assets	a list of asset IDs visible by the given scope	a list of texts
investors	a list of investor IDs visible by the given scope	a list of texts
spvs	a list of SPV IDs visible by the given scope	a list of texts

Example

[
  {
    "internalId": "5e38f5eb78aa254b747b3551",
    "companyId": 1,
    "scopeName": "Scope#1",
    "currencyCode": "USD",
    "defaultMetricCurrencyCode": "USD",
    "users": [
      "[email protected]",
      "[email protected]"
    ],
    "fundvehicles": [
      "5e38f5ec78aa254b747b357e",
      "5e38f5ec78aa254b747b357f",
    ],
    "assets": [
      "5e38f9afcc34d70e80d7563a",
      "5e38fcc3cc34d70e80d7563b",
    ],
    "investors": [
      "5e38f830cc34d70e80d75625",
      "5e38f856cc34d70e80d75626",
      "5fab7335fc6d816044b2632c"
    ],
    "spvs": [
      "5e38f5ec78aa254b747b3584",
      "5f50c36cb9314e5e9c59e2f2"
    ]
  },
  {
    "internalId": "5e38f5eb78aa254b747b3552",
    "companyId": 1,
    "scopeName": "Scope#2",
    "currencyCode": "CNY",
    "defaultMetricCurrencyCode": "CNY",
    "users": [
      "[email protected]",
      "[email protected]"
    ],
    "fundvehicles": [
      "5ef30db6ce46ee6ec4391559",
      "5ef30fcace46ee6ec439155a",
      "5e38f5ec78aa254b747b357e",
      "5f697d5ed64c8b6210bf30df"
    ],
    "assets": [
      "5e38fce6cc34d70e80d7563f",
      "5f50bf56b8c28e556c2246b5"
    ],
    "investors": [
      "5ef30d58ce46ee6ec4391551",
      "5f697e6bd64c8b6210bf30e4",
      "5f69dd9dd64c8b6210bf30e5"
    ],
    "spvs": [
      "5ef311d5ce46ee6ec439155b",
      "5ef31274ce46ee6ec439155d",
      "5ef31308ce46ee6ec439155e"
    ]
  }
]

Definition

📘Access rights

Retrieving a list of scopes accessible by current user

Retrieving a list of all scopes of all users (For admin user only)

Parsing the returned result.

📘
Access rights