GetDocumentSet

curl --request POST \
  --url https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet"

payload = { "documentSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "Connect-Protocol-Version": "<connect-protocol-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Connect-Protocol-Version': '<connect-protocol-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({documentSetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet', 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://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'documentSetId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Connect-Protocol-Version: <connect-protocol-version>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet"

	payload := strings.NewReader("{\n  \"documentSetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"documentSetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet")

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

request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"documentSetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "<string>",
  "createdAt": "2023-01-15T01:30:15.01Z",
  "transloaditAssemblyId": "<string>",
  "transloaditAssemblyError": "<string>",
  "summary": [
    "<string>"
  ],
  "documents": [
    {
      "id": "<string>",
      "contentType": "<string>",
      "sizeBytes": "<string>",
      "name": "<string>",
      "originalUrl": "<string>",
      "originalMd5": "<string>",
      "nrOfPages": "<string>",
      "thumbnailUrl": "<string>",
      "pdfUrl": "<string>",
      "pageImageUrls": [
        "<string>"
      ],
      "bucketName": "<string>",
      "objectKey": "<string>",
      "fingerprintSha256": "aSDinaTvuI8gbWludGxpZnk=",
      "hasParsedMarkdown": true,
      "failureReason": "<string>",
      "failureMessage": "<string>",
      "failureStep": "<string>"
    }
  ],
  "nonDocuments": [
    {
      "id": "<string>",
      "contentType": "<string>",
      "sizeBytes": "<string>",
      "name": "<string>",
      "originalUrl": "<string>",
      "originalMd5": "<string>",
      "bucketName": "<string>",
      "objectKey": "<string>",
      "fingerprintSha256": "aSDinaTvuI8gbWludGxpZnk="
    }
  ],
  "sourceJobApplicationId": "<string>",
  "sourceEmailReceiptId": "<string>",
  "crewProfileId": "<string>",
  "filingState": "DOCUMENT_SET_FILING_STATE_UNSPECIFIED",
  "filingComment": "<string>",
  "sourceDocumentRequestId": "<string>"
}

{
  "code": "not_found",
  "message": "<string>",
  "details": [
    {
      "type": "<string>",
      "value": "<string>",
      "debug": {}
    }
  ]
}

POST

rpc

rpc.v1.OrganizationService

GetDocumentSet

curl --request POST \
  --url https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet"

payload = { "documentSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
    "Connect-Protocol-Version": "<connect-protocol-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Connect-Protocol-Version': '<connect-protocol-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({documentSetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet', 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://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'documentSetId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Connect-Protocol-Version: <connect-protocol-version>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet"

	payload := strings.NewReader("{\n  \"documentSetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet")
  .header("Connect-Protocol-Version", "<connect-protocol-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"documentSetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://edge.sterndesk.com/rpc/rpc.v1.OrganizationService/GetDocumentSet")

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

request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"documentSetId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "<string>",
  "createdAt": "2023-01-15T01:30:15.01Z",
  "transloaditAssemblyId": "<string>",
  "transloaditAssemblyError": "<string>",
  "summary": [
    "<string>"
  ],
  "documents": [
    {
      "id": "<string>",
      "contentType": "<string>",
      "sizeBytes": "<string>",
      "name": "<string>",
      "originalUrl": "<string>",
      "originalMd5": "<string>",
      "nrOfPages": "<string>",
      "thumbnailUrl": "<string>",
      "pdfUrl": "<string>",
      "pageImageUrls": [
        "<string>"
      ],
      "bucketName": "<string>",
      "objectKey": "<string>",
      "fingerprintSha256": "aSDinaTvuI8gbWludGxpZnk=",
      "hasParsedMarkdown": true,
      "failureReason": "<string>",
      "failureMessage": "<string>",
      "failureStep": "<string>"
    }
  ],
  "nonDocuments": [
    {
      "id": "<string>",
      "contentType": "<string>",
      "sizeBytes": "<string>",
      "name": "<string>",
      "originalUrl": "<string>",
      "originalMd5": "<string>",
      "bucketName": "<string>",
      "objectKey": "<string>",
      "fingerprintSha256": "aSDinaTvuI8gbWludGxpZnk="
    }
  ],
  "sourceJobApplicationId": "<string>",
  "sourceEmailReceiptId": "<string>",
  "crewProfileId": "<string>",
  "filingState": "DOCUMENT_SET_FILING_STATE_UNSPECIFIED",
  "filingComment": "<string>",
  "sourceDocumentRequestId": "<string>"
}

{
  "code": "not_found",
  "message": "<string>",
  "details": [
    {
      "type": "<string>",
      "value": "<string>",
      "debug": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Personal API key, sent as Authorization: Bearer <key>.

Headers

Connect-Protocol-Version

number

required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms

number

Define the timeout, in ms

Example:

1000

Body

application/json

request for getting an email receipt

documentSetId

string<uuid>

id of the document set

Response

Success

response from getting the email receipt

string

id of the document set

createdAt

string<date-time>

time at which the document set was created

Example:

"2023-01-15T01:30:15.01Z"

transloaditAssemblyId

string

the assembly from handling it on transloadit

transloaditAssemblyError

string | null

possible error in handling the assembly on transloadit

summary

string[]

summary of the document set

documents

Document · object[]

documents in a document set.

Show child attributes

nonDocuments

NonDocument · object[]

non-documents in the document set.

Show child attributes

sourceJobApplicationId

string | null

Optional ID of the source job application that created the document set

sourceEmailReceiptId

string | null

Optional ID of the source email receipt that created the document set

crewProfileId

string | null

Optional ID of the crew profile with which the document set is filed

filingState

enum<string>

Filing state of the document set: UNFILED, FILED, or FILING_ERROR

Available options:

DOCUMENT_SET_FILING_STATE_UNSPECIFIED,

DOCUMENT_SET_FILING_STATE_UNFILED,

DOCUMENT_SET_FILING_STATE_FILED,

DOCUMENT_SET_FILING_STATE_FILING_ERROR

filingComment

string | null

Optional comment explaining why the document set was filed with a crew profile or why it failed

sourceDocumentRequestId

string | null

Optional ID of the source document request that created the document set

Overview

Endpoints

GetDocumentSet

Authorizations

Headers

Body

Response