DataFlex / easybill REST API / Download a document as an jpeg-image
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "offset" "<long>" To iSuccess
Get ComUpdateString Of hoQueryParams "limit" "<long>" To iSuccess
Send ComSetRequestHeader To hoHttp "Authorization" "{{apiKey}}"
Send ComSetRequestHeader To hoHttp "Accept" "image/jpeg"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.easybill.de/rest/v1/documents/:id/jpg" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
ERROR: "=" expected
ERROR: Undefined variable(ERROR)
End_Procedure
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": ""
}
]
}