Chilkat Online Tools

autoit / KSeF / Sprawdzenie statusu sesji ogólnej

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_9_5_0.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat_9_5_0.JsonObject")
$oQueryParams.UpdateInt("PageSize",10)
$oQueryParams.UpdateInt("PageOffset",0)
$oQueryParams.UpdateString("IncludeDetails","true")

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

Local $oResp = $oHttp.QuickRequestParams("GET","https://ksef.mf.gov.pl/api/online/Session/Status/:ReferenceNumber",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

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

$oJResp = ObjCreate("Chilkat_9_5_0.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)

; {
;   "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

Local $sElementReferenceNumber
Local $sAcquisitionTimestamp
Local $sInvoiceNumber
Local $sKsefReferenceNumber

Local $sCreationTimestamp = $oJResp.StringOf("creationTimestamp")
Local $sEntityType = $oJResp.StringOf("entityType")
Local $sLastUpdateTimestamp = $oJResp.StringOf("lastUpdateTimestamp")
Local $sProcessingCode = $oJResp.StringOf("processingCode")
Local $sProcessingDescription = $oJResp.StringOf("processingDescription")
Local $sReferenceNumber = $oJResp.StringOf("referenceNumber")
Local $sTimestamp = $oJResp.StringOf("timestamp")
Local $sNumberOfElements = $oJResp.StringOf("numberOfElements")
Local $sPageOffset = $oJResp.StringOf("pageOffset")
Local $sPageSize = $oJResp.StringOf("pageSize")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("invoiceStatusList")
While $i < $iCount_i
    $oJResp.I = $i
    $sElementReferenceNumber = $oJResp.StringOf("invoiceStatusList[i].elementReferenceNumber")
    $sProcessingCode = $oJResp.StringOf("invoiceStatusList[i].processingCode")
    $sProcessingDescription = $oJResp.StringOf("invoiceStatusList[i].processingDescription")
    $sAcquisitionTimestamp = $oJResp.StringOf("invoiceStatusList[i].acquisitionTimestamp")
    $sInvoiceNumber = $oJResp.StringOf("invoiceStatusList[i].invoiceNumber")
    $sKsefReferenceNumber = $oJResp.StringOf("invoiceStatusList[i].ksefReferenceNumber")
    $i = $i + 1
Wend

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/:ReferenceNumber

Postman Collection Item JSON

{
  "name": "Sprawdzenie statusu sesji ogólnej",
  "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/:ReferenceNumber?PageSize=10&PageOffset=0&IncludeDetails=true",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "online",
        "Session",
        "Status",
        ":ReferenceNumber"
      ],
      "query": [
        {
          "key": "PageSize",
          "value": "10"
        },
        {
          "key": "PageOffset",
          "value": "0"
        },
        {
          "key": "IncludeDetails",
          "value": "true"
        }
      ],
      "variable": [
        {
          "key": "ReferenceNumber",
          "value": "56810128-EL-96284D87EE-8DDB16145F-B3"
        }
      ]
    },
    "description": "Sprawdzenie statusu przetwarzania na podstawie numeru referencyjnego"
  },
  "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/:ReferenceNumber?PageSize=10&PageOffset=0&IncludeDetails=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Session",
            "Status",
            ":ReferenceNumber"
          ],
          "query": [
            {
              "key": "PageSize",
              "value": "10"
            },
            {
              "key": "PageOffset",
              "value": "0"
            },
            {
              "key": "IncludeDetails",
              "value": "true"
            }
          ],
          "variable": [
            {
              "key": "ReferenceNumber"
            }
          ]
        }
      },
      "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/:ReferenceNumber?PageSize=10&PageOffset=0&IncludeDetails=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Session",
            "Status",
            ":ReferenceNumber"
          ],
          "query": [
            {
              "key": "PageSize",
              "value": "10"
            },
            {
              "key": "PageOffset",
              "value": "0"
            },
            {
              "key": "IncludeDetails",
              "value": "true"
            }
          ],
          "variable": [
            {
              "key": "ReferenceNumber"
            }
          ]
        }
      },
      "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/:ReferenceNumber?PageSize=10&PageOffset=0&IncludeDetails=true",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "online",
            "Session",
            "Status",
            ":ReferenceNumber"
          ],
          "query": [
            {
              "key": "PageSize",
              "value": "10"
            },
            {
              "key": "PageOffset",
              "value": "0"
            },
            {
              "key": "IncludeDetails",
              "value": "true"
            }
          ],
          "variable": [
            {
              "key": "ReferenceNumber"
            }
          ]
        }
      },
      "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}"
    }
  ]
}