Chilkat Tools

Objective-C / Fatture in Cloud API v2 - API Reference / List emails

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://api-v2.fattureincloud.it/c/:company_id/emails" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

// 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

NSString *id = 0;
NSString *status = 0;
NSString *sent_date = 0;
NSString *errors_count = 0;
NSString *error_log = 0;
NSString *from_email = 0;
NSString *from_name = 0;
NSString *to_email = 0;
NSString *to_name = 0;
NSString *subject = 0;
NSString *content = 0;
NSString *copy_to = 0;
NSString *recipient_status = 0;
NSString *recipient_date = 0;
NSString *kind = 0;
int j;
int count_j;
NSString *filename = 0;
NSString *url = 0;

NSString *current_page = [jResp StringOf: @"current_page"];
NSString *first_page_url = [jResp StringOf: @"first_page_url"];
NSString *from = [jResp StringOf: @"from"];
NSString *last_page = [jResp StringOf: @"last_page"];
NSString *last_page_url = [jResp StringOf: @"last_page_url"];
NSString *next_page_url = [jResp StringOf: @"next_page_url"];
NSString *path = [jResp StringOf: @"path"];
NSString *per_page = [jResp StringOf: @"per_page"];
NSString *prev_page_url = [jResp StringOf: @"prev_page_url"];
NSString *v_to = [jResp StringOf: @"to"];
NSString *total = [jResp StringOf: @"total"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"data"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    id = [jResp StringOf: @"data[i].id"];
    status = [jResp StringOf: @"data[i].status"];
    sent_date = [jResp StringOf: @"data[i].sent_date"];
    errors_count = [jResp StringOf: @"data[i].errors_count"];
    error_log = [jResp StringOf: @"data[i].error_log"];
    from_email = [jResp StringOf: @"data[i].from_email"];
    from_name = [jResp StringOf: @"data[i].from_name"];
    to_email = [jResp StringOf: @"data[i].to_email"];
    to_name = [jResp StringOf: @"data[i].to_name"];
    subject = [jResp StringOf: @"data[i].subject"];
    content = [jResp StringOf: @"data[i].content"];
    copy_to = [jResp StringOf: @"data[i].copy_to"];
    recipient_status = [jResp StringOf: @"data[i].recipient_status"];
    recipient_date = [jResp StringOf: @"data[i].recipient_date"];
    kind = [jResp StringOf: @"data[i].kind"];
    j = 0;
    count_j = [[jResp SizeOfArray: @"data[i].attachments"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        filename = [jResp StringOf: @"data[i].attachments[j].filename"];
        url = [jResp StringOf: @"data[i].attachments[j].url"];
        j = j + 1;
    }

    i = i + 1;
}

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

Chilkat Online Tools

Objective-C / Fatture in Cloud API v2 - API Reference / List emails

Curl Command

Postman Collection Item JSON