Chilkat Online Tools

PowerBuilder / easybill REST API / Fetch WebHooks list

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Url
string ls_Content_type
string ls_Secret
string ls_Description
string ls_Id
integer li_Is_active
string ls_Date
string ls_Code
string ls_Response
integer j
integer li_Count_j
string ls_StrVal
string ls_Page
string ls_Pages
string ls_Limit
string ls_Total
integer i
integer li_Count_i

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")

loo_QueryParams.UpdateString("limit","<integer>")
loo_QueryParams.UpdateString("page","<integer>")

loo_Http.SetRequestHeader("Authorization","{{apiKey}}")
loo_Http.SetRequestHeader("Accept","application/json")

loo_Resp = loo_Http.QuickRequestParams("GET","https://api.easybill.de/rest/v1/webhooks",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)

loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_QueryParams
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_Resp

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "page": "<integer>",
//   "pages": "<integer>",
//   "limit": "<integer>",
//   "total": "<integer>",
//   "items": [
//     {
//       "url": "<string>",
//       "content_type": "json",
//       "secret": "<string>",
//       "events": [
//         "document.update",
//         "document.deleted"
//       ],
//       "description": "<string>",
//       "id": "<long>",
//       "is_active": false,
//       "last_response": {
//         "date": "<dateTime>",
//         "code": "<integer>",
//         "response": "<string>"
//       }
//     },
//     {
//       "url": "<string>",
//       "content_type": "form",
//       "secret": "<string>",
//       "events": [
//         "contact.create",
//         "postbox.update"
//       ],
//       "description": "<string>",
//       "id": "<long>",
//       "is_active": false,
//       "last_response": {
//         "date": "<dateTime>",
//         "code": "<integer>",
//         "response": "<string>"
//       }
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

ls_Page = loo_JResp.StringOf("page")
ls_Pages = loo_JResp.StringOf("pages")
ls_Limit = loo_JResp.StringOf("limit")
ls_Total = loo_JResp.StringOf("total")
i = 0
li_Count_i = loo_JResp.SizeOfArray("items")
do while i < li_Count_i
    loo_JResp.I = i
    ls_Url = loo_JResp.StringOf("items[i].url")
    ls_Content_type = loo_JResp.StringOf("items[i].content_type")
    ls_Secret = loo_JResp.StringOf("items[i].secret")
    ls_Description = loo_JResp.StringOf("items[i].description")
    ls_Id = loo_JResp.StringOf("items[i].id")
    li_Is_active = loo_JResp.BoolOf("items[i].is_active")
    ls_Date = loo_JResp.StringOf("items[i].last_response.date")
    ls_Code = loo_JResp.StringOf("items[i].last_response.code")
    ls_Response = loo_JResp.StringOf("items[i].last_response.response")
    j = 0
    li_Count_j = loo_JResp.SizeOfArray("items[i].events")
    do while j < li_Count_j
        loo_JResp.J = j
        ls_StrVal = loo_JResp.StringOf("items[i].events[j]")
        j = j + 1
    loop
    i = i + 1
loop


destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp

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/webhooks

Postman Collection Item JSON

{
  "name": "Fetch WebHooks list",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/webhooks?limit=<integer>&page=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "webhooks"
      ],
      "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}}/webhooks?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webhooks"
          ],
          "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      \"url\": \"<string>\",\n      \"content_type\": \"json\",\n      \"secret\": \"<string>\",\n      \"events\": [\n        \"document.update\",\n        \"document.deleted\"\n      ],\n      \"description\": \"<string>\",\n      \"id\": \"<long>\",\n      \"is_active\": false,\n      \"last_response\": {\n        \"date\": \"<dateTime>\",\n        \"code\": \"<integer>\",\n        \"response\": \"<string>\"\n      }\n    },\n    {\n      \"url\": \"<string>\",\n      \"content_type\": \"form\",\n      \"secret\": \"<string>\",\n      \"events\": [\n        \"contact.create\",\n        \"postbox.update\"\n      ],\n      \"description\": \"<string>\",\n      \"id\": \"<long>\",\n      \"is_active\": false,\n      \"last_response\": {\n        \"date\": \"<dateTime>\",\n        \"code\": \"<integer>\",\n        \"response\": \"<string>\"\n      }\n    }\n  ]\n}"
    },
    {
      "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}}/webhooks?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webhooks"
          ],
          "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": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}