SQL Server / KSeF / Sprawdzenie statusu sesji ogólnej
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
DECLARE @iTmp0 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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
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
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'PageSize', 10
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'PageOffset', 0
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'IncludeDetails', 'true'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'SessionToken', '{{apiKey}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://ksef.mf.gov.pl/api/online/Session/Status/:ReferenceNumber', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
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 @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @elementReferenceNumber nvarchar(4000)
DECLARE @acquisitionTimestamp nvarchar(4000)
DECLARE @invoiceNumber nvarchar(4000)
DECLARE @ksefReferenceNumber nvarchar(4000)
DECLARE @creationTimestamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @creationTimestamp OUT, 'creationTimestamp'
DECLARE @entityType nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @entityType OUT, 'entityType'
DECLARE @lastUpdateTimestamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @lastUpdateTimestamp OUT, 'lastUpdateTimestamp'
DECLARE @processingCode nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @processingCode OUT, 'processingCode'
DECLARE @processingDescription nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @processingDescription OUT, 'processingDescription'
DECLARE @referenceNumber nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @referenceNumber OUT, 'referenceNumber'
DECLARE @timestamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @timestamp OUT, 'timestamp'
DECLARE @numberOfElements nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @numberOfElements OUT, 'numberOfElements'
DECLARE @pageOffset nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @pageOffset OUT, 'pageOffset'
DECLARE @pageSize nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @pageSize OUT, 'pageSize'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'invoiceStatusList'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @elementReferenceNumber OUT, 'invoiceStatusList[i].elementReferenceNumber'
EXEC sp_OAMethod @jResp, 'StringOf', @processingCode OUT, 'invoiceStatusList[i].processingCode'
EXEC sp_OAMethod @jResp, 'StringOf', @processingDescription OUT, 'invoiceStatusList[i].processingDescription'
EXEC sp_OAMethod @jResp, 'StringOf', @acquisitionTimestamp OUT, 'invoiceStatusList[i].acquisitionTimestamp'
EXEC sp_OAMethod @jResp, 'StringOf', @invoiceNumber OUT, 'invoiceStatusList[i].invoiceNumber'
EXEC sp_OAMethod @jResp, 'StringOf', @ksefReferenceNumber OUT, 'invoiceStatusList[i].ksefReferenceNumber'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
