Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Status
string ls_Sent_date
string ls_Errors_count
string ls_Error_log
string ls_From_email
string ls_From_name
string ls_To_email
string ls_To_name
string ls_Subject
string ls_Content
string ls_Copy_to
string ls_Recipient_status
string ls_Recipient_date
string ls_Kind
integer j
integer li_Count_j
string ls_Filename
string ls_Url
string ls_Current_page
string ls_First_page_url
string ls_From
string ls_Last_page
string ls_Last_page_url
string ls_Next_page_url
string ls_Path
string ls_Per_page
string ls_Prev_page_url
string ls_V_to
string ls_Total
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Http.SetRequestHeader("Accept","application/json")
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://api-v2.fattureincloud.it/c/:company_id/emails",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// 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
ls_Current_page = loo_JResp.StringOf("current_page")
ls_First_page_url = loo_JResp.StringOf("first_page_url")
ls_From = loo_JResp.StringOf("from")
ls_Last_page = loo_JResp.StringOf("last_page")
ls_Last_page_url = loo_JResp.StringOf("last_page_url")
ls_Next_page_url = loo_JResp.StringOf("next_page_url")
ls_Path = loo_JResp.StringOf("path")
ls_Per_page = loo_JResp.StringOf("per_page")
ls_Prev_page_url = loo_JResp.StringOf("prev_page_url")
ls_V_to = loo_JResp.StringOf("to")
ls_Total = loo_JResp.StringOf("total")
i = 0
li_Count_i = loo_JResp.SizeOfArray("data")
do while i < li_Count_i
loo_JResp.I = i
ls_Id = loo_JResp.StringOf("data[i].id")
ls_Status = loo_JResp.StringOf("data[i].status")
ls_Sent_date = loo_JResp.StringOf("data[i].sent_date")
ls_Errors_count = loo_JResp.StringOf("data[i].errors_count")
ls_Error_log = loo_JResp.StringOf("data[i].error_log")
ls_From_email = loo_JResp.StringOf("data[i].from_email")
ls_From_name = loo_JResp.StringOf("data[i].from_name")
ls_To_email = loo_JResp.StringOf("data[i].to_email")
ls_To_name = loo_JResp.StringOf("data[i].to_name")
ls_Subject = loo_JResp.StringOf("data[i].subject")
ls_Content = loo_JResp.StringOf("data[i].content")
ls_Copy_to = loo_JResp.StringOf("data[i].copy_to")
ls_Recipient_status = loo_JResp.StringOf("data[i].recipient_status")
ls_Recipient_date = loo_JResp.StringOf("data[i].recipient_date")
ls_Kind = loo_JResp.StringOf("data[i].kind")
j = 0
li_Count_j = loo_JResp.SizeOfArray("data[i].attachments")
do while j < li_Count_j
loo_JResp.J = j
ls_Filename = loo_JResp.StringOf("data[i].attachments[j].filename")
ls_Url = loo_JResp.StringOf("data[i].attachments[j].url")
j = j + 1
loop
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
