Node.js / easybill REST API / Fetch attachments list
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
var queryParams = new chilkat.JsonObject();
queryParams.UpdateString("limit","<integer>");
queryParams.UpdateString("page","<integer>");
http.SetRequestHeader("Authorization","{{apiKey}}");
http.SetRequestHeader("Accept","application/json");
// resp: HttpResponse
var resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/attachments",queryParams);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "page": "<integer>",
// "pages": "<integer>",
// "limit": "<integer>",
// "total": "<integer>",
// "items": [
// {
// "created_at": "<date>",
// "customer_id": null,
// "document_id": null,
// "file_name": "<string>",
// "id": "<long>",
// "project_id": null,
// "size": "<integer>"
// },
// {
// "created_at": "<date>",
// "customer_id": null,
// "document_id": null,
// "file_name": "<string>",
// "id": "<long>",
// "project_id": null,
// "size": "<integer>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var created_at;
var customer_id;
var document_id;
var file_name;
var id;
var project_id;
var size;
var page = jResp.StringOf("page");
var pages = jResp.StringOf("pages");
var limit = jResp.StringOf("limit");
var total = jResp.StringOf("total");
var i = 0;
var count_i = jResp.SizeOfArray("items");
while (i < count_i) {
jResp.I = i;
created_at = jResp.StringOf("items[i].created_at");
customer_id = jResp.StringOf("items[i].customer_id");
document_id = jResp.StringOf("items[i].document_id");
file_name = jResp.StringOf("items[i].file_name");
id = jResp.StringOf("items[i].id");
project_id = jResp.StringOf("items[i].project_id");
size = jResp.StringOf("items[i].size");
i = i+1;
}
}
chilkatExample();
Curl Command
curl -G -d "limit=%3Cinteger%3E"
-d "page=%3Cinteger%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/attachments
Postman Collection Item JSON
{
"name": "Fetch attachments list",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/attachments?limit=<integer>&page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"attachments"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/attachments?limit=<integer>&page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"attachments"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Limited the result. Default is 100. Maximum can be 1000."
},
{
"key": "page",
"value": "<integer>",
"description": "Set current Page. Default is 1."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"page\": \"<integer>\",\n \"pages\": \"<integer>\",\n \"limit\": \"<integer>\",\n \"total\": \"<integer>\",\n \"items\": [\n {\n \"created_at\": \"<date>\",\n \"customer_id\": null,\n \"document_id\": null,\n \"file_name\": \"<string>\",\n \"id\": \"<long>\",\n \"project_id\": null,\n \"size\": \"<integer>\"\n },\n {\n \"created_at\": \"<date>\",\n \"customer_id\": null,\n \"document_id\": null,\n \"file_name\": \"<string>\",\n \"id\": \"<long>\",\n \"project_id\": null,\n \"size\": \"<integer>\"\n }\n ]\n}"
}
]
}