Query Topics

Description

When sending messages to a clinical organisation, it's essential to categorize them using message topics. These topics help define the type of message being sent to the recipient. The list of available topics is relatively stable and doesn't change frequently. Therefore, your system can retrieve the list of topics and cache it for reference, as it's considered reference data. This approach ensures that your system always has access to the most up-to-date list of topics when sending messages.

HTTP Definition

Method: GET
Endpoint URL: /api/v1/topics

Headers

The following HTTP headers are required with this request:

Name Data Type Notes
ApiKey string The unique key issued by Quicksilva to identify your system.

URL Parameters

The request contains no URL parameters.

Request JSON Definition

This message does not include a request payload.

GET https://int.conneqt.health/api/v1/topics HTTP/1.1
ApiKey: <API-KEY-PLACEHOLDER>

Response JSON Definition

Name Cardinality Data Type Notes
root 1..1 array An array of topics that the system will approve and process.
root[0].topicName 1..1 string The string value representing the name of the topic. 
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
    {
        "topicName": "topic-1"
    },
    {
        "topicName": "topic-2"
    }
]

Error Responses

If there was an issue processing your request, a HTTP error response will be returned, containing details of the issue. Common problems include:

  • One or more invalid data items were found in the request.
  • The intended recipient organisation is not one that uses our system.

The system uses the definition of an IETF Problem, as described in RFC 7807, in error responses to provide machine-readable details of why a request was rejected. The content of the Problem returned depends on the nature of the issue.

HTTP Response Code HTTP Reason Code Description
401 Unauthorized Missing or Invalid API Key in the Request Header.
403 Forbidden Unauthorized Client System - The Provided API Key Is Valid but Not Authorized.
500 Internal Server Error Internal Server Error - An Internal Server Error Prevented the Request from Being Processed.

See Also