New API Reference portal - HighQ API Responses incorrect

Just wanted to highlight to TR that the API responses given in the reference section for HighQ API are incorrect.

API Reference:

https://developers.thomsonreuters.com/pages/api-reference/bf5a65d2-7bbd-4164-9596-eb6591c4cb1b#Overview

Example:

Activity - Get Comment

GET /{version}/comments

200 Response

{
    "properties": {
        "comment": {
            "items": {
                "properties": {
                    "id": {
                        "type": "string"
                    },
                    "text": {
                        "type": "string"
                    },
                    "html": {
                        "type": "string"
                    },
                    "author": {
                        "$ref": "#/definitions/Actor"
                    },
                    "datepublished": {
                        "type": "string"
                    },
                    "nooflikes": {
                        "type": "integer",
                        "format": "int32"
                    },
                    "images": {
                        "$ref": "#/definitions/Images"
                    },
                    "attachments": {
                        "$ref": "#/definitions/ActivityAttachmentsDBO"
                    },
                    "permissions": {
                        "$ref": "#/definitions/Permissions"
                    },
                    "timepublisedutc": {
                        "type": "string"
                    },
                    "userLikes": {
                        "$ref": "#/definitions/Likes"
                    }
                },
                "type": "object"
            },
            "type": "array"
        }
    },
    "type": "object"
}

This is not the response you receive! Instead it looks like it's the (JSON) schema of the response, not the format of the actual response.

This should look something like:

{
	"comment": [
		{
			"id": "string",
			"text": "string",
			"html": "string",
			"author": {
			  ...
			},
			"datepublished": "string",
			"nooflikes": 0,
			"images": {
			  ...
			},
			"attachments": {
			  ...
			},
			"permissions": {
			  ...
			},
			"timepublisedutc": {
			  ...
			},
			"userLikes": {
			  ...
			}
		}
	]
}

  • 0
    Thomson Reuters Thomson Reuters staff member

    Hi Andrew, thank you for this - I've asked the team to look into this and make any updates required.