Letters

Returns the list of letter token items

get/sites/{site-identifier}/global/letter-templates/tokens

Request

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

Response

Success

TokenGUIDstring
Codestring
Descriptionstring
Typestring
Groupstring
Entitystring
CreateBystring
Textstring
ImageURLstring

Example response

[
  {
    "TokenGUID": "adb66fc8-3e3c-acb2-8914-87d471052364",
    "Code": "LOGO-LINE",
    "Description": "Line logo for the fund or site.",
    "Type": "Image",
    "Group": "Logo",
    "Entity": "FUND",
    "CreateBy": "User",
    "ImageURL": "http://localhost:8080/api/v1/sites/local/global/letter-templates/tokens/adb66fc8-3e3c-acb2-8914-87d471052364/image",
    "Attribute": {
      "Code": "EXT-INV",
      "Description": "Value of total assets for the entity",
      "Entity": "FUND"
    },
    "Permissions": [
      [
        "modify",
        "delete"
      ]
    ]
  }
]

Changes

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