Get attachment download URL

Purpose

This call is used to get a temporary link for downloading an attachment. Use the link with an HTTP GET request to read the file. The file is not returned by this call itself.

A link is only given out once the file has passed the virus scan. See Attachments for the full picture.

How to request data

HTTP method: GET

• Constants and parameters enclosed in curly brackets { } must be replaced with their values.
• Please see the following Request parameters section with the required and optional parameters tables for these values. The generic URL format is as follows.

URL request format

1
https://{baseURL}/maps/orbis/feedback/{feedbackId}/attachments/{attachmentId}/download-url?key={API-key}&apiVersion={version}

Request parameters

The following table describes the parameters that can be used in a request.

• Required parameters must be used or the call will fail.

Response data

The scanState field tells you whether the file is ready to be downloaded:

• CLEAN - the file passed the virus scan. downloadUrl holds the link and expiresAt tells you when it stops working. It points at TomTom’s file storage on *.blob.core.windows.net and already carries a temporary access token, so use it exactly as you received it. The link is valid for 15 minutes; if it expires, simply make this call again.
• PENDING - the virus scan is still running, so no link is given yet. Wait a moment and try again.

A file that did not pass the virus scan is never handed out. In that case the call fails with the HTTP code 409.

Response codes

1
{
2
  "downloadUrl": "https://{storageHost}/attachments/{blobId}?{sasToken}",
3
  "expiresAt": "2026-09-23T10:22:41.114166",
4
  "scanState": "CLEAN"
5
}

1
{
2
  "downloadUrl": "",
3
  "scanState": "PENDING"
4
}

1
{
2
  "detailedError": {
3
    "code": "Forbidden",
4
    "message": "You are not allowed to access this endpoint"
5
  }
6
}

1
{
2
  "errorText": "Attachment '6b48dd3c-6d0c-4b0a-9a6e-1f1c0e2a51f4' not found for feedback '7049aa04-91bd-4ad3-8085-bd8bec318905'",
3
  "detailedError": {
4
    "code": "NOT_FOUND",
5
    "message": "Attachment '6b48dd3c-6d0c-4b0a-9a6e-1f1c0e2a51f4' not found for feedback '7049aa04-91bd-4ad3-8085-bd8bec318905'"
6
  },
7
  "httpStatusCode": 404
8
}

1
{
2
  "errorText": "The attachment did not pass the malware scan",
3
  "detailedError": {
4
    "code": "CONFLICT",
5
    "message": "The attachment did not pass the malware scan"
6
  },
7
  "httpStatusCode": 409
8
}

1
{
2
  "errorText": "An unexpected error has occurred. Please try again later.",
3
  "detailedError": {
4
    "code": "INTERNAL_SERVER_ERROR",
5
    "message": "An unexpected error has occurred. Please try again later."
6
  },
7
  "httpStatusCode": 500
8
}