Chilkat Online Tools

autoit / easybill REST API / Fetch attachments list

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("limit","<integer>")
$oQueryParams.UpdateString("page","<integer>")

$oHttp.SetRequestHeader "Authorization","{{apiKey}}"
$oHttp.SetRequestHeader "Accept","application/json"

Local $oResp = $oHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/attachments",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sCreated_at
Local $sCustomer_id
Local $sDocument_id
Local $sFile_name
Local $sId
Local $sProject_id
Local $size

Local $sPage = $oJResp.StringOf("page")
Local $sPages = $oJResp.StringOf("pages")
Local $sLimit = $oJResp.StringOf("limit")
Local $sTotal = $oJResp.StringOf("total")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("items")
While $i < $iCount_i
    $oJResp.I = $i
    $sCreated_at = $oJResp.StringOf("items[i].created_at")
    $sCustomer_id = $oJResp.StringOf("items[i].customer_id")
    $sDocument_id = $oJResp.StringOf("items[i].document_id")
    $sFile_name = $oJResp.StringOf("items[i].file_name")
    $sId = $oJResp.StringOf("items[i].id")
    $sProject_id = $oJResp.StringOf("items[i].project_id")
    $size = $oJResp.StringOf("items[i].size")
    $i = $i + 1
Wend

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}"
    }
  ]
}