v1

latestOpenAPI 3.0.02026-07-2631334151.4 KB

Questionnaire

Get Questionnaire

Service used to search questionnaire one click

get/components/compositions/{compositionId}/questionnaires

Path parameters

compositionId10 | 21 required

Id of the Composition

10 - HDI EMPRESARIAL
21 - HDI CONDOMINIO PROTEGIDO

Query parameters

postalCodestring

postalCode

questionaryType1 | 2 | 3 required

Id of the Questionary Type

1 - Document
2 - Item
3 - Conductor

Headers

X-Application-Idstring required

Id of the Application that is using the API.

X-Company-Idstring required

Id of the Company that is using the API.

X-User-Idstring required

Id of the User that is using the API.

X-Trace-Idstring required

Trace ID

Response

Successful Request

idnumber

Id Of Component (2 - Residencial)

codestring

Code Of Component (2 - Residencial)

descritptionstring

Description Of Component

Example response

{
  "id": 2,
  "code": "2",
  "descritption": "RESIDENCIAL",
  "compositions": [
    {
      "id": 5,
      "code": "005",
      "descritption": "HDI RESIDENCIAL"
    }
  ]
}