Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api-v2.fattureincloud.it/c/:company_id/issued_documents/:document_id/email",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
id.s
email.s
Recipient_email.s = CkJsonObject::ckStringOf(jResp,"data.recipient_email")
Id.s = CkJsonObject::ckStringOf(jResp,"data.default_sender_email.id")
v_Email.s = CkJsonObject::ckStringOf(jResp,"data.default_sender_email.email")
Cc_email.s = CkJsonObject::ckStringOf(jResp,"data.cc_email")
Subject.s = CkJsonObject::ckStringOf(jResp,"data.subject")
Body.s = CkJsonObject::ckStringOf(jResp,"data.body")
Document_exists.s = CkJsonObject::ckStringOf(jResp,"data.document_exists")
Delivery_note_exists.s = CkJsonObject::ckStringOf(jResp,"data.delivery_note_exists")
Attachment_exists.s = CkJsonObject::ckStringOf(jResp,"data.attachment_exists")
Accompanying_invoice_exists.s = CkJsonObject::ckStringOf(jResp,"data.accompanying_invoice_exists")
Default_attach_pdf.s = CkJsonObject::ckStringOf(jResp,"data.default_attach_pdf")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.sender_emails_list")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"data.sender_emails_list[i].id")
email = CkJsonObject::ckStringOf(jResp,"data.sender_emails_list[i].email")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
