Tasks

Create a new query.

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

Request body

FundGUIDstring
FundIdentifierstring required
Subjectstring
FinancialYearnumber required
Detailsstring required
Status'Draft' | 'With Client' | 'With Administrator'
PrivacyLevel'CONFIDENTIAL' | 'NO-RESTRICTION'
Messagestring
Type'GENERAL' | 'TRANSACTION' | 'DOCUMENT-REQUEST' | 'QUERY-FROM-CLIENT' | 'QUERY-FROM-AUDITOR'
SourceUserNamestring
Prioritystring
DueDatestring date
ReminderStartDatestring date
ReminderFrequencystring
WorkflowInstanceIDnumber
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",
  "Message": "This is the message",
  "SourceUserName": "Mary Smith <mary.smith@superconcepts.com.au>",
  "RelatedEntities": {
    "TransactionGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf2"
  },
  "Priority": "Normal",
  "DueDate": "2023-07-15",
  "ReminderStartDate": "2023-08-15",
  "ReminderFrequency": "None",
  "WorkflowInstanceID": 333,
  "AvailableClientViewRoleTypes": [
    "AUDITOR",
    "ADVISER",
    "TRUSTEE"
  ],
  "QueryTemplateGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf2",
  "EntitySourceRecordGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf1"
}

Response

Created

QueryGUIDstring
MessageGUIDstring guid

Example response

{
  "QueryGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427aaf7",
  "MessageGUID": "d4ff4c08-995e-d1aa-7b14-7aaab427cc88"
}

Changes

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