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
-- 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
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{apiKey}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
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 @http, 'QuickGetSb', @success OUT, 'https://api.easybill.de/rest/v1/post-boxes/:id', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
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 @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "id": "<long>",
-- "document_id": "<long>",
-- "to": "<string>",
-- "cc": "<string>",
-- "from": "<string>",
-- "subject": "<string>",
-- "message": "<string>",
-- "date": "<date>",
-- "created_at": "<dateTime>",
-- "processed_at": "<dateTime>",
-- "send_by_self": "<boolean>",
-- "send_with_attachment": "<boolean>",
-- "type": "EMAIL",
-- "status": "PROCESSING",
-- "status_msg": "<string>",
-- "login_id": "<long>",
-- "document_file_type": "default",
-- "post_send_type": "post_send_type_registered",
-- "tracking_identifier": "<string>"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @document_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @document_id OUT, 'document_id'
DECLARE @v_to nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_to OUT, 'to'
DECLARE @cc nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @cc OUT, 'cc'
DECLARE @from nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @from OUT, 'from'
DECLARE @subject nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @subject OUT, 'subject'
DECLARE @message nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @message OUT, 'message'
DECLARE @date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @date OUT, 'date'
DECLARE @created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'created_at'
DECLARE @processed_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @processed_at OUT, 'processed_at'
DECLARE @send_by_self nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @send_by_self OUT, 'send_by_self'
DECLARE @send_with_attachment nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @send_with_attachment OUT, 'send_with_attachment'
DECLARE @v_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'type'
DECLARE @status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'status'
DECLARE @status_msg nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @status_msg OUT, 'status_msg'
DECLARE @login_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @login_id OUT, 'login_id'
DECLARE @document_file_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @document_file_type OUT, 'document_file_type'
DECLARE @post_send_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @post_send_type OUT, 'post_send_type'
DECLARE @tracking_identifier nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @tracking_identifier OUT, 'tracking_identifier'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "Authorization: {{apiKey}}"
-H "Accept: application/json"
https://api.easybill.de/rest/v1/post-boxes/:id
Postman Collection Item JSON
{
"name": "Fetch post box",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/post-boxes/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"post-boxes",
":id"
],
"variable": [
{
"key": "id",
"value": "<long>",
"description": "(Required) ID of post box"
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/post-boxes/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"post-boxes",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"<long>\",\n \"document_id\": \"<long>\",\n \"to\": \"<string>\",\n \"cc\": \"<string>\",\n \"from\": \"<string>\",\n \"subject\": \"<string>\",\n \"message\": \"<string>\",\n \"date\": \"<date>\",\n \"created_at\": \"<dateTime>\",\n \"processed_at\": \"<dateTime>\",\n \"send_by_self\": \"<boolean>\",\n \"send_with_attachment\": \"<boolean>\",\n \"type\": \"EMAIL\",\n \"status\": \"PROCESSING\",\n \"status_msg\": \"<string>\",\n \"login_id\": \"<long>\",\n \"document_file_type\": \"default\",\n \"post_send_type\": \"post_send_type_registered\",\n \"tracking_identifier\": \"<string>\"\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/post-boxes/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"post-boxes",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/post-boxes/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"post-boxes",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
