Chilkat Online Tools

VB6 / Fatture in Cloud API v2 - API Reference / Get Email Data

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New ChilkatHttp
Dim success As Long

' Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://api-v2.fattureincloud.it/c/:company_id/issued_documents/:document_id/email",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

' 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

Dim id As String
Dim email As String

Dim Recipient_email As String
Recipient_email = jResp.StringOf("data.recipient_email")
Dim Id As String
Id = jResp.StringOf("data.default_sender_email.id")
Dim v_Email As String
v_Email = jResp.StringOf("data.default_sender_email.email")
Dim Cc_email As String
Cc_email = jResp.StringOf("data.cc_email")
Dim Subject As String
Subject = jResp.StringOf("data.subject")
Dim Body As String
Body = jResp.StringOf("data.body")
Dim Document_exists As String
Document_exists = jResp.StringOf("data.document_exists")
Dim Delivery_note_exists As String
Delivery_note_exists = jResp.StringOf("data.delivery_note_exists")
Dim Attachment_exists As String
Attachment_exists = jResp.StringOf("data.attachment_exists")
Dim Accompanying_invoice_exists As String
Accompanying_invoice_exists = jResp.StringOf("data.accompanying_invoice_exists")
Dim Default_attach_pdf As String
Default_attach_pdf = jResp.StringOf("data.default_attach_pdf")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data.sender_emails_list")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("data.sender_emails_list[i].id")
    email = jResp.StringOf("data.sender_emails_list[i].email")
    i = i + 1
Loop

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}"
    }
  ]
}