Global

Search for entities across the system.

get/sites/{site-identifier}/entity/search

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/entity/search
  • 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

search-stringstring required
Example:ComnSec

The search string.

entity-type-list'FUND' | 'PORTFOLIO' | 'ALL-FUNDS' required

The entity type list.

Response

Success

EntityType'FUND' | 'PORTFOLIO' | 'ALL-FUNDS'
EntityGUIDstring
EntityIdentitiferstring
EntityNamestring
EntityActiveboolean
Tagsstring
TagsDescriptionstring

Example response

[
  {
    "EntityGUID": "8b66c1d4-f1ea-7a81-4d14-495190340aa9",
    "EntityIdentitifer": "FUNDCODE100",
    "EntityName": "Service - BankLink Direct Fund",
    "EntityActive": true,
    "Tags": "Tag1",
    "TagsDescription": "Fund Tag 1",
    "Details": [
      {
        "FieldLabel": "TFN",
        "FieldValue": "Not on file"
      }
    ]
  }
]

Changes

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