Chilkat Online Tools

VB6 / KSeF / Sprawdzenie statusu aktywnej sesji interaktywnej

Back to Collection Items

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

Dim http As New ChilkatHttp
Dim success As Long

Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateInt("PageSize",10)
success = queryParams.UpdateInt("PageOffset",0)
success = queryParams.UpdateString("IncludeDetails","true")

http.SetRequestHeader "Accept","application/json"
http.SetRequestHeader "SessionToken","{{apiKey}}"

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://ksef.mf.gov.pl/api/online/Session/Status",queryParams)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

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

' {
'   "creationTimestamp": "<dateTime>",
'   "entityType": "<string>",
'   "lastUpdateTimestamp": "<dateTime>",
'   "processingCode": "<integer>",
'   "processingDescription": "<string>",
'   "referenceNumber": "27171215-HY-2C82107214-1D5F90FA88-2E",
'   "timestamp": "<dateTime>",
'   "invoiceStatusList": [
'     {
'       "elementReferenceNumber": "67730731-BT-BB0B759DA9-D861FFD666-F7",
'       "processingCode": "<integer>",
'       "processingDescription": "<string>",
'       "acquisitionTimestamp": "<dateTime>",
'       "invoiceNumber": "<string>",
'       "ksefReferenceNumber": "M589364889-24840303-BAD08EE6BCE5-9D"
'     },
'     {
'       "elementReferenceNumber": "23341031-IK-42BD8BA85B-E2BAE0244C-4F",
'       "processingCode": "<integer>",
'       "processingDescription": "<string>",
'       "acquisitionTimestamp": "<dateTime>",
'       "invoiceNumber": "<string>",
'       "ksefReferenceNumber": "UUX0645446-28171227-5D321BCCA530-F1"
'     }
'   ],
'   "numberOfElements": "<long>",
'   "pageOffset": "<integer>",
'   "pageSize": "<integer>"
' }

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

Dim elementReferenceNumber As String
Dim acquisitionTimestamp As String
Dim invoiceNumber As String
Dim ksefReferenceNumber As String

Dim creationTimestamp As String
creationTimestamp = jResp.StringOf("creationTimestamp")
Dim entityType As String
entityType = jResp.StringOf("entityType")
Dim lastUpdateTimestamp As String
lastUpdateTimestamp = jResp.StringOf("lastUpdateTimestamp")
Dim processingCode As String
processingCode = jResp.StringOf("processingCode")
Dim processingDescription As String
processingDescription = jResp.StringOf("processingDescription")
Dim referenceNumber As String
referenceNumber = jResp.StringOf("referenceNumber")
Dim timestamp As String
timestamp = jResp.StringOf("timestamp")
Dim numberOfElements As String
numberOfElements = jResp.StringOf("numberOfElements")
Dim pageOffset As String
pageOffset = jResp.StringOf("pageOffset")
Dim pageSize As String
pageSize = jResp.StringOf("pageSize")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("invoiceStatusList")
Do While i < count_i
    jResp.I = i
    elementReferenceNumber = jResp.StringOf("invoiceStatusList[i].elementReferenceNumber")
    processingCode = jResp.StringOf("invoiceStatusList[i].processingCode")
    processingDescription = jResp.StringOf("invoiceStatusList[i].processingDescription")
    acquisitionTimestamp = jResp.StringOf("invoiceStatusList[i].acquisitionTimestamp")
    invoiceNumber = jResp.StringOf("invoiceStatusList[i].invoiceNumber")
    ksefReferenceNumber = jResp.StringOf("invoiceStatusList[i].ksefReferenceNumber")
    i = i + 1
Loop

Curl Command

curl -G -d "PageSize=10"
	-d "PageOffset=0"
	-d "IncludeDetails=true"
	-H "SessionToken: {{apiKey}}"
	-H "Accept: application/json"
https://ksef.mf.gov.pl/api/online/Session/Status

Postman Collection Item JSON

