Download the answered file

GET

/api/v1/questionnaires/{id}/download

Returns DOCX or XLSX depending on the uploaded file, as an attachment. Requires an original file, the mapping metadata captured during import, and at least one answered item. Audited.

Authorizations

bearerAuth

Path Parameters

NameType

required

string

The record’s prefixed ID

Responses

200

The exported document

Response body

string format: binary

404

No original file attached, or no such questionnaire

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

422

Nothing to export (no metadata or no answers), or the export failed

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

Request

curl --request GET \
  --url https://app.responsehub.io/api/v1/questionnaires/example/download \
  --header 'Authorization: Bearer <token>'

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/questionnaires/example/download")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.responsehub.io/api/v1/questionnaires/example/download', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/questionnaires/example/download';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://app.responsehub.io/api/v1/questionnaires/example/download"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

404example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

422example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}