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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.easybill.de/rest/v1/tasks/: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
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.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)
-- {
-- "name": "<string>",
-- "status": "PROCESSING",
-- "category": null,
-- "category_custom": null,
-- "created_at": "<dateTime>",
-- "customer_id": null,
-- "description": null,
-- "document_id": null,
-- "end_at": "<dateTime>",
-- "finish_at": "<dateTime>",
-- "id": "<long>",
-- "login_id": "<long>",
-- "position_id": null,
-- "priority": "NORMAL",
-- "project_id": null,
-- "start_at": null,
-- "status_percent": null
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'name'
DECLARE @status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'status'
DECLARE @category nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @category OUT, 'category'
DECLARE @category_custom nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @category_custom OUT, 'category_custom'
DECLARE @created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'created_at'
DECLARE @customer_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @customer_id OUT, 'customer_id'
DECLARE @description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'description'
DECLARE @document_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @document_id OUT, 'document_id'
DECLARE @end_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @end_at OUT, 'end_at'
DECLARE @finish_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @finish_at OUT, 'finish_at'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @login_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @login_id OUT, 'login_id'
DECLARE @position_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @position_id OUT, 'position_id'
DECLARE @priority nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @priority OUT, 'priority'
DECLARE @project_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @project_id OUT, 'project_id'
DECLARE @start_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @start_at OUT, 'start_at'
DECLARE @status_percent nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @status_percent OUT, 'status_percent'
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/tasks/:id
Postman Collection Item JSON
{
"name": "Fetch task",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/tasks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"tasks",
":id"
],
"variable": [
{
"key": "id",
"value": "<long>",
"description": "(Required) ID of task"
}
]
}
},
"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}}/tasks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"tasks",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"name\": \"<string>\",\n \"status\": \"PROCESSING\",\n \"category\": null,\n \"category_custom\": null,\n \"created_at\": \"<dateTime>\",\n \"customer_id\": null,\n \"description\": null,\n \"document_id\": null,\n \"end_at\": \"<dateTime>\",\n \"finish_at\": \"<dateTime>\",\n \"id\": \"<long>\",\n \"login_id\": \"<long>\",\n \"position_id\": null,\n \"priority\": \"NORMAL\",\n \"project_id\": null,\n \"start_at\": null,\n \"status_percent\": null\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}}/tasks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"tasks",
":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}}/tasks/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"tasks",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
