Chilkat Online Tools

phpAx / Fatture in Cloud API v2 - API Reference / List Cities

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.Http");

$queryParams = new COM("Chilkat_9_5_0.JsonObject");
$queryParams->UpdateString('postal_code','<string>');
$queryParams->UpdateString('city','<string>');

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

// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->QuickRequestParams('GET','https://api-v2.fattureincloud.it/info/cities',$queryParams);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);

$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "data": [
//     {
//       "postal_code": "<string>",
//       "city": "<string>",
//       "province": "<string>"
//     },
//     {
//       "postal_code": "<string>",
//       "city": "<string>",
//       "province": "<string>"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$i = 0;
$count_i = $jResp->SizeOfArray('data');
while ($i < $count_i) {
    $jResp->I = $i;
    $postal_code = $jResp->stringOf('data[i].postal_code');
    $city = $jResp->stringOf('data[i].city');
    $province = $jResp->stringOf('data[i].province');
    $i = $i + 1;
}


?>

Curl Command

curl -G -d "postal_code=%3Cstring%3E"
	-d "city=%3Cstring%3E"
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/info/cities

Postman Collection Item JSON

{
  "name": "List Cities",
  "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}}/info/cities?postal_code=<string>&city=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "info",
        "cities"
      ],
      "query": [
        {
          "key": "postal_code",
          "value": "<string>",
          "description": "Postal code for filtering."
        },
        {
          "key": "city",
          "value": "<string>",
          "description": "City for filtering (ignored if postal_code is passed)."
        }
      ]
    },
    "description": "Lists the Italian cities."
  },
  "response": [
    {
      "name": "Cities List.",
      "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}}/info/cities?postal_code=<string>&city=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "info",
            "cities"
          ],
          "query": [
            {
              "key": "postal_code",
              "value": "<string>",
              "description": "Postal code for filtering."
            },
            {
              "key": "city",
              "value": "<string>",
              "description": "City for filtering (ignored if postal_code is passed)."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"data\": [\n    {\n      \"postal_code\": \"<string>\",\n      \"city\": \"<string>\",\n      \"province\": \"<string>\"\n    },\n    {\n      \"postal_code\": \"<string>\",\n      \"city\": \"<string>\",\n      \"province\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}