How do I identify the item's response in the API?

Modified on Fri, 6 Mar at 10:32 AM


Understand Response Scales

In Checklist Fácil, it is possible to configure different types of responses to be filled out during the application of a checklist. We call this configuration the item scale.


For developers and analysts who consume our API, it is fundamental to understand the relationship between the configured scale and the property that will be returned with the response.


 To correctly identify the response type in the integration, you must consider the scaleId property of the item and consult the table below.


API Reference Table

Use the following table to map the Scale Code (scaleId) with the visual response type and the respective API property where the data will be found.


Scale Code (scaleId)Response Scale (Visual)API Property
1Evaluative - 2 facesevaluative
1001Evaluative - No/Yesevaluative
2Evaluative - 3 facesevaluative
4Short texttext
5Monetarynumber
6Quantitynumber
7Decimalnumber
8Date (dd/mm/yyyy)text
9No options (Statement only)-
10Single selection listselectedOptions
1010Multiple selection listselectedOptions
12Zip Codetext
13StatestateId
14State and CitycityId
15Phonetext
16CNPJ (Tax ID)text
17CPF (Tax ID)text
20Long texttext
21GPStext
22Barcode / QR Codestext
2324h Timetext
102324h Time (s)text
2412h Timetext
102412h Time (s)text
25Vehicle Plate (Old Standard)text
1025Mercosul Platetext
26Productproduct
27Date (mm/yyyy)text
28Competence PeriodcompetencePeriodId
29Temperaturenumber
30Custom indexindex
31Emailtext


❓Tem dúvidas? Entre em contato com nosso time de suporte.