custom:interoperability:api_cde

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

NameLocationTypeRequiredDescription
codCityquerystring no codCity
codDistrictquerystring no codDistrict
codNationquerystring no codNation
codProvincequerystring no codProvince
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdcreateObjectUsingPOST_1”></a>

## POST Crea un nuovo immobile nel sistema.

POST /cde-api/building-api/buildings

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdupdateObjectUsingPUT_1”></a>

## PUT Modifica un immobile esistente nel sistema.

PUT /cde-api/building-api/buildings

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdgetObjectUsingGET_1”></a>

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

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

### Params

NameLocationTypeRequiredDescription
codBuildingpathstring yes codBuilding
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIddeleteObjectUsingDELETE_1”></a>

## DELETE Elimina un immobile dal sistema.

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

### Params

NameLocationTypeRequiredDescription
codBuildingpathstring yes codBuilding
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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 ContentInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

# CDE-API/Documents

<a id=“opIdgetObjectsUsingGET”></a>

## GET Restituisce la lista di tutti gli archivi

GET /cde-api/document-api/archives

### Params

NameLocationTypeRequiredDescription
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdcreateObjectUsingPOST”></a>

## POST Crea un nuovo archivio nel sistema.

POST /cde-api/document-api/archives

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdupdateObjectUsingPUT”></a>

## PUT Modifica un archivio esistente nel sistema.

PUT /cde-api/document-api/archives

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdgetObjectUsingGET”></a>

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

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

### Params

NameLocationTypeRequiredDescription
codClassArcpathstring yes codClassArc
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIddeleteObjectUsingDELETE”></a>

## DELETE Elimina un archivio dal sistema.

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

### Params

NameLocationTypeRequiredDescription
codClassArcpathstring yes codClassArc
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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 ContentInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codClassArcpathstring yes codClassArc
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdgetObjectsUsingGET_5”></a>

## GET Restituisce la lista di tutte le categorie

GET /cde-api/document-api/categories

### Params

NameLocationTypeRequiredDescription
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdcreateObjectUsingPOST_3”></a>

## POST Crea un nuova categoria nel sistema.

POST /cde-api/document-api/categories

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdupdateObjectUsingPUT_3”></a>

## PUT Modifica una categoria esistente nel sistema.

PUT /cde-api/document-api/categories

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdgetObjectUsingGET_3”></a>

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

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

### Params

NameLocationTypeRequiredDescription
codClassCatpathstring yes codClassCat
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIddeleteObjectUsingDELETE_3”></a>

## DELETE Elimina una categoria dal sistema.

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

### Params

NameLocationTypeRequiredDescription
codClassCatpathstring yes codClassCat
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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 ContentInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codClassCatpathstring yes codClassCat
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdgetObjectsUsingGET_6”></a>

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

GET /cde-api/document-api/documents

### Params

NameLocationTypeRequiredDescription
codObjectquerystring yes codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdcreateObjectUsingPOST_4”></a>

## POST Crea un nuovo contenuto nel sistema.

POST /cde-api/document-api/documents

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdupdateObjectUsingPUT_4”></a>

## PUT Modifica un documento esistente nel sistema.

PUT /cde-api/document-api/documents

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdgetObjectUsingGET_4”></a>

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

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

### Params

NameLocationTypeRequiredDescription
codContentpathstring yes codContent
codObjectquerystring yes codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIddeleteObjectUsingDELETE_4”></a>

## DELETE Elimina un documento dal sistema.

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

### Params

NameLocationTypeRequiredDescription
codContentpathstring yes codContent
codObjectquerystring yes codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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 ContentInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdgetContentMetadataUsingGET”></a>

## GET Restituisce i metadati di un documento

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

### Params

NameLocationTypeRequiredDescription
codContentpathstring yes codContent
codObjectquerystring yes codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codContentpathstring yes codContent
codObjectquerystring yes codObject
countryquerystring no none
displayCountryquerystring no none
displayLanguagequerystring no none
displayNamequerystring no none
displayScriptquerystring no none
displayVariantquerystring no none
extensionKeysqueryarray[string] no none
ISO3Countryquerystring no none
ISO3Languagequerystring no none
languagequerystring no none
objectIdquerystring no objectId
scriptquerystring no none
unicodeLocaleAttributesqueryarray[string] no none
unicodeLocaleKeysqueryarray[string] no none
variantquerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codContentpathstring yes codContent
documentVersionpathstring yes documentVersion
codObjectquerystring yes codObject
countryquerystring no none
displayCountryquerystring no none
displayLanguagequerystring no none
displayNamequerystring no none
displayScriptquerystring no none
displayVariantquerystring no none
extensionKeysqueryarray[string] no none
ISO3Countryquerystring no none
ISO3Languagequerystring no none
languagequerystring no none
scriptquerystring no none
unicodeLocaleAttributesqueryarray[string] no none
unicodeLocaleKeysqueryarray[string] no none
variantquerystring no none
Response Examples
200 Response

``` {} ```

### Responses

HTTP Status Code MeaningDescriptionData schema
200[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)OKInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

<a id=“opIdgetObjectsUsingGET_11”></a>

## GET Restituisce la lista di tutti i gruppi

GET /cde-api/document-api/groupers

### Params

