custom:interoperability:api_cde [GeowebFramework]

Questa pagina è in sola lettura. Puoi visualizzare il sorgente, ma non puoi modificarlo. Contatta l'amministratore se pensi che ci sia un errore.
API CDE

# Authentication

# CDE-API/Buildings

<a id="opIdgetObjectsUsingGET_1"></a>

## GET Restituisce la lista degli immobili disponibili

GET /cde-api/building-api/buildings

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codCity|query|string| no |codCity|
|codDistrict|query|string| no |codDistrict|
|codNation|query|string| no |codNation|
|codProvince|query|string| no |codProvince|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdcreateObjectUsingPOST_1"></a>

## POST Crea un nuovo immobile nel sistema.

POST /cde-api/building-api/buildings

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdupdateObjectUsingPUT_1"></a>

## PUT Modifica un immobile esistente nel sistema.

PUT /cde-api/building-api/buildings

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectUsingGET_1"></a>

## GET Restituisce un singolo edificio in base al codice fornito

GET /cde-api/building-api/buildings/{codBuilding}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codBuilding|path|string| yes |codBuilding|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIddeleteObjectUsingDELETE_1"></a>

## DELETE Elimina un immobile dal sistema.

DELETE /cde-api/building-api/buildings/{codBuilding}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codBuilding|path|string| yes |codBuilding|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

# CDE-API/Documents

<a id="opIdgetObjectsUsingGET"></a>

## GET Restituisce la lista di tutti gli archivi

GET /cde-api/document-api/archives

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdcreateObjectUsingPOST"></a>

## POST Crea un nuovo archivio nel sistema.

POST /cde-api/document-api/archives

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdupdateObjectUsingPUT"></a>

## PUT Modifica un archivio esistente nel sistema.

PUT /cde-api/document-api/archives

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectUsingGET"></a>

## GET Restituisce i dettagli di un archivio in base al codice fornito

GET /cde-api/document-api/archives/{codClassArc}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codClassArc|path|string| yes |codClassArc|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIddeleteObjectUsingDELETE"></a>

## DELETE Elimina un archivio dal sistema.

DELETE /cde-api/document-api/archives/{codClassArc}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codClassArc|path|string| yes |codClassArc|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetSubObjectsUsingGET"></a>

## GET Restituisce la lista di tutte le categorie di un archivio in base al codice fornito

GET /cde-api/document-api/archives/{codClassArc}/categories

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codClassArc|path|string| yes |codClassArc|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectsUsingGET_5"></a>

## GET Restituisce la lista di tutte le categorie

GET /cde-api/document-api/categories

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdcreateObjectUsingPOST_3"></a>

## POST Crea un nuova categoria nel sistema.

POST /cde-api/document-api/categories

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdupdateObjectUsingPUT_3"></a>

## PUT Modifica una categoria esistente nel sistema.

PUT /cde-api/document-api/categories

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectUsingGET_3"></a>

## GET Restituisce una categoria specifica in base al codice fornito

GET /cde-api/document-api/categories/{codClassCat}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codClassCat|path|string| yes |codClassCat|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIddeleteObjectUsingDELETE_3"></a>

## DELETE Elimina una categoria dal sistema.

DELETE /cde-api/document-api/categories/{codClassCat}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codClassCat|path|string| yes |codClassCat|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetSubObjectsUsingGET_1"></a>

## GET Restituisce la lista di tutte le sottocategorie di una categoria in base al codice fornito

GET /cde-api/document-api/categories/{codClassCat}/subcategories

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codClassCat|path|string| yes |codClassCat|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectsUsingGET_6"></a>

## GET Restituisce la lista dei documenti disponibili per un singolo edificio

GET /cde-api/document-api/documents

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codObject|query|string| yes |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdcreateObjectUsingPOST_4"></a>

## POST Crea un nuovo contenuto nel sistema.

POST /cde-api/document-api/documents

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdupdateObjectUsingPUT_4"></a>

## PUT Modifica un documento esistente nel sistema.

PUT /cde-api/document-api/documents

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectUsingGET_4"></a>

## GET Restituisce un singolo contenuto in base al codice fornito

GET /cde-api/document-api/documents/{codContent}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codContent|path|string| yes |codContent|
|codObject|query|string| yes |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIddeleteObjectUsingDELETE_4"></a>

## DELETE Elimina un documento dal sistema.

DELETE /cde-api/document-api/documents/{codContent}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codContent|path|string| yes |codContent|
|codObject|query|string| yes |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetContentMetadataUsingGET"></a>

## GET Restituisce i metadati di un documento

GET /cde-api/document-api/documents/{codContent}/metadata

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codContent|path|string| yes |codContent|
|codObject|query|string| yes |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetContentDetailsUsingGET"></a>

## GET Restituisce l'elenco delle versioni di un documento. Ogni versione ha il link per scaricarne il contenuto

