Tasks

Returns the specified task query.

get/sites/{site-identifier}/queries/{query-identifier}

Request

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

query-identifierstring required

The GUID that identifies a specific Task Query

Query parameters

IncludeTransactionDetailsstring

Response

Success

QueryGUIDstring
FundGUIDstring
Subjectstring
FinancialYearnumber
Detailsstring
Status'Draft' | 'With Client' | 'With Administrator' | 'Responded' | 'Completed'
PrivacyLevel'CONFIDENTIAL' | 'NO-RESTRICTION'
QueryDateTimestring date-time
LastStatusUpdateDateTimestring date-time
LastFollowUpDateTimestring date-time
NumberOfAttachmentsnumber
QueryCreatedByNamestring
QueryCreatedByEmailstring
QuerySentByNamestring
QuerySentByEmailstring
LastMessageSentDateTimestring date-time
EmailRoutingCodestring
BrandNamestring
Prioritystring
DueDatestring date
ReminderStartDatestring date
ReminderFrequencystring
LastReminderSentDateTimestring date-time
NextReminderSentDateTimestring date-time
QueryTemplateGUIDstring guid
QueryTemplateNamestring
EntitySourceRecordNamestring
EntitySourceRecordType'MEMBER' | 'PENSION' | 'ACCOUNT'
EntitySourceRecordGUIDstring guid
WorkflowNodeNamestring
SystemGeneratedboolean

Example response

[
  {
    "QueryGUID": "6a9ce773-5011-308e-7914-73d18ced3493",
    "FundGUID": "6a9ce773-5011-308e-7914-73d18ced3493",
    "Subject": "Subject",
    "FinancialYear": 2022,
    "QueryDateTime": "2020-03-24T15:55:52.679+07:00",
    "LastStatusUpdateDateTime": "2020-03-24T15:55:52.679+07:00",
    "LastFollowUpDateTime": "2020-03-24T15:55:52.679+07:00",
    "Type": {
      "Code": "GENERAL",
      "Description": "General client query"
    },
    "QueryCreatedByName": "ElsaSnow",
    "LastMessageSentDateTime": "2020-03-24T15:55:52.679+07:00",
    "EmailRoutingCode": "163",
    "BrandName": "Brand 5",
    "RelatedEntities": {
      "Transaction": {
        "TransactionGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf7",
        "Description": "Transaction description",
        "Payment": 100.1
      }
    },
    "Priority": "Normal",
    "DueDate": "2023-06-30",
    "ReminderStartDate": "2023-06-30",
    "ReminderFrequency": "Weekly",
    "LastReminderSentDateTime": "2020-03-24T15:55:52.679+07:00",
    "NextReminderSentDateTime": "2020-03-24T15:55:52.679+07:00",
    "AvailableClientViewRoleTypes": [
      "AUDITOR",
      "ADVISER",
      "TRUSTEE"
    ],
    "QueryTemplateGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf2",
    "QueryTemplateName": "Query Template Name",
    "EntitySourceRecordName": "Entity Source Record Name",
    "EntitySourceRecordGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf1",
    "Messages": [
      {
        "MessageGUID": "e7eec8e2-87c2-04bb-8014-6934608e7333",
        "Message": "Hello, please provide the latest trust deed",
        "CreatedBy": {
          "IdentityGUID": "e7eec8e2-87c2-04bb-8014-6934608e73f8",
          "Type": "USER"
        },
        "SentBy": {
          "IdentityGUID": "e7eec8e2-87c2-04bb-8014-6934608e73f8",
          "Type": "USER"
        },
        "CreateDateTime": "2020-03-24T15:55:52.679+07:00",
        "LastUpdateDateTime": "2020-03-24T15:55:52.679+07:00",
        "SentDateTime": "2020-03-25T15:55:52.679+07:00",
        "HasBeenRead": true,
        "Permissions": [
          "modify",
          "delete"
        ],
        "Attachments": [
          {
            "AttachmentGUID": "e7eec8e2-87c2-04bb-8014-6934608e73f8",
            "FileName": "file-name.txt",
            "OriginalFileName": "file-name.txt",
            "FileSize": 3210
          }
        ]
      }
    ],
    "Attachments": [
      {
        "AttachmentGUID": "e7eec8e2-87c2-04bb-8014-6934608e73f8",
        "FileName": "file-name.txt",
        "OriginalFileName": "file-name.txt",
        "FileSize": 3210
      }
    ],
    "WorkflowNodeName": "Manual node 1"
  }
]

Changes

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