downloadDocument
curl --request GET \
--url 'https://sandbox.rollfi.xyz/adminPortal#downloadDocument' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "downloadDocument",
"documentId": "24A9F639-689C-4E7D-80CB-14AD3A608B21"
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal#downloadDocument"
payload = {
"method": "downloadDocument",
"documentId": "24A9F639-689C-4E7D-80CB-14AD3A608B21"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({method: 'downloadDocument', documentId: '24A9F639-689C-4E7D-80CB-14AD3A608B21'})
};
fetch('https://sandbox.rollfi.xyz/adminPortal#downloadDocument', 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://sandbox.rollfi.xyz/adminPortal#downloadDocument",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'downloadDocument',
'documentId' => '24A9F639-689C-4E7D-80CB-14AD3A608B21'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://sandbox.rollfi.xyz/adminPortal#downloadDocument"
payload := strings.NewReader("{\n \"method\": \"downloadDocument\",\n \"documentId\": \"24A9F639-689C-4E7D-80CB-14AD3A608B21\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.get("https://sandbox.rollfi.xyz/adminPortal#downloadDocument")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"downloadDocument\",\n \"documentId\": \"24A9F639-689C-4E7D-80CB-14AD3A608B21\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal#downloadDocument")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"downloadDocument\",\n \"documentId\": \"24A9F639-689C-4E7D-80CB-14AD3A608B21\"\n}"
response = http.request(request)
puts response.read_body{
"documentId": "24A9F639-689C-4E7D-80CB-14AD3A608B21",
"companyId": "6FFBAEFF-020F-4F63-A140-0348BD0F0FCB",
"employeeId": "161978BD-C696-495A-87DC-226B9D0D5A3B",
"payPeriodId": null,
"fileName": "sample-document.pdf",
"documentType": "Team Documents",
"fileBase64": "JVeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2sssVzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8ChegHl80UERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQo+PgovQ29udGVudHMgNCAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL0xlbmd0aCA0NAo+PgpzdHJlYW0KQlQKL0YxIDEyIFRmCjcyIDcyMCBUZAooSGVsbG8gV29ybGQpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKeHJlZHwgHllLMha6Gh9DAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMAowMDAwMDAwMjQ1IDAwMDAwIG4gCnRyYWlsZXIKPDwKL1NpemUgNQovUm9vdCAxIDAgUgo+PgpzdGFydHhyZWYKMzM4CiUlRU9G",
"downloadCount": 1
}{
"error": {
"code": 400,
"message": "documentId is required"
}
}Admin Portal
downloadDocument
The downloadDocument API is used to download a document that has been uploaded to the Rollfi system
GET
/
adminPortal#downloadDocument
downloadDocument
curl --request GET \
--url 'https://sandbox.rollfi.xyz/adminPortal#downloadDocument' \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "downloadDocument",
"documentId": "24A9F639-689C-4E7D-80CB-14AD3A608B21"
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal#downloadDocument"
payload = {
"method": "downloadDocument",
"documentId": "24A9F639-689C-4E7D-80CB-14AD3A608B21"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({method: 'downloadDocument', documentId: '24A9F639-689C-4E7D-80CB-14AD3A608B21'})
};
fetch('https://sandbox.rollfi.xyz/adminPortal#downloadDocument', 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://sandbox.rollfi.xyz/adminPortal#downloadDocument",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'downloadDocument',
'documentId' => '24A9F639-689C-4E7D-80CB-14AD3A608B21'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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://sandbox.rollfi.xyz/adminPortal#downloadDocument"
payload := strings.NewReader("{\n \"method\": \"downloadDocument\",\n \"documentId\": \"24A9F639-689C-4E7D-80CB-14AD3A608B21\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.get("https://sandbox.rollfi.xyz/adminPortal#downloadDocument")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"downloadDocument\",\n \"documentId\": \"24A9F639-689C-4E7D-80CB-14AD3A608B21\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal#downloadDocument")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"downloadDocument\",\n \"documentId\": \"24A9F639-689C-4E7D-80CB-14AD3A608B21\"\n}"
response = http.request(request)
puts response.read_body{
"documentId": "24A9F639-689C-4E7D-80CB-14AD3A608B21",
"companyId": "6FFBAEFF-020F-4F63-A140-0348BD0F0FCB",
"employeeId": "161978BD-C696-495A-87DC-226B9D0D5A3B",
"payPeriodId": null,
"fileName": "sample-document.pdf",
"documentType": "Team Documents",
"fileBase64": "JVeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2sssVzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8ChegHl80UERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQo+PgovQ29udGVudHMgNCAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL0xlbmd0aCA0NAo+PgpzdHJlYW0KQlQKL0YxIDEyIFRmCjcyIDcyMCBUZAooSGVsbG8gV29ybGQpIFRqCkVUCmVuZHN0cmVhbQplbmRvYmoKeHJlZHwgHllLMha6Gh9DAwMCA2NTUzNSBmIAowMDAwMDAwMDA5IDAwMDAwIG4gCjAwMDAwMDAwNTggMDAwMDAgbiAKMAowMDAwMDAwMjQ1IDAwMDAwIG4gCnRyYWlsZXIKPDwKL1NpemUgNQovUm9vdCAxIDAgUgo+PgpzdGFydHhyZWYKMzM4CiUlRU9G",
"downloadCount": 1
}{
"error": {
"code": 400,
"message": "documentId is required"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
⌘I
