Chilkat Online Tools

Foxpro / easybill REST API / /logins

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcFirst_name
LOCAL lcLast_name
LOCAL lcDisplay_name
LOCAL lcPhone
LOCAL lcEmail
LOCAL lcEmail_signature
LOCAL lcLogin_type
LOCAL lcLocale
LOCAL lcTime_zone
LOCAL lnTwo_factor_enabled
LOCAL lnRecovery_codes_enabled
LOCAL lnNotify_on_new_login_enabled
LOCAL lcPage
LOCAL lcPages
LOCAL lcLimit
LOCAL lcTotal
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("limit","<integer>")
loQueryParams.UpdateString("page","<integer>")

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

loResp = loHttp.QuickRequestParams("GET","https://api.easybill.de/rest/v1/logins",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loQueryParams
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

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

* {
*   "page": "<integer>",
*   "pages": "<integer>",
*   "limit": "<integer>",
*   "total": "<integer>",
*   "items": [
*     {
*       "id": "<long>",
*       "first_name": "<string>",
*       "last_name": "<string>",
*       "display_name": "<string>",
*       "phone": "<string>",
*       "email": "<string>",
*       "email_signature": "<string>",
*       "login_type": "ASSISTANT",
*       "locale": "<string>",
*       "time_zone": "<string>",
*       "security": {
*         "two_factor_enabled": false,
*         "recovery_codes_enabled": false,
*         "notify_on_new_login_enabled": true
*       }
*     },
*     {
*       "id": "<long>",
*       "first_name": "<string>",
*       "last_name": "<string>",
*       "display_name": "<string>",
*       "phone": "<string>",
*       "email": "<string>",
*       "email_signature": "<string>",
*       "login_type": "ASSISTANT",
*       "locale": "<string>",
*       "time_zone": "<string>",
*       "security": {
*         "two_factor_enabled": false,
*         "recovery_codes_enabled": false,
*         "notify_on_new_login_enabled": true
*       }
*     }
*   ]
* }

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

lcPage = loJResp.StringOf("page")
lcPages = loJResp.StringOf("pages")
lcLimit = loJResp.StringOf("limit")
lcTotal = loJResp.StringOf("total")
i = 0
lnCount_i = loJResp.SizeOfArray("items")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("items[i].id")
    lcFirst_name = loJResp.StringOf("items[i].first_name")
    lcLast_name = loJResp.StringOf("items[i].last_name")
    lcDisplay_name = loJResp.StringOf("items[i].display_name")
    lcPhone = loJResp.StringOf("items[i].phone")
    lcEmail = loJResp.StringOf("items[i].email")
    lcEmail_signature = loJResp.StringOf("items[i].email_signature")
    lcLogin_type = loJResp.StringOf("items[i].login_type")
    lcLocale = loJResp.StringOf("items[i].locale")
    lcTime_zone = loJResp.StringOf("items[i].time_zone")
    lnTwo_factor_enabled = loJResp.BoolOf("items[i].security.two_factor_enabled")
    lnRecovery_codes_enabled = loJResp.BoolOf("items[i].security.recovery_codes_enabled")
    lnNotify_on_new_login_enabled = loJResp.BoolOf("items[i].security.notify_on_new_login_enabled")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp

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

Postman Collection Item JSON

{
  "name": "/logins",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/logins?limit=<integer>&page=<integer>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "logins"
      ],
      "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}}/logins?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "logins"
          ],
          "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      \"id\": \"<long>\",\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"display_name\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"email\": \"<string>\",\n      \"email_signature\": \"<string>\",\n      \"login_type\": \"ASSISTANT\",\n      \"locale\": \"<string>\",\n      \"time_zone\": \"<string>\",\n      \"security\": {\n        \"two_factor_enabled\": false,\n        \"recovery_codes_enabled\": false,\n        \"notify_on_new_login_enabled\": true\n      }\n    },\n    {\n      \"id\": \"<long>\",\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"display_name\": \"<string>\",\n      \"phone\": \"<string>\",\n      \"email\": \"<string>\",\n      \"email_signature\": \"<string>\",\n      \"login_type\": \"ASSISTANT\",\n      \"locale\": \"<string>\",\n      \"time_zone\": \"<string>\",\n      \"security\": {\n        \"two_factor_enabled\": false,\n        \"recovery_codes_enabled\": false,\n        \"notify_on_new_login_enabled\": true\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}}/logins?limit=<integer>&page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "logins"
          ],
          "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": ""
    }
  ]
}