Tasks

Returns the queries for a site.

get/sites/{site-identifier}/queries

Request

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

fund-identifierstring
fund-identifier-liststring

Comma-separated list of multiple fund-identifier values.

financial-yearnumber
query-statusstring
IncludeTransactionDetailsstring
unreadboolean
Example:true
HasDraftMessagesboolean
owner'ALL-TEAMS' | 'MY-TEAM' | 'MINE'

Return queries from all owner teams

query-type'DOCUMENT-REQUEST' | 'GENERAL' | 'QUERY-FROM-CLIENT' | 'TRANSACTION'
role-typestring
create-start-datestring

The start date with format (yyyy-MM-dd). Return queries that were created within that date range

create-end-datestring

The end date with format (yyyy-MM-dd). Return queries that were created within that date range

last-message-start-datestring

The last query's message start date with format (yyyy-MM-dd). Return queries that had the last message within that date range.

last-message-end-datestring

The last query's message end date with format (yyyy-MM-dd). Return queries that had the last message within that date range.

active-onlyboolean

Only return queries with one of the “active” statuses.

list-identifierstring
Example:f40ed4cc-00dd-c798-d314-7893a8a948e6

The GUID or code of the fund list.

The json object representing the fund list definition.

subjectstring

Return queries with a subject equal to the specified value

subject-beginsstring

Return queries with a subject begins with the specified value

email-routing-codestring

Return queries where the email routing code equal the specified value

max-resultnumber
Example:100

The maximum number of query results is limited per search.

Response

Success

QueryGUIDstring
FundGUIDstring
Subjectstring
FinancialYearnumber
Detailsstring
Status'Draft' | 'With Client' | 'With Administrator' | 'Responded' | 'Completed'
QueryDateTimestring date-time
LastMessageHasBeenReadboolean
LastMessageDateTimestring date-time
LastMessageTextstring
LastMessageStatusstring
LastStatusUpdateDateTimestring date-time
LastFollowUpDateTimestring date-time
NumberOfAttachmentsnumber
EmailRoutingCodestring
WorkflowInstanceNodeIDnumber
WorkflowInstanceIDnumber
WorkflowTemplateNamestring
WorkflowNodeNamestring
QueryCreatedByNamestring
QueryCreatedByEmailstring
QueryCreatedByCodestring
QuerySentByNamestring
QuerySentByEmailstring
LastMessageSentDateTimestring date-time
Prioritystring
DueDatestring date
QueryOwnerstring
HasDraftMessageboolean
QueryTemplateGUIDstring guid
QueryTemplateNamestring
EntitySourceRecordNamestring
EntitySourceRecordType'MEMBER' | 'PENSION' | 'ACCOUNT'
EntitySourceRecordGUIDstring guid
SystemGeneratedboolean

Example response

[
  {
    "QueryGUID": "6a9ce773-5011-308e-7914-73d18ced3493",
    "FundGUID": "6a9ce773-5011-308e-7914-73d18ced3491",
    "Subject": "Subject",
    "FinancialYear": 2022,
    "Details": "Details",
    "QueryDateTime": "2020-03-24T15:55:52.679+07:00",
    "LastMessageHasBeenRead": true,
    "LastMessageDateTime": "2020-03-25T15:55:52.679+07:00",
    "LastMessageText": "Hello, please provide the latest trust deed",
    "LastMessageStatus": "Draft",
    "LastStatusUpdateDateTime": "2020-03-24T15:55:52.679+07:00",
    "LastFollowUpDateTime": "2020-03-24T15:55:52.679+07:00",
    "EmailRoutingCode": "163",
    "WorkflowTemplateName": "Workflow Process example",
    "WorkflowNodeName": "Manual node 1",
    "Type": {
      "Code": "GENERAL",
      "Description": "General client query"
    },
    "QueryCreatedByName": "UserName",
    "QueryCreatedByCode": "john.doe",
    "LastMessageSentDateTime": "2020-03-24T15:55:52.679+07:00",
    "RelatedEntities": {
      "Transaction": {
        "TransactionGUID": "6a9ce773-5011-308e-7914-73d18ced3493",
        "Date": "2020-03-24",
        "Payment": 100
      }
    },
    "Priority": "Normal",
    "DueDate": "2023-06-30",
    "QueryOwner": "query.owner@superconcepts.com.au",
    "QueryTemplateGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf2",
    "QueryTemplateName": "Query Template Name",
    "EntitySourceRecordName": "Entity Source Record Name",
    "EntitySourceRecordGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf1"
  }
]

Changes

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