Download Mapped File Or Sample File

GET

/api/MappingTool/DownloadFile

Downloads the output of a completed offline mapping run, or the blank sample file.

Pass runId to download that run's mapped output, named {runId}-roommapping-output.csv. Omit runId entirely to download the sample file instead, named filebasedroom-mapping-template.csv. To confirm your header row before uploading, use the input template linked in the File Based Room Mapping (Offline) section, because headers are matched exactly and letter case matters.

Check the response content type before treating the body as a file. A successful download returns text/csv. A failure, such as an unknown runId or a run that has not completed, also returns HTTP 200 but with a JSON error body rather than CSV.

Only runs with status Completed have an output file. Check the status first with Get File Mapping Status.

You can download only your own runs. A runId belonging to another account is refused with the same error the API returns for an invalid token.

Request

Query Params

Header Params

Responses

🟢200

application/json

The mapped output file, the sample file, or a JSON error body. Distinguish them by content type.

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://roommapping.vervotech.com/api/MappingTool/DownloadFile?runId=6f2a1c94-6c1d-4f0f-9a0e-2b7d5f1e8c13' \
--header 'accountId: demoAccount' \
--header 'token: demoApiToken'

Response Example

{
    "success": false,
    "message": "string",
    "errorCode": 2004
}

Map Board Basis

Submit Rooms File