Global

Get Adviser contact preferences.

get/sites/{site-identifier}/global/advisers/{adviser-guid}/contact-preferences

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/{adviser-guid}/contact-preferences
  • 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

fund-identifierstring required

The GUID that identifies a fund

Query parameters

include-primary-contact-optionsboolean

Include primary contact options.

Response

Success

PrimaryContactTypestring
PrimaryContactLabelstring
PrimaryContactGUIDstring guid
SecondaryContactTypestring
SecondaryContactLabelstring
SecondaryContactGUIDstring guid

Example response

{
  "PrimaryContactType": "FUND-ASSOCIATE,ACCOUNTANT",
  "PrimaryContactLabel": "Accountants",
  "PrimaryContactGUID": "ef1f02ff-738e-4bbd-8214-fbe4742d70e0",
  "SecondaryContactType": "FUND-ASSOCIATE,ACCOUNTANT",
  "SecondaryContactLabel": "Accountants",
  "SecondaryContactGUID": "ef1f02ff-738e-4bbd-8214-fbe4742d70ab",
  "Options": [
    {
      "Description": "Alerts",
      "ValidValues": "CLIENT-VIEW,EMAIL,ADVISER,NONE"
    }
  ],
  "PrimaryContactOptions": [
    {
      "ContactType": "FUND-ASSOCIATE,ACCOUNTANT",
      "ContactLabel": "Accountants"
    }
  ]
}

Changes

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