==========
Ubicazioni
==========

Regioni
=======

Lista regioni
-------------

+--------+--------------+--------+--------+--------+
| Method | URL          | DM1104 | DPR462 | DPR162 |
+--------+--------------+--------+--------+--------+
| GET    | /api/Regions | ✓      | ✓      | ✓      |
+--------+--------------+--------+--------+--------+

Descrizione
^^^^^^^^^^^

Restituisce la lista delle regioni e relativi ID

Esempio di risposta positiva
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: json

    {
        "status": 0,
        "errorCode": null,
        "errorMessage": [],
        "response": {
            "regions": [
            {
                "id": 1,
                "name": "Marche"
            },
            {
                "id": 2,
                "name": "Abruzzo"
            },
            {
                "id": 3,
                "name": "Basilicata"
            },
            {
                "id": 4,
                "name": "Molise"
            },
            {
                "id": 5,
                "name": "Trentino Alto Adige"
            },
            {
                "id": 6,
                "name": "Puglia"
            },
            {
                "id": 7,
                "name": "Calabria"
            },
            {
                "id": 8,
                "name": "Campania"
            },
            {
                "id": 9,
                "name": "Lazio"
            },
            {
                "id": 10,
                "name": "Sardegna"
            },
            {
                "id": 11,
                "name": "Sicilia"
            },
            {
                "id": 12,
                "name": "Toscana"
            },
            {
                "id": 13,
                "name": "Piemonte"
            },
            {
                "id": 14,
                "name": "Emilia Romagna"
            },
            {
                "id": 15,
                "name": "Friuli Venezia Giulia"
            },
            {
                "id": 16,
                "name": "Valle d'Aosta"
            },
            {
                "id": 17,
                "name": "Veneto"
            },
            {
                "id": 18,
                "name": "Liguria"
            },
            {
                "id": 19,
                "name": "Lombardia"
            },
            {
                "id": 20,
                "name": "Umbria"
            }
            ]
        }
    }

Aggiunta regione
----------------

+--------+---------------------+--------+--------+--------+
| Method | URL                 | DM1104 | DPR462 | DPR162 |
+--------+---------------------+--------+--------+--------+
| PUT    | /api/Regions/       | ✓      | ✓      | ✓      |
+--------+---------------------+--------+--------+--------+

Descrizione
^^^^^^^^^^^

Crea una nuova regione e ne restituisce l'istanza

Parametri in input
^^^^^^^^^^^^^^^^^^

+-------------+---------+---------------------------+--------+
| Field Name  | Require | Descrizione               | Type   |
+=============+=========+===========================+========+
| name        | Si      | Nome della regione        | string |
+-------------+---------+---------------------------+--------+

Esempio di risposta positiva
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: json

    {
      "status": 0,
      "errorCode": null,
      "errorMessage": [],
      "response": {
        "id": 0,
        "name": "name"
      }
    }

Disattivazione regione
----------------------

+--------+---------------------------+--------+--------+--------+
| Method | URL                       | DM1104 | DPR462 | DPR162 |
+--------+---------------------------+--------+--------+--------+
| DELETE | /api/Regions/{regionId}   | ✓      | ✓      | ✓      |
+--------+---------------------------+--------+--------+--------+

Descrizione
^^^^^^^^^^^

Disattiva una regione

Parametri in input
^^^^^^^^^^^^^^^^^^

+------------+----------+--------------------------------------------+---------+
| Field Name | Required | Descrizione                                | Type    |
+============+==========+============================================+=========+
| regionId   | Si       | Identificativo regione da disabilitare     | integer |
+------------+----------+--------------------------------------------+---------+

Esempio di risposta positiva
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: json

    {
      "status": 0,
      "errorCode": null,
      "errorMessage": [],
      "response": {}
    }

Province
========

Lista province
--------------

+--------+---------------------------+--------+--------+--------+
| Method | URL                       | DM1104 | DPR462 | DPR162 |
+--------+---------------------------+--------+--------+--------+
| GET    | /api/Provinces/{regionId} | ✓      | ✓      | ✓      |
+--------+---------------------------+--------+--------+--------+