NameLocationTypeRequiredDescription
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdcreateObjectUsingPOST_7”></a>

## POST Crea un nuovo gruppo nel sistema.

POST /cde-api/document-api/groupers

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdupdateObjectUsingPUT_7”></a>

## PUT Modifica un gruppo esistente nel sistema.

PUT /cde-api/document-api/groupers

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdgetObjectUsingGET_7”></a>

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

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

### Params

NameLocationTypeRequiredDescription
codGrouperpathstring yes codGrouper
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIddeleteObjectUsingDELETE_7”></a>

## DELETE Elimina un gruppo dal sistema.

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

### Params

NameLocationTypeRequiredDescription
codGrouperpathstring yes codGrouper
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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 ContentInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdgetObjectsUsingGET_14”></a>

## GET Restituisce la lista di tutte le sottocategorie

GET /cde-api/document-api/subcategories

### Params

NameLocationTypeRequiredDescription
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdcreateObjectUsingPOST_9”></a>

## POST Crea un nuova sottocategoria nel sistema.

POST /cde-api/document-api/subcategories

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdupdateObjectUsingPUT_9”></a>

## PUT Modifica una sottocategoria esistente nel sistema.

PUT /cde-api/document-api/subcategories

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdgetObjectUsingGET_9”></a>

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

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

### Params

NameLocationTypeRequiredDescription
codClassSubCatpathstring yes codClassSubCat
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIddeleteObjectUsingDELETE_9”></a>

## DELETE Elimina una sottocategoria dal sistema.

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

### Params

NameLocationTypeRequiredDescription
codClassSubCatpathstring yes codClassSubCat
codObjectquerystring no codObject
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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 ContentInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

# 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 MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdcreateObjectUsingPOST_6”></a>

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

POST /cde-api/functions-api/functions

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdupdateObjectUsingPUT_6”></a>

## PUT Modifica una funzione esistente nel sistema.

PUT /cde-api/functions-api/functions

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codBuildingpathstring yes codBuilding
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codBuildingpathstring yes codBuilding
codPositionpathstring yes codPosition
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIddeleteObjectUsingDELETE_6”></a>

## DELETE Elimina una funzione dal sistema.

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

### Params

NameLocationTypeRequiredDescription
codFunctionpathstring yes codFunction
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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 ContentInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

# 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 MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdcreateObjectUsingPOST_2”></a>

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

POST /cde-api/ui-api/ui

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdupdateObjectUsingPUT_2”></a>

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

PUT /cde-api/ui-api/ui

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codBuildingpathstring yes codBuilding
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codBuildingpathstring yes codBuilding
codPositionpathstring yes codPosition
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdgetObjectUsingGET_2”></a>

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

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

### Params

NameLocationTypeRequiredDescription
codHierUipathstring yes codHierUi
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIddeleteObjectUsingDELETE_2”></a>

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

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

### Params

NameLocationTypeRequiredDescription
codHierUipathstring yes codHierUi
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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 ContentInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

# 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 MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdcreateObjectUsingPOST_5”></a>

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

POST /cde-api/equipment-api/equipments

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdupdateObjectUsingPUT_5”></a>

## PUT Modifica un'attrezzatura esistente nel sistema.

PUT /cde-api/equipment-api/equipments

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codBuildingpathstring yes codBuilding
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codBuildingpathstring yes codBuilding
codPositionpathstring yes codPosition
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIddeleteObjectUsingDELETE_5”></a>

## DELETE Elimina un'attrezzatura dal sistema.

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

### Params

NameLocationTypeRequiredDescription
codEquipmentpathstring yes codEquipment
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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 ContentInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

# 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 MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdcreateObjectUsingPOST_8”></a>

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

POST /cde-api/positions-api/positions

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIdupdateObjectUsingPUT_8”></a>

## PUT Modifica una posizione esistente nel sistema.

PUT /cde-api/positions-api/positions

### Params

NameLocationTypeRequiredDescription
codequerystring no none
descriptionquerystring no none
idqueryinteger(int32) no none
namequerystring no none
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)CreatedInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codBuildingpathstring yes codBuilding
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<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

NameLocationTypeRequiredDescription
codPositionpathstring yes codPosition
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline
404[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)Not FoundInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

<a id=“opIddeleteObjectUsingDELETE_8”></a>

## DELETE Elimina una posizione dal sistema.

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

### Params

NameLocationTypeRequiredDescription
codPositionpathstring yes codPosition
Response Examples
200 Response

``` {“code”:0,“description”:“string”,“responseMap”:{},“status”:“string”} ```

### Responses

HTTP Status Code MeaningDescriptionData 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 ContentInline
401[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)UnauthorizedInline
403[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)ForbiddenInline

### Responses Data Schema

HTTP Status Code 200

*JsonResponse*

NameTypeRequiredRestrictionsTitledescription
» codeinteger(int32)falsenonenone
» descriptionstringfalsenonenone
» responseMapobjectfalsenonenone
» statusstringfalsenonenone

# 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

NameTypeRequiredRestrictionsTitleDescription
codeinteger(int32)falsenonenone
descriptionstringfalsenonenone
responseMapobjectfalsenonenone
statusstringfalsenonenone
  • custom/interoperability/api_cde.txt
  • Ultima modifica: 2025/04/10 09:40
  • da francesco.rosati