GET /cde-api/document-api/documents/{codContent}/versions

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codContent|path|string| yes |codContent|
|codObject|query|string| yes |codObject|
|country|query|string| no |none|
|displayCountry|query|string| no |none|
|displayLanguage|query|string| no |none|
|displayName|query|string| no |none|
|displayScript|query|string| no |none|
|displayVariant|query|string| no |none|
|extensionKeys|query|array[string]| no |none|
|ISO3Country|query|string| no |none|
|ISO3Language|query|string| no |none|
|language|query|string| no |none|
|objectId|query|string| no |objectId|
|script|query|string| no |none|
|unicodeLocaleAttributes|query|array[string]| no |none|
|unicodeLocaleKeys|query|array[string]| no |none|
|variant|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetContentVersionUsingGET"></a>

## GET Esegue download del contenuto di una versione specifica del documento

GET /cde-api/document-api/documents/{codContent}/versions/{documentVersion}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codContent|path|string| yes |codContent|
|documentVersion|path|string| yes |documentVersion|
|codObject|query|string| yes |codObject|
|country|query|string| no |none|
|displayCountry|query|string| no |none|
|displayLanguage|query|string| no |none|
|displayName|query|string| no |none|
|displayScript|query|string| no |none|
|displayVariant|query|string| no |none|
|extensionKeys|query|array[string]| no |none|
|ISO3Country|query|string| no |none|
|ISO3Language|query|string| no |none|
|language|query|string| no |none|
|script|query|string| no |none|
|unicodeLocaleAttributes|query|array[string]| no |none|
|unicodeLocaleKeys|query|array[string]| no |none|
|variant|query|string| no |none|

> Response Examples

> 200 Response

