Ruby / easybill REST API / Download a document as an jpeg-image
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("offset","<long>")
queryParams.UpdateString("limit","<long>")
http.SetRequestHeader("Authorization","{{apiKey}}")
http.SetRequestHeader("Accept","image/jpeg")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/documents/:id/jpg",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
ERROR: "=" expected
ERROR: Undefined variable(ERROR)
Curl Command
curl -G -d "offset=%3Clong%3E"
-d "limit=%3Clong%3E"
-H "Authorization: {{apiKey}}"
-H "Accept: image/jpeg"
https://api.easybill.de/rest/v1/documents/:id/jpg
Postman Collection Item JSON
{
"name": "Download a document as an jpeg-image",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "image/jpeg"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/jpg?offset=<long>&limit=<long>",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
"jpg"
],
"query": [
{
"key": "offset",
"value": "<long>",
"description": "The page of the document where the image should start."
},
{
"key": "limit",
"value": "<long>",
"description": "The page of the document where the image should end."
}
],
"variable": [
{
"key": "id",
"value": "<long>",
"description": "(Required) ID of document"
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "image/jpeg"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/jpg?offset=<long>&limit=<long>",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
"jpg"
],
"query": [
{
"key": "offset",
"value": "<long>",
"description": "The page of the document where the image should start."
},
{
"key": "limit",
"value": "<long>",
"description": "The page of the document where the image should end."
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "image/jpeg"
}
],
"cookie": [
],
"body": "<string>"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/jpg?offset=<long>&limit=<long>",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
"jpg"
],
"query": [
{
"key": "offset",
"value": "<long>",
"description": "The page of the document where the image should start."
},
{
"key": "limit",
"value": "<long>",
"description": "The page of the document where the image should end."
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/documents/:id/jpg?offset=<long>&limit=<long>",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id",
"jpg"
],
"query": [
{
"key": "offset",
"value": "<long>",
"description": "The page of the document where the image should start."
},
{
"key": "limit",
"value": "<long>",
"description": "The page of the document where the image should end."
}
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}