Documents

Gets a single submission of a structured document, with its answers and attachments.

Takes the submission’s Id, or any of its version ids - a document’s related items and a link copied from the app name a submission by its version id - and always answers with the current version. Answers are shown against the structured document as it is now, as the Gorelo app shows them: current question text and order, a question added since the save listed unanswered, an answer to a deleted question left out, and chosen options matched to the current options by name. Title falls back to the structured document’s name when no title question is answered.

GET

documents

structured

{structuredDocumentId}

submissions

{submissionId}

Gets a single submission of a structured document, with its answers and attachments.

curl --request GET \
  --url https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId}"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "<string>",
    "Title": "<string>",
    "VersionId": "<string>",
    "Version": 123,
    "StructuredDocumentId": "<string>",
    "ClientId": 123,
    "Answers": [
      {
        "FieldId": "<string>",
        "Label": "<string>",
        "Type": "<string>",
        "TextValue": "<string>",
        "NumberValue": 123,
        "OptionValues": [
          "<string>"
        ],
        "ImageUrls": [
          "<string>"
        ],
        "AgentAssetIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "CustomAssetIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "ContactIds": [
          123
        ],
        "DocumentIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "StructuredDocumentSubmissions": [
          {
            "StructuredDocumentId": "<string>",
            "SubmissionId": "<string>"
          }
        ],
        "UptimeIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      }
    ],
    "Attachments": [
      {
        "Name": "<string>",
        "Url": "<string>"
      }
    ],
    "CreatedOn": "2023-11-07T05:31:56Z",
    "CreatedById": 123,
    "UpdatedOn": "2023-11-07T05:31:56Z"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Path Parameters

structuredDocumentId

string

required

Structured document identifier, or one of its version ids.

Pattern: ^[A-Za-z0-9_-]{1,64}$

submissionId

string

required

Submission identifier, or one of its version ids.

Pattern: ^[A-Za-z0-9_-]{1,64}$

Response

StatusCode

enum<integer>

Available options:

100,

101,

102,

103,

200,

201,

202,

203,

204,

205,

206,

207,

208,

226,

300,

301,

302,

303,

304,

305,

306,

307,

308,

400,

401,

402,

403,

404,

405,

406,

407,

408,

409,

410,

411,

412,

413,

414,

415,

416,

417,

421,

422,

423,

424,

426,

428,

429,

431,

451,

500,

501,

502,

503,

504,

505,

506,

507,

508,

510,

511

IsSuccess

boolean

Data

object

A single submission, with its attachments.

Show child attributes

DataContext

object | null

Example:

null

Notifications

object[]

Show child attributes

⌘I

Gets a single submission of a structured document, with its answers and attachments.

curl --request GET \
  --url https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId} \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId}"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId}"

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

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/documents/structured/{structuredDocumentId}/submissions/{submissionId}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "<string>",
    "Title": "<string>",
    "VersionId": "<string>",
    "Version": 123,
    "StructuredDocumentId": "<string>",
    "ClientId": 123,
    "Answers": [
      {
        "FieldId": "<string>",
        "Label": "<string>",
        "Type": "<string>",
        "TextValue": "<string>",
        "NumberValue": 123,
        "OptionValues": [
          "<string>"
        ],
        "ImageUrls": [
          "<string>"
        ],
        "AgentAssetIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "CustomAssetIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "ContactIds": [
          123
        ],
        "DocumentIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "StructuredDocumentSubmissions": [
          {
            "StructuredDocumentId": "<string>",
            "SubmissionId": "<string>"
          }
        ],
        "UptimeIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ]
      }
    ],
    "Attachments": [
      {
        "Name": "<string>",
        "Url": "<string>"
      }
    ],
    "CreatedOn": "2023-11-07T05:31:56Z",
    "CreatedById": 123,
    "UpdatedOn": "2023-11-07T05:31:56Z"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}