Tasks

Returns the messages for a specified query.

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

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}/messages
  • 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

Response

Success

MessageGUIDstring
Messagestring
CreateDateTimestring date-time
LastUpdateDateTimestring date-time
SentDateTimestring date-time
HasBeenReadboolean
Status'Draft' | 'Ready' | 'Sent' | 'With Client' | 'With Administrator' | 'Completed' | 'Match To Query'

Example response

[
  {
    "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
      }
    ]
  }
]

Changes

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