GET /sites/{site-identifier}/funds/{fund-identifier}/contact-preferences

Funds

Get fund contact preferences.

get/sites/{site-identifier}/funds/{fund-identifier}/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}/funds/{fund-identifier}/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

DefaultTo'' | 'BRAND' | 'ADVISER'

PrimaryContactTypestring

PrimaryContactGUIDstring guid

PrimaryContactLabelstring

SecondaryContactTypestring

SecondaryContactGUIDstring guid

SecondaryContactLabelstring

Example response

{
  "PrimaryContactType": "FUND-ASSOCIATE,ADMINISTRATOR",
  "PrimaryContactLabel": "Administrators",
  "PrimaryContact": {
    "Contact": {
      "Title": "Miss",
      "GivenNames": "Emily",
      "Surname": "Taylor",
      "Salutation": "Dear",
      "EmailAddress1": "emilytaylor@gmail.com"
    },
    "Address": {
      "StreetAddress": {
        "StreetName": "Elizabeth",
        "StreetType": "STREET",
        "Suburb": "BRISBANE CITY",
        "State": "QLD",
        "Country": "Australia"
      },
      "PostalAddress": {
        "Line1": "LOCKED BAG 13101",
        "Suburb": "Archerfield",
        "State": "QLD",
        "Country": "Australia"
      }
    }
  },
  "SecondaryContactType": "FUND-ASSOCIATE,ADMINISTRATOR",
  "SecondaryContactLabel": "Administrators",
  "SecondaryContact": {
    "Contact": {
      "Title": "Miss",
      "GivenNames": "Emily",
      "Surname": "Taylor",
      "Salutation": "Dear",
      "EmailAddress1": "emilytaylor@gmail.com"
    },
    "Address": {
      "StreetAddress": {
        "StreetName": "Elizabeth",
        "StreetType": "STREET",
        "Suburb": "BRISBANE CITY",
        "State": "QLD",
        "Country": "Australia"
      },
      "PostalAddress": {
        "Line1": "LOCKED BAG 13101",
        "Suburb": "Archerfield",
        "State": "QLD",
        "Country": "Australia"
      }
    }
  },
  "Options": [
    {
      "Description": "Alerts",
      "ValidValues": "CLIENT-VIEW,EMAIL,ADVISER,NONE"
    }
  ],
  "PrimaryContactOptions": [
    {
      "ContactType": "FUND-ASSOCIATE,ADMINISTRATOR",
      "ContactLabel": "Administrators",
      "Contact": {
        "Title": "Miss",
        "GivenNames": "Emily",
        "Surname": "Taylor",
        "Salutation": "Dear",
        "EmailAddress1": "emilytaylor@gmail.com"
      }
    }
  ]
}

Changes

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