```
{}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

<a id="opIdgetObjectsUsingGET_11"></a>

## GET Restituisce la lista di tutti i gruppi

GET /cde-api/document-api/groupers

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdcreateObjectUsingPOST_7"></a>

## POST Crea un nuovo gruppo nel sistema.

POST /cde-api/document-api/groupers

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdupdateObjectUsingPUT_7"></a>

## PUT Modifica un gruppo esistente nel sistema.

PUT /cde-api/document-api/groupers

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectUsingGET_7"></a>

## GET Restituisce un gruppo specifico in base al codice fornito

GET /cde-api/document-api/groupers/{codGrouper}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codGrouper|path|string| yes |codGrouper|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIddeleteObjectUsingDELETE_7"></a>

## DELETE Elimina un gruppo dal sistema.

DELETE /cde-api/document-api/groupers/{codGrouper}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codGrouper|path|string| yes |codGrouper|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectsUsingGET_14"></a>

## GET Restituisce la lista di tutte le sottocategorie

GET /cde-api/document-api/subcategories

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdcreateObjectUsingPOST_9"></a>

## POST Crea un nuova sottocategoria nel sistema.

POST /cde-api/document-api/subcategories

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdupdateObjectUsingPUT_9"></a>

## PUT Modifica una sottocategoria esistente nel sistema.

PUT /cde-api/document-api/subcategories

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectUsingGET_9"></a>

## GET Restituisce una sottocategoria specifica in base al codice fornito

GET /cde-api/document-api/subcategories/{codClassSubCat}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codClassSubCat|path|string| yes |codClassSubCat|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIddeleteObjectUsingDELETE_9"></a>

## DELETE Elimina una sottocategoria dal sistema.

DELETE /cde-api/document-api/subcategories/{codClassSubCat}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codClassSubCat|path|string| yes |codClassSubCat|
|codObject|query|string| no |codObject|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

# CDE-API/Functions

<a id="opIdgetObjectsUsingGET_9"></a>

## GET Restituisce la lista funzioni svolte nel sistema.

GET /cde-api/functions-api/functions

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdcreateObjectUsingPOST_6"></a>

## POST Crea un nuova funzione dell'immobile  nel sistema.

POST /cde-api/functions-api/functions

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdupdateObjectUsingPUT_6"></a>

## PUT Modifica una funzione esistente nel sistema.

PUT /cde-api/functions-api/functions

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectUsingGET_6"></a>

## GET Restituisce una singola funzione dell'immobile in base al codice immobile fornito

GET /cde-api/functions-api/functions/{codBuilding}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codBuilding|path|string| yes |codBuilding|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectsUsingGET_10"></a>

## GET Restituisce una singola funzione in base ai filtri codice edificio e codice posizione forniti

GET /cde-api/functions-api/functions/{codBuilding}/{codPosition}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codBuilding|path|string| yes |codBuilding|
|codPosition|path|string| yes |codPosition|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIddeleteObjectUsingDELETE_6"></a>

## DELETE Elimina una funzione dal sistema.

DELETE /cde-api/functions-api/functions/{codFunction}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codFunction|path|string| yes |codFunction|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

# CDE-API/Building Unit

<a id="opIdgetObjectsUsingGET_2"></a>

## GET Restituisce la lista delle unità immobiliari disponibili nel sistema

GET /cde-api/ui-api/ui

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdcreateObjectUsingPOST_2"></a>

## POST Crea un nuova unità immobiliare dell'immobile nel sistema.

POST /cde-api/ui-api/ui

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdupdateObjectUsingPUT_2"></a>

## PUT Modifica un'unità immobiliare esistente nel sistema.

PUT /cde-api/ui-api/ui

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectsUsingGET_4"></a>

## GET Restituisce una lista delle unità immobiliari base al codice immobile fornito

GET /cde-api/ui-api/ui/{codBuilding}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codBuilding|path|string| yes |codBuilding|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectsUsingGET_3"></a>

## GET Restituisce una lista di unità immobiliari in base ai filtri codice edificio e codice posizione forniti

GET /cde-api/ui-api/ui/{codBuilding}/{codPosition}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codBuilding|path|string| yes |codBuilding|
|codPosition|path|string| yes |codPosition|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectUsingGET_2"></a>

## GET Restituisce una singola unità immobiliare base al codice immobile fornito

GET /cde-api/ui-api/ui/{codHierUi}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codHierUi|path|string| yes |codHierUi|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIddeleteObjectUsingDELETE_2"></a>

## DELETE Elimina un'unità immobiliare dal sistema.

DELETE /cde-api/ui-api/ui/{codHierUi}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codHierUi|path|string| yes |codHierUi|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

# CDE-API/Equipment

<a id="opIdgetObjectsUsingGET_7"></a>

## GET Restituisce la lista delle attrezzature disponibili

GET /cde-api/equipment-api/equipments

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdcreateObjectUsingPOST_5"></a>

## POST Crea un nuova attrezzatura dell'immobile  nel sistema.

POST /cde-api/equipment-api/equipments

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdupdateObjectUsingPUT_5"></a>

## PUT Modifica un'attrezzatura esistente nel sistema.

PUT /cde-api/equipment-api/equipments

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectUsingGET_5"></a>

## GET Restituisce una singola attrezzatura dell'immobile in base al codice immobile fornito

GET /cde-api/equipment-api/equipments/{codBuilding}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codBuilding|path|string| yes |codBuilding|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectsUsingGET_8"></a>

## GET Restituisce una singola attrezzatura in base ai filtri codice edificio e codice posizione forniti

GET /cde-api/equipment-api/equipments/{codBuilding}/{codPosition}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codBuilding|path|string| yes |codBuilding|
|codPosition|path|string| yes |codPosition|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIddeleteObjectUsingDELETE_5"></a>

## DELETE Elimina un'attrezzatura dal sistema.

DELETE /cde-api/equipment-api/equipments/{codEquipment}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codEquipment|path|string| yes |codEquipment|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

# CDE-API/Positions

<a id="opIdgetObjectsUsingGET_12"></a>

## GET Restituisce la lista di tutte le posizioni degli immobili disponibili

GET /cde-api/positions-api/positions

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdcreateObjectUsingPOST_8"></a>

## POST Crea un nuova posizione dell'immobile  nel sistema.

POST /cde-api/positions-api/positions

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdupdateObjectUsingPUT_8"></a>

## PUT Modifica una posizione esistente nel sistema.

PUT /cde-api/positions-api/positions

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|code|query|string| no |none|
|description|query|string| no |none|
|id|query|integer(int32)| no |none|
|name|query|string| no |none|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|Created|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectsUsingGET_13"></a>

## GET Restituisce una lista di posizioni in base al codice immobile fornito

GET /cde-api/positions-api/positions/{codBuilding}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codBuilding|path|string| yes |codBuilding|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIdgetObjectUsingGET_8"></a>

## GET Restituisce una singola posizione dell'immobile in base al codice immobile fornito

GET /cde-api/positions-api/positions/{codPosition}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codPosition|path|string| yes |codPosition|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|
|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

<a id="opIddeleteObjectUsingDELETE_8"></a>

## DELETE Elimina una posizione dal sistema.

DELETE /cde-api/positions-api/positions/{codPosition}

### Params

|Name|Location|Type|Required|Description|
|---|---|---|---|---|
|codPosition|path|string| yes |codPosition|

> Response Examples

> 200 Response

```
{"code":0,"description":"string","responseMap":{},"status":"string"}
```

### Responses

|HTTP Status Code |Meaning|Description|Data schema|
|---|---|---|---|
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JsonResponse](#schemajsonresponse)|
|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Unauthorized|Inline|
|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|Inline|

### Responses Data Schema

HTTP Status Code **200**

*JsonResponse*

|Name|Type|Required|Restrictions|Title|description|
|---|---|---|---|---|---|
|» code|integer(int32)|false|none||none|
|» description|string|false|none||none|
|» responseMap|object|false|none||none|
|» status|string|false|none||none|

# Data Schema

<h2 id="tocS_JsonResponse">JsonResponse</h2>

<a id="schemajsonresponse"></a>
<a id="schema_JsonResponse"></a>
<a id="tocSjsonresponse"></a>
<a id="tocsjsonresponse"></a>

```json
{
  "code": 0,
  "description": "string",
  "responseMap": {},
  "status": "string"
}

```

JsonResponse

### Attribute

|Name|Type|Required|Restrictions|Title|Description|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|description|string|false|none||none|
|responseMap|object|false|none||none|
|status|string|false|none||none|