List Classification Attributes
/classifications/{id}/classification_attributes
Get a list of classifications.
Get Classification Attributes [GET]
Authorization: Admin, Web, Mobile
Each classification attribute has a similar JSON schema, but a unique payload object that is determined by the type of question. This describes just the payload of an attribute with a specific question type.
question type / id | payload type |
---|---|
number (5) | measurement |
shortText (3) date (6) time (7) |
data |
singleSelect (1) comboBox (11) |
selection |
Measurement
"unitsOfMeasure": [ { "id": 2, "name": "feet", "ordinal": 0 }, { "id": 58, "name": "inches", "ordinal": 1 } ]
Field | Description |
---|---|
unitsOfMeasure[].id | id of unit of measure |
unitsOfMeasure[].name | name of unit of measure |
unitsOfMeasure[].ordinal | order of unit of measure |
Data
//Empty
Selection
"selections": [ { "id": 8972, "name": "Material", "ordinal": 3, "excludeQuestionIds": [100, 101] } ]
Field | Description |
---|---|
selections[].id | unique identifier of selection |
selections[].name | name of selection |
selections[].ordinal | ordinal of selection |
selections[].excludeQuestionIds | ids of questions to be excluded if selection is chosen |
Response 200
Body
{ "page": 1, "pages": 1, "count": 98, "items": [ { "id": 2908, "name": "Material", "ordinal": 5, "required": true, "allCaps": false, "questionType": { "id": 1, "name": "singleSelect" }, "payload": {//see payloads above//} } ] }