Documents

Lists the submissions of a structured document.

One row per submission, showing its current version and answers; a deleted one is never listed. Id stays the same when the submission is edited; VersionId changes. 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

Lists the submissions of a structured document.

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

import requests

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

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', 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",
  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"

	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")

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"
          ]
        }
      ],
      "CreatedOn": "2023-11-07T05:31:56Z",
      "CreatedById": 123,
      "UpdatedOn": "2023-11-07T05:31:56Z"
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "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>"
    }
  ]
}

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

Autorizações

X-API-Key

string

header

obrigatório

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.

Parâmetros de caminho

structuredDocumentId

string

obrigatório

Structured document identifier, or one of its version ids.

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

Parâmetros de consulta

Cursor

string

Opaque pagination cursor from a previous page; omit for the first page.

PageSize

integer<int32>

padrão:50

Number of items per page, 1-200 (default 50). Out of range is rejected, not clamped.

ClientIds

string

Comma-separated client ids; only those clients' submissions. Max 100.

SortBy

string

padrão:createdOn

Sort field: createdOn (default) or updatedOn.

SortOrder

string

padrão:desc

Sort direction: asc or desc (default).

Resposta

StatusCode

enum<integer>

Opções disponíveis:

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[] | null

Show child attributes

DataContext

object

The DataContext of a cursor-paginated success response: carries the paging metadata for the returned page.

Show child attributes

Notifications

object[]

Show child attributes

⌘I

Lists the submissions of a structured document.

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

import requests

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

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', 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",
  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"

	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")

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"
          ]
        }
      ],
      "CreatedOn": "2023-11-07T05:31:56Z",
      "CreatedById": 123,
      "UpdatedOn": "2023-11-07T05:31:56Z"
    }
  ],
  "DataContext": {
    "Pagination": {
      "NextCursor": "<string>",
      "PreviousCursor": "<string>",
      "HasMore": true,
      "HasPrevious": true,
      "TotalCount": 123
    }
  },
  "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>"
    }
  ]
}

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