Tasks

Update a query.

post/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

Request body

FundGUIDstring
FundIdentifierstring required
Subjectstring
FinancialYearnumber required
Detailsstring required
Status'Draft' | 'With Client' | 'With Administrator' | 'Responded' | 'Completed' required
PrivacyLevel'CONFIDENTIAL' | 'NO-RESTRICTION'
Prioritystring
DueDatestring date
ReminderStartDatestring date
ReminderFrequencystring
Type'GENERAL' | 'TRANSACTION' | 'DOCUMENT-REQUEST' | 'QUERY-FROM-CLIENT' | 'QUERY-FROM-AUDITOR' required
SourceUserNamestring
QueryTemplateGUIDstring guid
EntitySourceRecordType'MEMBER' | 'PENSION' | 'ACCOUNT'
EntitySourceRecordGUIDstring guid

Example request

{
  "FundGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf7",
  "FundIdentifier": "FUNDCODE001",
  "Subject": "Query subject",
  "FinancialYear": 2022,
  "Details": "Query details",
  "Priority": "Normal",
  "DueDate": "2023-07-15",
  "ReminderStartDate": "2023-08-15",
  "ReminderFrequency": "None",
  "SourceUserName": "Mary Smith <mary.smith@superconcepts.com.au>",
  "AvailableClientViewRoleTypes": [
    "AUDITOR",
    "ADVISER",
    "TRUSTEE"
  ],
  "QueryTemplateGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf2",
  "EntitySourceRecordGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf1"
}

Response

Success

QueryGUIDstring
FundGUIDstring
FundIdentifierstring
Subjectstring
FinancialYearnumber
Detailsstring
Status'Draft' | 'With Client' | 'With Administrator' | 'Responded' | 'Completed'
Prioritystring
DueDatestring date
ReminderStartDatestring date
ReminderFrequencystring

Example response

{
  "QueryGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf0",
  "FundGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf7",
  "FundIdentifier": "FUNDCODE001",
  "Subject": "Query subject",
  "FinancialYear": 2022,
  "Details": "Query details",
  "Type": {
    "Code": "GENERAL",
    "Description": "General client query"
  },
  "Priority": "Normal",
  "DueDate": "2023-07-15",
  "ReminderStartDate": "2023-08-15",
  "ReminderFrequency": "None"
}

Changes

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