Endpoint Details

This API endpoint provides clients with the ability to retrieve messages of the positions upload run.

Request

HTTP Method: GET

URL: https://{environment_name}-api.fundapps.co/v3/data/positions/{id}/messages

Parameters

Parameter	Type	Required	Description
id	Guid	Yes	Unique identifier for positions upload

Authentication Basic Authentication (Username and Password required)

Responses

{
  "id": "17671429-cb4f-4501-b20c-75816a4ecc9c",
  "messages": [
    {
      "level": "Warning",
      "message": "Identifier: GB0000000000 | Refinitiv Classification Scheme value is missing, unable to construct instrument"
    },
    {
      "level": "Warning",
      "message": "Identifier: US0000000000 | Refinitiv extraction errored using identifier US0000000000. No data available. The data provider returned with Not found."
    }
  ]
}

{
  "type": "https://httpstatuses.com/404",
  "title": "Id not found",
  "status": 404,
  "detail": "Id could not be found",
  "id": [
    "Must be an existing file upload id"
  ]
}

Field	Type	Description
id	Guid	Unique identifier of the positions upload.
messages	Objects[]	Messages related to the positions upload run

Messages values

Parameter	Type	Description
level	String	Type of a message. either a Warning or an Error
message	String	Contents of the message.

Security

This API requires Basic Authentication. Clients must provide a valid username and password in the request header. For more details, see here.

Troubleshoot

If you receive a 400 Bad Request error, please check that the id is a valid Guid.
Unauthorized requests will result in a 401 Unauthorized response.
If you receive 403, please check your user has permissions to upload positions. To see more information on permission, check this article.