Endpoint Details

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

Request

HTTP Method: GET

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

Parameters

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

Authentication: Basic Authentication (Username and Password required)

Responses

{
  "id": "4a30e9aa-f73a-4c7c-b267-86b18adf5b04",
  "dateCreated": "2025-01-01T12:00:00.000+00:00",
  "status": "Success",
  "hasWarnings": true
}

{
  "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.
dateCreated	DateTime	The timestamp when the positions were uploaded.
status	String	The current status of the file upload. Possible values: InProgress, Success, Failed, Cancelled, UnexpectedError. (explained below)
hasWarnings	Boolean	Indicates whether there are any warnings or errors associated with the enrichment process. (Check the UI for more details)

Status values

Status	Description
InProgress	The file upload is in progress.
Success	The file has been uploaded successfully.
Failed	The file upload has failed. (Check the UI for errors)
Cancelled	The file upload was cancelled.
UnexpectedError	Unexpected Error occurred while upload, please contact support

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.

For further details, refer to the API specifications or contact support.