GET /sites/{site-identifier}/global/advisers

Global

Return adviser list

get/sites/{site-identifier}/global/advisers

Request

Base URL: https://api-dev.superconcepts.com.au/api/v1
URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/global/advisers
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: actuarial_write, audit_read, audit_write, client_access_grant, contactevents_read, contactevents_write, default, documents_read, documents_write, fund:investments_read, fund:members_read, fund:members_write, fund:transactions_read, fund:transactions_write, fund_read, fund_write, security:domains_write, security:policies_write, security:users_invite, site:accounting-notes_write, site:asset-categories_write, site:auditor_write, site:branding_write, site:datafeed-config_write, site:identity_write, site:letters_write, site:policies_write, site:reporting_write, sites_read, superstream:config_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

adviser-assistantstring

The GUID that identifies an adviser assistant

Query parameters

searchstring

Example:Adviser

Name contains search string

adviser-levelnumber

Example:2

The number that identifies an adviser level

parent-adviser-guidstring

Example:e3c76443-8126-05b6-9914-c88c1ce84725

The GUID that identifies a parent adviser

include-intermediate-levelsboolean

Example:true

To include advisor level higher than the specified level or parent adviser

include-adviser-assistantsboolean

Example:true

To include adviser assistants under the specified adviser

Response

Success

AdviserGUIDstring guid

Namestring

ClientViewStatusstring

ClientViewLastLoggedInstring date-time

ClientViewInviteRequestDatestring date-time

ClientViewInviteRequestStatusstring

ClientViewMFAStatusstring

ParentAdviserGUIDstring guid

ParentAdviserNamestring

GrandparentAdviserGUIDstring guid

GrandparentAdviserNamestring

Levelnumber

LevelDescriptionstring

ABNstring

ACNstring

AFSLNumberstring

AFSRepresentativeNumberstring

Example response

[
  {
    "AdviserGUID": "b0c21331-6e4d-d18f-8a14-3a410c693640",
    "Name": "Adviser",
    "ClientViewStatus": "Invited",
    "ClientViewInviteRequestDate": "2023-03-24T16:55:52.679+07:00",
    "ClientViewInviteRequestStatus": "ACTIVE",
    "ClientViewMFAStatus": "AVAILABLE",
    "Actions": [
      "Invite",
      "Disable"
    ],
    "ParentAdviserGUID": "b0c21331-6e4d-d18f-8a14-3a410c693640",
    "ParentAdviserName": "Amp Fp Syd Office",
    "GrandparentAdviserGUID": "ae40c44c-f3d6-ad90-e514-c23184ae0288",
    "GrandparentAdviserName": "Amp Financial Planning",
    "Level": 1,
    "LevelDescription": "Head Office",
    "ABN": "12345678901",
    "AFSLNumber": "123456",
    "AFSRepresentativeNumber": "789101",
    "AdviserAssistant": [
      {
        "IdentityGUID": "b100949d-0fa4-b0a2-dd14-88e44cfab57c",
        "IdentityCode": "000104-CT",
        "IdentityName": "TrustMePlease"
      }
    ]
  }
]

Changes

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