Global

Get details of a fund list.

get/sites/{site-identifier}/lists/{list-identifier}

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/lists/{list-identifier}
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: default)

Path parameters

site-identifierstring required

The GUID that identifies a site

list-identifierstring required
Example:f40ed4cc-00dd-c798-d314-7893a8a948e6

The GUID or code of the fund list.

Response

Success

Codestring
Descriptionstring
SecurityModel'SYSTEM' | 'PUBLIC' | 'PRIVATE'
CriteriaType'DYNAMIC' | 'STATIC'
CriteriaJoinType'AND' | 'OR'

Example response

{
  "Code": "FUND-LIST-1",
  "Description": "Fund list 1",
  "Criteria": [
    {
      "Field": "Service Category",
      "Value": "SCO-ULTIMATE"
    }
  ],
  "Members": {
    "Include": [
      {
        "GUID": "f40ed4cc-00dd-c798-d314-7893a8a434b8",
        "Code": "FUND-CODE-1",
        "Name": "Fund name 1"
      }
    ],
    "Exclude": [
      {
        "GUID": "f40ed4cc-00dd-c798-d314-7893a8a948e6",
        "Code": "FUND-CODE-2",
        "Name": "Fund name 2"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.