PureBasic / KSeF / Sprawdzenie statusu aktywnej sesji interaktywnej
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateInt(queryParams,"PageSize",10)
CkJsonObject::ckUpdateInt(queryParams,"PageOffset",0)
CkJsonObject::ckUpdateString(queryParams,"IncludeDetails","true")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
CkHttp::ckSetRequestHeader(http,"SessionToken","{{apiKey}}")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://ksef.mf.gov.pl/api/online/Session/Status",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
elementReferenceNumber.s
acquisitionTimestamp.s
invoiceNumber.s
ksefReferenceNumber.s
creationTimestamp.s = CkJsonObject::ckStringOf(jResp,"creationTimestamp")
entityType.s = CkJsonObject::ckStringOf(jResp,"entityType")
lastUpdateTimestamp.s = CkJsonObject::ckStringOf(jResp,"lastUpdateTimestamp")
processingCode.s = CkJsonObject::ckStringOf(jResp,"processingCode")
processingDescription.s = CkJsonObject::ckStringOf(jResp,"processingDescription")
referenceNumber.s = CkJsonObject::ckStringOf(jResp,"referenceNumber")
timestamp.s = CkJsonObject::ckStringOf(jResp,"timestamp")
numberOfElements.s = CkJsonObject::ckStringOf(jResp,"numberOfElements")
pageOffset.s = CkJsonObject::ckStringOf(jResp,"pageOffset")
pageSize.s = CkJsonObject::ckStringOf(jResp,"pageSize")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"invoiceStatusList")
While i < count_i
CkJsonObject::setCkI(jResp, i)
elementReferenceNumber = CkJsonObject::ckStringOf(jResp,"invoiceStatusList[i].elementReferenceNumber")
processingCode = CkJsonObject::ckStringOf(jResp,"invoiceStatusList[i].processingCode")
processingDescription = CkJsonObject::ckStringOf(jResp,"invoiceStatusList[i].processingDescription")
acquisitionTimestamp = CkJsonObject::ckStringOf(jResp,"invoiceStatusList[i].acquisitionTimestamp")
invoiceNumber = CkJsonObject::ckStringOf(jResp,"invoiceStatusList[i].invoiceNumber")
ksefReferenceNumber = CkJsonObject::ckStringOf(jResp,"invoiceStatusList[i].ksefReferenceNumber")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
