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
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
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-v2.fattureincloud.it/c/:company_id/issued_documents/:document_id/email', @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)
-- {
-- "data": {
-- "recipient_email": "<string>",
-- "default_sender_email": {
-- "id": "<integer>",
-- "email": "<string>"
-- },
-- "sender_emails_list": [
-- {
-- "id": "<integer>",
-- "email": "<string>"
-- },
-- {
-- "id": "<integer>",
-- "email": "<string>"
-- }
-- ],
-- "cc_email": "<string>",
-- "subject": "<string>",
-- "body": "<string>",
-- "document_exists": "<boolean>",
-- "delivery_note_exists": "<boolean>",
-- "attachment_exists": "<boolean>",
-- "accompanying_invoice_exists": "<boolean>",
-- "default_attach_pdf": "<boolean>"
-- }
-- }
-- 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)
DECLARE @email nvarchar(4000)
DECLARE @Recipient_email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Recipient_email OUT, 'data.recipient_email'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data.default_sender_email.id'
DECLARE @v_Email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Email OUT, 'data.default_sender_email.email'
DECLARE @Cc_email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Cc_email OUT, 'data.cc_email'
DECLARE @Subject nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Subject OUT, 'data.subject'
DECLARE @Body nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Body OUT, 'data.body'
DECLARE @Document_exists nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Document_exists OUT, 'data.document_exists'
DECLARE @Delivery_note_exists nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Delivery_note_exists OUT, 'data.delivery_note_exists'
DECLARE @Attachment_exists nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Attachment_exists OUT, 'data.attachment_exists'
DECLARE @Accompanying_invoice_exists nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Accompanying_invoice_exists OUT, 'data.accompanying_invoice_exists'
DECLARE @Default_attach_pdf nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Default_attach_pdf OUT, 'data.default_attach_pdf'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data.sender_emails_list'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data.sender_emails_list[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'data.sender_emails_list[i].email'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/issued_documents/:document_id/email
Postman Collection Item JSON
{
"name": "Get Email Data",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
"type": "string"
},
{
"key": "redirect_uri",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "https://api-v2.fattureincloud.it/oauth/token",
"type": "string"
},
{
"key": "authUrl",
"value": "https://api-v2.fattureincloud.it/oauth/authorize",
"type": "string"
},
{
"key": "grant_type",
"value": "authorization_code",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/issued_documents/:document_id/email",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"issued_documents",
":document_id",
"email"
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
},
{
"key": "document_id",
"value": "<integer>"
}
]
},
"description": "Gets the pre-compiled email details."
},
"response": [
{
"name": "EmailData",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/c/:company_id/issued_documents/:document_id/email",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"issued_documents",
":document_id",
"email"
],
"variable": [
{
"key": "company_id"
},
{
"key": "document_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"recipient_email\": \"<string>\",\n \"default_sender_email\": {\n \"id\": \"<integer>\",\n \"email\": \"<string>\"\n },\n \"sender_emails_list\": [\n {\n \"id\": \"<integer>\",\n \"email\": \"<string>\"\n },\n {\n \"id\": \"<integer>\",\n \"email\": \"<string>\"\n }\n ],\n \"cc_email\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"document_exists\": \"<boolean>\",\n \"delivery_note_exists\": \"<boolean>\",\n \"attachment_exists\": \"<boolean>\",\n \"accompanying_invoice_exists\": \"<boolean>\",\n \"default_attach_pdf\": \"<boolean>\"\n }\n}"
}
]
}
