Chilkat Online Tools

DataFlex / KSeF / Sprawdzenie statusu aktywnej sesji interaktywnej

Back to Collection Items

Use ChilkatAx-9.5.0-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vQueryParams
    Handle hoQueryParams
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sElementReferenceNumber
    String sAcquisitionTimestamp
    String sInvoiceNumber
    String sKsefReferenceNumber
    String sCreationTimestamp
    String sEntityType
    String sLastUpdateTimestamp
    String sProcessingCode
    String sProcessingDescription
    String sReferenceNumber
    String sTimestamp
    String sNumberOfElements
    String sPageOffset
    String sPageSize
    Integer i
    Integer iCount_i
    String sTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
    If (Not(IsComObjectCreated(hoQueryParams))) Begin
        Send CreateComObject of hoQueryParams
    End
    Get ComUpdateInt Of hoQueryParams "PageSize" 10 To iSuccess
    Get ComUpdateInt Of hoQueryParams "PageOffset" 0 To iSuccess
    Get ComUpdateString Of hoQueryParams "IncludeDetails" "true" To iSuccess

    Send ComSetRequestHeader To hoHttp "Accept" "application/json"
    Send ComSetRequestHeader To hoHttp "SessionToken" "{{apiKey}}"

    Get pvComObject of hoQueryParams to vQueryParams
    Get ComQuickRequestParams Of hoHttp "GET" "https://ksef.mf.gov.pl/api/online/Session/Status" vQueryParams To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess

    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

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

    Get ComStringOf Of hoJResp "creationTimestamp" To sCreationTimestamp
    Get ComStringOf Of hoJResp "entityType" To sEntityType
    Get ComStringOf Of hoJResp "lastUpdateTimestamp" To sLastUpdateTimestamp
    Get ComStringOf Of hoJResp "processingCode" To sProcessingCode
    Get ComStringOf Of hoJResp "processingDescription" To sProcessingDescription
    Get ComStringOf Of hoJResp "referenceNumber" To sReferenceNumber
    Get ComStringOf Of hoJResp "timestamp" To sTimestamp
    Get ComStringOf Of hoJResp "numberOfElements" To sNumberOfElements
    Get ComStringOf Of hoJResp "pageOffset" To sPageOffset
    Get ComStringOf Of hoJResp "pageSize" To sPageSize
    Move 0 To i
    Get ComSizeOfArray Of hoJResp "invoiceStatusList" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJResp To i
        Get ComStringOf Of hoJResp "invoiceStatusList[i].elementReferenceNumber" To sElementReferenceNumber
        Get ComStringOf Of hoJResp "invoiceStatusList[i].processingCode" To sProcessingCode
        Get ComStringOf Of hoJResp "invoiceStatusList[i].processingDescription" To sProcessingDescription
        Get ComStringOf Of hoJResp "invoiceStatusList[i].acquisitionTimestamp" To sAcquisitionTimestamp
        Get ComStringOf Of hoJResp "invoiceStatusList[i].invoiceNumber" To sInvoiceNumber
        Get ComStringOf Of hoJResp "invoiceStatusList[i].ksefReferenceNumber" To sKsefReferenceNumber
        Move (i + 1) To i
    Loop



End_Procedure

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