Vault
Crear solicitud de documentos
cURL
curl --request POST \
--url https://app.edtools.co/api/client/v1/vault/requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignProfileToEntity": true,
"title": "<string>",
"requesterName": "<string>",
"requesterEmail": "jsmith@example.com",
"documentTypeIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subjects": [
{
"key": "<string>",
"label": "<string>",
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subtitle": "<string>"
}
],
"expiresInDays": 30,
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityExternalId": "<string>"
}
'import requests
url = "https://app.edtools.co/api/client/v1/vault/requests"
payload = {
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignProfileToEntity": True,
"title": "<string>",
"requesterName": "<string>",
"requesterEmail": "jsmith@example.com",
"documentTypeIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"subjects": [
{
"key": "<string>",
"label": "<string>",
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subtitle": "<string>"
}
],
"expiresInDays": 30,
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityExternalId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
profileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assignProfileToEntity: true,
title: '<string>',
requesterName: '<string>',
requesterEmail: 'jsmith@example.com',
documentTypeIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
subjects: [
{
key: '<string>',
label: '<string>',
profileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
subtitle: '<string>'
}
],
expiresInDays: 30,
entityId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
entityExternalId: '<string>'
})
};
fetch('https://app.edtools.co/api/client/v1/vault/requests', 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://app.edtools.co/api/client/v1/vault/requests",
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([
'profileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'templateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assignProfileToEntity' => true,
'title' => '<string>',
'requesterName' => '<string>',
'requesterEmail' => 'jsmith@example.com',
'documentTypeIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'subjects' => [
[
'key' => '<string>',
'label' => '<string>',
'profileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subtitle' => '<string>'
]
],
'expiresInDays' => 30,
'entityId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'entityExternalId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.edtools.co/api/client/v1/vault/requests"
payload := strings.NewReader("{\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assignProfileToEntity\": true,\n \"title\": \"<string>\",\n \"requesterName\": \"<string>\",\n \"requesterEmail\": \"jsmith@example.com\",\n \"documentTypeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"subjects\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtitle\": \"<string>\"\n }\n ],\n \"expiresInDays\": 30,\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://app.edtools.co/api/client/v1/vault/requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assignProfileToEntity\": true,\n \"title\": \"<string>\",\n \"requesterName\": \"<string>\",\n \"requesterEmail\": \"jsmith@example.com\",\n \"documentTypeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"subjects\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtitle\": \"<string>\"\n }\n ],\n \"expiresInDays\": 30,\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.edtools.co/api/client/v1/vault/requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assignProfileToEntity\": true,\n \"title\": \"<string>\",\n \"requesterName\": \"<string>\",\n \"requesterEmail\": \"jsmith@example.com\",\n \"documentTypeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"subjects\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtitle\": \"<string>\"\n }\n ],\n \"expiresInDays\": 30,\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"request": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityKind": "<string>",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityLabel": "<string>",
"entitySubtitle": "<string>",
"entityPath": "<string>",
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"requesterName": "<string>",
"requesterEmail": "<string>",
"status": "<string>",
"expiresAt": "<string>",
"revokedAt": "<string>",
"completedAt": "<string>",
"archivedAt": "<string>",
"archivedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"openedAt": "<string>",
"lastActivityAt": "<string>",
"subjects": [
{
"key": "<string>",
"label": "<string>",
"subtitle": "<string>",
"profileId": "<string>",
"profileName": "<string>",
"profileKey": "<string>",
"sortOrder": 123
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
},
"publicUrl": "<string>",
"expiresAt": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Available options:
student, admission_application Maximum string length:
255Maximum string length:
255Maximum string length:
320Maximum array length:
20Maximum array length:
8Show child attributes
Show child attributes
Required range:
0 < x <= 60Required string length:
1 - 160Response
201 - application/json
Created Vault document request
Show child attributes
Show child attributes
Was this page helpful?
cURL
curl --request POST \
--url https://app.edtools.co/api/client/v1/vault/requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignProfileToEntity": true,
"title": "<string>",
"requesterName": "<string>",
"requesterEmail": "jsmith@example.com",
"documentTypeIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"subjects": [
{
"key": "<string>",
"label": "<string>",
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subtitle": "<string>"
}
],
"expiresInDays": 30,
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityExternalId": "<string>"
}
'import requests
url = "https://app.edtools.co/api/client/v1/vault/requests"
payload = {
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignProfileToEntity": True,
"title": "<string>",
"requesterName": "<string>",
"requesterEmail": "jsmith@example.com",
"documentTypeIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"subjects": [
{
"key": "<string>",
"label": "<string>",
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"subtitle": "<string>"
}
],
"expiresInDays": 30,
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityExternalId": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
profileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
assignProfileToEntity: true,
title: '<string>',
requesterName: '<string>',
requesterEmail: 'jsmith@example.com',
documentTypeIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
subjects: [
{
key: '<string>',
label: '<string>',
profileId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
subtitle: '<string>'
}
],
expiresInDays: 30,
entityId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
entityExternalId: '<string>'
})
};
fetch('https://app.edtools.co/api/client/v1/vault/requests', 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://app.edtools.co/api/client/v1/vault/requests",
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([
'profileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'templateId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'assignProfileToEntity' => true,
'title' => '<string>',
'requesterName' => '<string>',
'requesterEmail' => 'jsmith@example.com',
'documentTypeIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'subjects' => [
[
'key' => '<string>',
'label' => '<string>',
'profileId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'subtitle' => '<string>'
]
],
'expiresInDays' => 30,
'entityId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'entityExternalId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://app.edtools.co/api/client/v1/vault/requests"
payload := strings.NewReader("{\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assignProfileToEntity\": true,\n \"title\": \"<string>\",\n \"requesterName\": \"<string>\",\n \"requesterEmail\": \"jsmith@example.com\",\n \"documentTypeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"subjects\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtitle\": \"<string>\"\n }\n ],\n \"expiresInDays\": 30,\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://app.edtools.co/api/client/v1/vault/requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assignProfileToEntity\": true,\n \"title\": \"<string>\",\n \"requesterName\": \"<string>\",\n \"requesterEmail\": \"jsmith@example.com\",\n \"documentTypeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"subjects\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtitle\": \"<string>\"\n }\n ],\n \"expiresInDays\": 30,\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.edtools.co/api/client/v1/vault/requests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"templateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"assignProfileToEntity\": true,\n \"title\": \"<string>\",\n \"requesterName\": \"<string>\",\n \"requesterEmail\": \"jsmith@example.com\",\n \"documentTypeIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"subjects\": [\n {\n \"key\": \"<string>\",\n \"label\": \"<string>\",\n \"profileId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"subtitle\": \"<string>\"\n }\n ],\n \"expiresInDays\": 30,\n \"entityId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"entityExternalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"request": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityKind": "<string>",
"entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityLabel": "<string>",
"entitySubtitle": "<string>",
"entityPath": "<string>",
"profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"requesterName": "<string>",
"requesterEmail": "<string>",
"status": "<string>",
"expiresAt": "<string>",
"revokedAt": "<string>",
"completedAt": "<string>",
"archivedAt": "<string>",
"archivedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"openedAt": "<string>",
"lastActivityAt": "<string>",
"subjects": [
{
"key": "<string>",
"label": "<string>",
"subtitle": "<string>",
"profileId": "<string>",
"profileName": "<string>",
"profileKey": "<string>",
"sortOrder": 123
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
},
"publicUrl": "<string>",
"expiresAt": "<string>"
}
}