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/emails', @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)
-- {
-- "current_page": "<integer>",
-- "first_page_url": "<uri>",
-- "from": "<integer>",
-- "last_page": "<integer>",
-- "last_page_url": "<uri>",
-- "next_page_url": "<uri>",
-- "path": "<uri>",
-- "per_page": "<integer>",
-- "prev_page_url": "<uri>",
-- "to": "<integer>",
-- "total": "<integer>",
-- "data": [
-- {
-- "id": "<integer>",
-- "status": "pending",
-- "sent_date": "<dateTime>",
-- "errors_count": "<integer>",
-- "error_log": "<string>",
-- "from_email": "<string>",
-- "from_name": "<string>",
-- "to_email": "<string>",
-- "to_name": "<string>",
-- "subject": "<string>",
-- "content": "<string>",
-- "copy_to": "<string>",
-- "recipient_status": "email_opened",
-- "recipient_date": "<dateTime>",
-- "kind": "<string>",
-- "attachments": [
-- {
-- "filename": "<string>",
-- "url": "<string>"
-- },
-- {
-- "filename": "<string>",
-- "url": "<string>"
-- }
-- ]
-- },
-- {
-- "id": "<integer>",
-- "status": "sending",
-- "sent_date": "<dateTime>",
-- "errors_count": "<integer>",
-- "error_log": "<string>",
-- "from_email": "<string>",
-- "from_name": "<string>",
-- "to_email": "<string>",
-- "to_name": "<string>",
-- "subject": "<string>",
-- "content": "<string>",
-- "copy_to": "<string>",
-- "recipient_status": "document_opened",
-- "recipient_date": "<dateTime>",
-- "kind": "<string>",
-- "attachments": [
-- {
-- "filename": "<string>",
-- "url": "<string>"
-- },
-- {
-- "filename": "<string>",
-- "url": "<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)
DECLARE @status nvarchar(4000)
DECLARE @sent_date nvarchar(4000)
DECLARE @errors_count nvarchar(4000)
DECLARE @error_log nvarchar(4000)
DECLARE @from_email nvarchar(4000)
DECLARE @from_name nvarchar(4000)
DECLARE @to_email nvarchar(4000)
DECLARE @to_name nvarchar(4000)
DECLARE @subject nvarchar(4000)
DECLARE @content nvarchar(4000)
DECLARE @copy_to nvarchar(4000)
DECLARE @recipient_status nvarchar(4000)
DECLARE @recipient_date nvarchar(4000)
DECLARE @kind nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @filename nvarchar(4000)
DECLARE @url nvarchar(4000)
DECLARE @current_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @current_page OUT, 'current_page'
DECLARE @first_page_url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @first_page_url OUT, 'first_page_url'
DECLARE @from nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @from OUT, 'from'
DECLARE @last_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @last_page OUT, 'last_page'
DECLARE @last_page_url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @last_page_url OUT, 'last_page_url'
DECLARE @next_page_url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @next_page_url OUT, 'next_page_url'
DECLARE @path nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @path OUT, 'path'
DECLARE @per_page nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @per_page OUT, 'per_page'
DECLARE @prev_page_url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @prev_page_url OUT, 'prev_page_url'
DECLARE @v_to nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_to OUT, 'to'
DECLARE @total nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @total OUT, 'total'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'data[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'data[i].status'
EXEC sp_OAMethod @jResp, 'StringOf', @sent_date OUT, 'data[i].sent_date'
EXEC sp_OAMethod @jResp, 'StringOf', @errors_count OUT, 'data[i].errors_count'
EXEC sp_OAMethod @jResp, 'StringOf', @error_log OUT, 'data[i].error_log'
EXEC sp_OAMethod @jResp, 'StringOf', @from_email OUT, 'data[i].from_email'
EXEC sp_OAMethod @jResp, 'StringOf', @from_name OUT, 'data[i].from_name'
EXEC sp_OAMethod @jResp, 'StringOf', @to_email OUT, 'data[i].to_email'
EXEC sp_OAMethod @jResp, 'StringOf', @to_name OUT, 'data[i].to_name'
EXEC sp_OAMethod @jResp, 'StringOf', @subject OUT, 'data[i].subject'
EXEC sp_OAMethod @jResp, 'StringOf', @content OUT, 'data[i].content'
EXEC sp_OAMethod @jResp, 'StringOf', @copy_to OUT, 'data[i].copy_to'
EXEC sp_OAMethod @jResp, 'StringOf', @recipient_status OUT, 'data[i].recipient_status'
EXEC sp_OAMethod @jResp, 'StringOf', @recipient_date OUT, 'data[i].recipient_date'
EXEC sp_OAMethod @jResp, 'StringOf', @kind OUT, 'data[i].kind'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'data[i].attachments'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @filename OUT, 'data[i].attachments[j].filename'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'data[i].attachments[j].url'
SELECT @j = @j + 1
END
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/emails
Postman Collection Item JSON
{
"name": "List emails",
"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/emails",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"emails"
],
"variable": [
{
"key": "company_id",
"value": "<integer>"
}
]
},
"description": "List Emails."
},
"response": [
{
"name": "Example response",
"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/emails",
"host": [
"{{baseUrl}}"
],
"path": [
"c",
":company_id",
"emails"
],
"variable": [
{
"key": "company_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"current_page\": \"<integer>\",\n \"first_page_url\": \"<uri>\",\n \"from\": \"<integer>\",\n \"last_page\": \"<integer>\",\n \"last_page_url\": \"<uri>\",\n \"next_page_url\": \"<uri>\",\n \"path\": \"<uri>\",\n \"per_page\": \"<integer>\",\n \"prev_page_url\": \"<uri>\",\n \"to\": \"<integer>\",\n \"total\": \"<integer>\",\n \"data\": [\n {\n \"id\": \"<integer>\",\n \"status\": \"pending\",\n \"sent_date\": \"<dateTime>\",\n \"errors_count\": \"<integer>\",\n \"error_log\": \"<string>\",\n \"from_email\": \"<string>\",\n \"from_name\": \"<string>\",\n \"to_email\": \"<string>\",\n \"to_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"copy_to\": \"<string>\",\n \"recipient_status\": \"email_opened\",\n \"recipient_date\": \"<dateTime>\",\n \"kind\": \"<string>\",\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n },\n {\n \"id\": \"<integer>\",\n \"status\": \"sending\",\n \"sent_date\": \"<dateTime>\",\n \"errors_count\": \"<integer>\",\n \"error_log\": \"<string>\",\n \"from_email\": \"<string>\",\n \"from_name\": \"<string>\",\n \"to_email\": \"<string>\",\n \"to_name\": \"<string>\",\n \"subject\": \"<string>\",\n \"content\": \"<string>\",\n \"copy_to\": \"<string>\",\n \"recipient_status\": \"document_opened\",\n \"recipient_date\": \"<dateTime>\",\n \"kind\": \"<string>\",\n \"attachments\": [\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"filename\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n }\n ]\n}"
}
]
}