{
  "name": "Sprawdzenie statusu aktywnej sesji interaktywnej",
  "request": {
    "auth": {
      "type": "apikey",
      "apikey": [
        {
          "key": "key",
          "value": "SessionToken",
          "type": "string"
        },
        {
          "key": "value",
          "value": "{{apiKey}}",
          "type": "string"
        },
        {
          "key": "in",
          "value": "header",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/online/Session/Status?PageSize=10&PageOffset=0&IncludeDetails=true",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "online",
        "Session",
        "Status"
      ],
      "query": [
        {
          "key": "PageSize",
          "value": "10"
        },
        {
          "key": "PageOffset",
          "value": "0"
        },
        {
          "key": "IncludeDetails",
          "value": "true"
        }
      ]
    },
    "description": "Sprawdzenie statusu obecnego przetwarzania interaktywnego"
  },
  "response": [
    {
      "name": "Sprawdzanie statusu sesji zakończone poprawnie",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/online/Session/Status?PageSize=10&PageOffset=0&IncludeDetails=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Session",
            "Status"
          ],
          "query": [
            {
              "key": "PageSize",
              "value": "10"
            },
            {
              "key": "PageOffset",
              "value": "0"
            },
            {
              "key": "IncludeDetails",
              "value": "true"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"creationTimestamp\": \"<dateTime>\",\n  \"entityType\": \"<string>\",\n  \"lastUpdateTimestamp\": \"<dateTime>\",\n  \"processingCode\": \"<integer>\",\n  \"processingDescription\": \"<string>\",\n  \"referenceNumber\": \"27171215-HY-2C82107214-1D5F90FA88-2E\",\n  \"timestamp\": \"<dateTime>\",\n  \"invoiceStatusList\": [\n    {\n      \"elementReferenceNumber\": \"67730731-BT-BB0B759DA9-D861FFD666-F7\",\n      \"processingCode\": \"<integer>\",\n      \"processingDescription\": \"<string>\",\n      \"acquisitionTimestamp\": \"<dateTime>\",\n      \"invoiceNumber\": \"<string>\",\n      \"ksefReferenceNumber\": \"M589364889-24840303-BAD08EE6BCE5-9D\"\n    },\n    {\n      \"elementReferenceNumber\": \"23341031-IK-42BD8BA85B-E2BAE0244C-4F\",\n      \"processingCode\": \"<integer>\",\n      \"processingDescription\": \"<string>\",\n      \"acquisitionTimestamp\": \"<dateTime>\",\n      \"invoiceNumber\": \"<string>\",\n      \"ksefReferenceNumber\": \"UUX0645446-28171227-5D321BCCA530-F1\"\n    }\n  ],\n  \"numberOfElements\": \"<long>\",\n  \"pageOffset\": \"<integer>\",\n  \"pageSize\": \"<integer>\"\n}"
    },
    {
      "name": "Nie znaleziono danych",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/online/Session/Status?PageSize=10&PageOffset=0&IncludeDetails=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Session",
            "Status"
          ],
          "query": [
            {
              "key": "PageSize",
              "value": "10"
            },
            {
              "key": "PageOffset",
              "value": "0"
            },
            {
              "key": "IncludeDetails",
              "value": "true"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"exception\": {\n    \"exceptionDetailList\": [\n      {\n        \"exceptionCode\": \"<integer>\",\n        \"exceptionDescription\": \"<string>\"\n      }\n    ],\n    \"serviceCode\": \"<string>\",\n    \"serviceCtx\": \"<string>\",\n    \"serviceName\": \"<string>\",\n    \"timestamp\": \"<dateTime>\",\n    \"referenceNumber\": \"20560508-TX-BC1107E227-31DE9417C0-CE\"\n  }\n}"
    },
    {
      "name": "Nieautoryzowany dostęp",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: apikey",
            "key": "SessionToken",
            "value": "<API Key>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/online/Session/Status?PageSize=10&PageOffset=0&IncludeDetails=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Session",
            "Status"
          ],
          "query": [
            {
              "key": "PageSize",
              "value": "10"
            },
            {
              "key": "PageOffset",
              "value": "0"
            },
            {
              "key": "IncludeDetails",
              "value": "true"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"exception\": {\n    \"exceptionDetailList\": [\n      {\n        \"exceptionCode\": \"<integer>\",\n        \"exceptionDescription\": \"<string>\"\n      }\n    ],\n    \"serviceCode\": \"<string>\",\n    \"serviceCtx\": \"<string>\",\n    \"serviceName\": \"<string>\",\n    \"timestamp\": \"<dateTime>\",\n    \"referenceNumber\": \"20560508-TX-BC1107E227-31DE9417C0-CE\"\n  }\n}"
    }
  ]
}