Returned fields for the SurveyQuotas sub-object are explained below. Go to the Example Returns section to view return examples for each call type.
Returned Fields for the SurveyQuotas Object
| Field | Description | Format |
|---|---|---|
| id | Quota ID | number |
| name | Quota Name | string |
| description | Quota Description | string |
| responses | Number of responses within quota | number |
| limit | Quota limit | number |
| distributed | Indicates whether quota is distributed logic type | boolean |
| groups | Array of all quota conditions | array |
| Groups Fields | Description | Format |
| id | Quota Group ID | string |
| rules | Array of separate quota rules | array |
| Rules Fields | Description | Format |
| id | Quota Rule ID | string |
| input_value | Survey question, System Data, etc. | number/string |
| operator | Logic condition i.e. "is exactly equal to" | number |
| answers_type | Indicates whether the answer is open-text/input | number |
| answers_values | Values on which quota conditions are based i.e. an answer to a specific question | number/string |
| rule_percentage (distributed=true) | Percentage distribution among quota rules within a single group (must equal 100 among rules in one group) | number |
| next_operator (distributed=false) | The operator joining separate groups within a quota or separate rules within a group (must be either "or" or "and") | string |
Example Returns (.json format)
- GetList Return Example
- Get SurveyQuotas Return Example
- Create SurveyQuotas Return Example
- Update SurveyQuotas Return Example
- Delete SurveyQuotas Return Example
GetList Return Example (.json format):
{
"result_ok": true,
"quotas": [
{
"id": "123",
"name": "Female Quota",
"description": "",
"responses": "0",
"limit": "100",
"distributed": "false"
},
{
"id": "321",
"name": "Male Quota",
"description": "",
"responses": "0",
"limit": "100",
"distributed": "false"
}
]
}Get SurveyQuotas Return Example (.json format):
{
"result_ok": true,
"id": "123",
"name": "Female Quota",
"description": "",
"limit": "100",
"responses": "0",
"distributed": "false",
"groups": [
{
"id": "123abc456",
"rules": [
{
"id": "654cba321",
"input_value": "5",
"operator": "12",
"answers_type": "17",
"answers_values": [
"5-10002"
]
}
]
}
]
}Create SurveyQuotas Return Example (.json format):
{
"result_ok": true,
"id": "123",
"name": "Demo Quota",
"description": "",
"limit": "100",
"responses": "0",
"distributed": "false",
"groups": [
{
"id": "123abc456",
"rules": [
{
"id": "654cba321",
"input_value": "5",
"operator": "12",
"answers_type": "17",
"answers_values": [
"5-10002"
]
}
]
}
]
}Update SurveyQuotas Return Example (.json format):
{
"result_ok": true,
"id": "123",
"name": "Demo Quota 2",
"description": "",
"limit": "111",
"responses": "0",
"distributed": "false",
"groups": [
{
"id": "123abc456",
"rules": [
{
"id": "654cba321",
"input_value": "5",
"operator": "12",
"answers_type": "17",
"answers_values": [
"5-10002"
]
}
]
}
]
}Delete SurveyQuotas Return Example (.json format):
{
"0": true,
"result_ok": true
}