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
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "created_at": "<date>",
-- "customer_id": null,
-- "document_id": null,
-- "file_name": "<string>",
-- "id": "<long>",
-- "project_id": null,
-- "size": "<integer>"
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'created_at', '<date>'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'customer_id'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'document_id'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'file_name', '<string>'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'id', '<long>'
EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'project_id'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'size', '<integer>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{apiKey}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbRequestBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @resp int
EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://api.easybill.de/rest/v1/attachments/:id', @sbRequestBody, 'utf-8', 'application/json', 0, 0
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 @json
EXEC @hr = sp_OADestroy @sbRequestBody
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 @json
EXEC @hr = sp_OADestroy @sbRequestBody
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)
-- {
-- "created_at": "<date>",
-- "customer_id": null,
-- "document_id": null,
-- "file_name": "<string>",
-- "id": "<long>",
-- "project_id": null,
-- "size": "<integer>"
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
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 @document_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @document_id OUT, 'document_id'
DECLARE @file_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @file_name OUT, 'file_name'
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @project_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @project_id OUT, 'project_id'
DECLARE @size nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @size OUT, 'size'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X PUT
-H "Authorization: {{apiKey}}"
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"created_at": "<date>",
"customer_id": null,
"document_id": null,
"file_name": "<string>",
"id": "<long>",
"project_id": null,
"size": "<integer>"
}'
https://api.easybill.de/rest/v1/attachments/:id
Postman Collection Item JSON
{
"name": "Update attachment",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created_at\": \"<date>\",\n \"customer_id\": null,\n \"document_id\": null,\n \"file_name\": \"<string>\",\n \"id\": \"<long>\",\n \"project_id\": null,\n \"size\": \"<integer>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/attachments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"attachments",
":id"
],
"variable": [
{
"key": "id",
"value": "<long>",
"description": "(Required) ID of attachment"
}
]
}
},
"response": [
{
"name": "Successful operation",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created_at\": \"<date>\",\n \"customer_id\": null,\n \"document_id\": null,\n \"file_name\": \"<string>\",\n \"id\": \"<long>\",\n \"project_id\": null,\n \"size\": \"<integer>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/attachments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"attachments",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"created_at\": \"<date>\",\n \"customer_id\": null,\n \"document_id\": null,\n \"file_name\": \"<string>\",\n \"id\": \"<long>\",\n \"project_id\": null,\n \"size\": \"<integer>\"\n}"
},
{
"name": "Invalid attachment",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created_at\": \"<date>\",\n \"customer_id\": null,\n \"document_id\": null,\n \"file_name\": \"<string>\",\n \"id\": \"<long>\",\n \"project_id\": null,\n \"size\": \"<integer>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/attachments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"attachments",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
},
{
"name": "Too Many Requests",
"originalRequest": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "Authorization",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"created_at\": \"<date>\",\n \"customer_id\": null,\n \"document_id\": null,\n \"file_name\": \"<string>\",\n \"id\": \"<long>\",\n \"project_id\": null,\n \"size\": \"<integer>\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/attachments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"attachments",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "text",
"header": [
],
"cookie": [
],
"body": ""
}
]
}