Descrizione
^^^^^^^^^^^

Restituisce la lista delle province e relativi ID della regione richiesta

Parametri in input
^^^^^^^^^^^^^^^^^^

+------------+----------+-------------------------------------------------------+---------+
| Field Name | Required | Descrizione                                           | Type    |
+============+==========+=======================================================+=========+
| regionId   | Si       | Identificativo regione per cui richiedere le province | integer |
+------------+----------+-------------------------------------------------------+---------+

Esempio di risposta positiva
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: json

    {
        "status": 0,
        "errorCode": null,
        "errorMessage": [],
        "response":
        {
            "provinces": [
            {
                "id": 39,
                "name": "Frosinone",
                "code": "FR"
            },
            {
                "id": 40,
                "name": "Latina",
                "code": "LT"
            },
            {
                "id": 41,
                "name": "Rieti",
                "code": "RI"
            },
            {
                "id": 42,
                "name": "Roma",
                "code": "RM"
            },
            {
                "id": 43,
                "name": "Viterbo",
                "code": "VT"
            } ]
        }
    }

Aggiunta provincia
------------------

+--------+---------------------+--------+--------+--------+
| Method | URL                 | DM1104 | DPR462 | DPR162 |
+--------+---------------------+--------+--------+--------+
| PUT    | /api/Provinces/     | ✓      | ✓      | ✓      |
+--------+---------------------+--------+--------+--------+

Descrizione
^^^^^^^^^^^

Crea una nuova provincia e ne restituisce l'istanza

Parametri in input
^^^^^^^^^^^^^^^^^^

+------------+---------+---------------------------------------------------+---------+
| Field Name | Require | Descrizione                                       | Type    |
+------------+---------+---------------------------------------------------+---------+
| name       | Si      | Nome intero della provincia                       | string  |
+------------+---------+---------------------------------------------------+---------+
| code       | Si      | Codice provincia                                  | string  |
+------------+---------+---------------------------------------------------+---------+
| regionId   | Si      | CRM id della regione di cui fa parte la provincia | integer |
+------------+---------+---------------------------------------------------+---------+
| odooId     | Si      | Identificativo Odoo della specifica provincia     | string  |
+------------+---------+---------------------------------------------------+---------+

Esempio di risposta positiva
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: json

    {
      "status": 0,
      "errorCode": null,
      "errorMessage": [],
      "response": {
        "id": 0,
        "name": "name",
        "regionId": 0,
        "code": "code",
        "odooId": "0"
      }
    }

Disattivazione provincia
------------------------

+--------+-----------------------------+--------+--------+--------+
| Method | URL                         | DM1104 | DPR462 | DPR162 |
+--------+-----------------------------+--------+--------+--------+
| DELETE | /api/Provinces/{provinceId} | ✓      | ✓      | ✓      |
+--------+-----------------------------+--------+--------+--------+

Descrizione
^^^^^^^^^^^

Disattiva la provincia di riferimento

Parametri in input
^^^^^^^^^^^^^^^^^^

+-------------+----------+--------------------------------------------+---------+
| Field Name  | Required | Descrizione                                | Type    |
+=============+==========+============================================+=========+
| provinceId  | Si       | Identificativo provincia da disabilitare   | integer |
+-------------+----------+--------------------------------------------+---------+

Esempio di risposta positiva
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: json

    {
      "status": 0,
      "errorCode": null,
      "errorMessage": [],
      "response": {}
    }

Comuni
======

Lista Comuni
------------

+--------+--------------------------+--------+--------+--------+
| Method | URL                      | DM1104 | DPR462 | DPR162 |
+--------+--------------------------+--------+--------+--------+
| GET    | /api/Cities/{provinceId} | ✓      | ✓      | ✓      |
+--------+--------------------------+--------+--------+--------+

Descrizione
^^^^^^^^^^^

