Chilkat Online Tools

SQL Server / easybill REST API / /logins

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    DECLARE @queryParams int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT

    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'limit', '<integer>'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'page', '<integer>'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{apiKey}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'

    DECLARE @resp int
    EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT

    EXEC sp_OAMethod @http, 'HttpParams', @success OUT, 'GET', 'https://api.easybill.de/rest/v1/logins', @queryParams, @resp
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        EXEC @hr = sp_OADestroy @resp
        RETURN
      END

    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody

    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        EXEC @hr = sp_OADestroy @resp
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END

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

    DECLARE @id nvarchar(4000)

    DECLARE @first_name nvarchar(4000)

    DECLARE @last_name nvarchar(4000)

    DECLARE @display_name nvarchar(4000)

    DECLARE @phone nvarchar(4000)

    DECLARE @email nvarchar(4000)

    DECLARE @email_signature nvarchar(4000)

    DECLARE @login_type nvarchar(4000)

    DECLARE @locale nvarchar(4000)

    DECLARE @time_zone nvarchar(4000)

    DECLARE @Two_factor_enabled int

    DECLARE @Recovery_codes_enabled int

    DECLARE @Notify_on_new_login_enabled int

    DECLARE @page nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @page OUT, 'page'
    DECLARE @pages nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @pages OUT, 'pages'
    DECLARE @limit nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @limit OUT, 'limit'
    DECLARE @total nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @total OUT, 'total'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'items'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jResp, 'I', @i
        EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'items[i].id'
        EXEC sp_OAMethod @jResp, 'StringOf', @first_name OUT, 'items[i].first_name'
        EXEC sp_OAMethod @jResp, 'StringOf', @last_name OUT, 'items[i].last_name'
        EXEC sp_OAMethod @jResp, 'StringOf', @display_name OUT, 'items[i].display_name'
        EXEC sp_OAMethod @jResp, 'StringOf', @phone OUT, 'items[i].phone'
        EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'items[i].email'
        EXEC sp_OAMethod @jResp, 'StringOf', @email_signature OUT, 'items[i].email_signature'
        EXEC sp_OAMethod @jResp, 'StringOf', @login_type OUT, 'items[i].login_type'
        EXEC sp_OAMethod @jResp, 'StringOf', @locale OUT, 'items[i].locale'
        EXEC sp_OAMethod @jResp, 'StringOf', @time_zone OUT, 'items[i].time_zone'
        EXEC sp_OAMethod @jResp, 'BoolOf', @Two_factor_enabled OUT, 'items[i].security.two_factor_enabled'
        EXEC sp_OAMethod @jResp, 'BoolOf', @Recovery_codes_enabled OUT, 'items[i].security.recovery_codes_enabled'
        EXEC sp_OAMethod @jResp, 'BoolOf', @Notify_on_new_login_enabled OUT, 'items[i].security.notify_on_new_login_enabled'
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @queryParams
    EXEC @hr = sp_OADestroy @resp
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO

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