Restituisce la lista dei comuni e relativi ID della provincia richiesta

Parametri in input
^^^^^^^^^^^^^^^^^^

+------------+----------+------------------------------------------------------+---------+
| Field Name | Required | Descrizione                                          | Type    |
+============+==========+======================================================+=========+
| provinceId | Si       | Identificativo provincia per cui richiedere i comuni | integer |
+------------+----------+------------------------------------------------------+---------+


Esempio di risposta positiva
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: json

    {
        "status": 0,
        "errorCode": null,
        "errorMessage": [],
        "response":
        {
            "cities": [
            {
                "id": 2046,
                "name": "AFFILE"
            },
            {
                "id": 2047,
                "name": "AGOSTA"
            },
            {
                "id": 2048,
                "name": "ALBANO LAZIALE"
            },
            {
                "id": 2049,
                "name": "ALLUMIERE"
            },
            {
                "id": 2050,
                "name": "ANGUILLARA SABAZIA"
            },
            {
                "id": 2051,
                "name": "ANTICOLI CORRADO"
            },
            {
                "id": 2052,
                "name": "ANZIO"
            },
            {
                "id": 2053,
                "name": "ARCINAZZO ROMANO"
            },
            {
                "id": 2054,
                "name": "ARDEA"
            },
            {
                "id": 2055,
                "name": "ARICCIA"
            },
            {
                "id": 2056,
                "name": "ARSOLI"
            },
            {
                "id": 2057,
                "name": "ARTENA"
            },
            {
                "id": 2058,
                "name": "BELLEGRA"
            },
            {
                "id": 2059,
                "name": "BRACCIANO"
            }]
        }
    }

Aggiunta città
--------------

+--------+---------------------+--------+--------+--------+
| Method | URL                 | DM1104 | DPR462 | DPR162 |
+--------+---------------------+--------+--------+--------+
| PUT    | /api/Cities/        | ✓      | ✓      | ✓      |
+--------+---------------------+--------+--------+--------+

Descrizione
^^^^^^^^^^^

Crea una nuova città e ne restituisce l'istanza

Parametri in input
^^^^^^^^^^^^^^^^^^
+------------+---------+-------------------------------------------------+--------+
| Field Name | Require | Descrizione                                     | Type   |
+------------+---------+-------------------------------------------------+--------+
| name       | Si      | Nome intero della provincia                     | string |
+------------+---------+-------------------------------------------------+--------+
| regionId   | Si      | CRM id della regione di cui fa parte la città   | string |
+------------+---------+-------------------------------------------------+--------+
| provinceId | Si      | CRM id della provincia di cui fa parte la città | string |
+------------+---------+-------------------------------------------------+--------+
| odooId     | Si      | Identificativo Odoo della specifica provincia   | string |
+------------+---------+-------------------------------------------------+--------+

Esempio di risposta positiva
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: json

    {
      "status": 0,
      "errorCode": null,
      "errorMessage": [],
      "response": {
        "id": 0,
        "name": "string",
        "provinceId": 0,
        "regionId": 0,
        "odooId": "0"
      }
    }

Disattivazione città
----------------------

+--------+---------------------------+--------+--------+--------+
| Method | URL                       | DM1104 | DPR462 | DPR162 |
+--------+---------------------------+--------+--------+--------+
| DELETE | /api/Cities/{cityId}      | ✓      | ✓      | ✓      |
+--------+---------------------------+--------+--------+--------+

Descrizione
^^^^^^^^^^^

Disattiva la città di riferimento

Parametri in input
^^^^^^^^^^^^^^^^^^

+------------+----------+--------------------------------------------+---------+
| Field Name | Required | Descrizione                                | Type    |
+============+==========+============================================+=========+
| cityId     | Si       | Identificativo provincia da disabilitare   | integer |
+------------+----------+--------------------------------------------+---------+

Esempio di risposta positiva
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: json

    {
      "status": 0,
      "errorCode": null,
      "errorMessage": [],
      "response": {}
    }