Get quota limits
Get quota limits of a given project.
| Request | |
|---|---|
| Method | GET |
| Resource | https://[customer].asp.virtual-call-center.eu/v2/projects/[projectid]/quotas |
| Options | N/A |
| Body | N/A |
| Response | |
| Body | Detailed information about the given project’s quota limits, encoded in JSON |
Request
Resource parameters
| Name | Type | Mandatory | Comment |
|---|---|---|---|
| customer | string | yes | Your call centre’s unique identifier (subdomain). |
| projectid | integer | yes | Unique project identifier. |
Response
Response object
| Name | Type | Comment |
|---|---|---|
| cell | array of objects | Array of cell quotas. |
| edge | array of objects | Array of edge quotas. |
Cell type quota object
| Name | Type | Comment |
|---|---|---|
| children | array of objects | Recursive. Array of Cell type quota object. |
| container | boolean | Specifies whether the given element contains further elements (more quota values). Possible values: – true – false |
| label | object | Cell label object. |
| quotaid | integer | Unique identifier of the quota field. Optional. It only appears on the deepest level. |
| valueid | integer | Identifier of the quota field’s value in VCC’s database. |
Cell label object
| Name | Type | Comment |
|---|---|---|
| act_value | integer | The actual quota value. Optional. It only appears on the deepest level. |
| all | object | Always null. Deprecated. |
| diff_value | integer | The difference between the value and the actual value. Optional. It only appears on the deepest level. |
| export_value | string | The export name of the quota field’s value. |
| value | integer | The quota value set by the supervisor. Optional. It only appears on the deepest level. |
| value_name | string | The name of the quota field’s value. |
Edge type quota object
| Name | Type | Comment |
|---|---|---|
| children | array of objects | Array of child objects. |
| container | boolean | Specifies whether the given element contains further elements (more quota values). Possible values: – true – false |
| fieldid | integer | Identifier of the quota field. |
| label | string | The name of the quota fields’s value. |
| projectid | integer | Unique project identifier. |
Edge child object
| Name | Type | Comment |
|---|---|---|
| children | object | Always null. Deprecated. |
| container | boolean | Always false. Deprecated. |
| label | object | Edge label object. |
| quotaid | integer | Identifier of the specific qouta in VCC’s database. |
| valueid | integer | Identifier of the quota field’s value in VCC’s database. |
Edge label object
| Name | Type | Comment |
|---|---|---|
| act_value | integer | The actual quota value. |
| diff_value | integer | The difference between the value and the actual value. |
| name | string | The name of the quota fields’s value. |
| value | integer | The quota value set by the supervisor. |
Example
Request
URL: https://mycc.asp.virtual-call-center.eu/v2/projects/134/quotas
Response body
{
"response": {
"cell": [
{
"valueid": 7,
"label": {
"value_name": "male",
"export_value": ""
},
"container": true,
"children": [
{
"valueid": 6,
"label": {
"value_name": "elementary",
"export_value": "",
"value": 150,
"act_value": 0,
"diff_value": 150,
"all": null
},
"container": false,
"children": null,
"quotaid": 3
},
{
"valueid": 10,
"label": {
"value_name": "high",
"export_value": "",
"value": 150,
"act_value": 0,
"diff_value": 150,
"all": null
},
"container": false,
"children": null,
"quotaid": 4
},
{
"valueid": 11,
"label": {
"value_name": "college",
"export_value": "",
"value": 200,
"act_value": 0,
"diff_value": 200,
"all": null
},
"container": false,
"children": null,
"quotaid": 5
},
{
"valueid": 12,
"label": {
"value_name": "university",
"export_value": "",
"value": 200,
"act_value": 0,
"diff_value": 200,
"all": null
},
"container": false,
"children": null,
"quotaid": 6
},
{
"valueid": 13,
"label": {
"value_name": "na",
"export_value": "",
"value": 0,
"act_value": 0,
"diff_value": 0,
"all": null
},
"container": false,
"children": null,
"quotaid": 7
}
]
},
{
"valueid": 9,
"label": {
"value_name": "female",
"export_value": ""
},
"container": true,
"children": [
{
"valueid": 6,
"label": {
"value_name": "elementary",
"export_value": "",
"value": 150,
"act_value": 0,
"diff_value": 150,
"all": null
},
"container": false,
"children": null,
"quotaid": 8
},
{
"valueid": 10,
"label": {
"value_name": "high",
"export_value": "",
"value": 150,
"act_value": 0,
"diff_value": 150,
"all": null
},
"container": false,
"children": null,
"quotaid": 9
},
{
"valueid": 11,
"label": {
"value_name": "college",
"export_value": "",
"value": 200,
"act_value": 0,
"diff_value": 200,
"all": null
},
"container": false,
"children": null,
"quotaid": 10
},
{
"valueid": 12,
"label": {
"value_name": "university",
"export_value": "",
"value": 200,
"act_value": 0,
"diff_value": 200,
"all": null
},
"container": false,
"children": null,
"quotaid": 11
},
{
"valueid": 13,
"label": {
"value_name": "na",
"export_value": "",
"value": 0,
"act_value": 0,
"diff_value": 0,
"all": null
},
"container": false,
"children": null,
"quotaid": 12
}
]
}
],
"edge": [
{
"projectid": 45,
"fieldid": 6,
"container": true,
"label": {
"name": "q_country"
},
"children": [
{
"quotaid": 1,
"valueid": 5,
"label": {
"name": "Hungary",
"value": 1000,
"act_value": 0,
"diff_value": 1000
},
"container": false,
"children": null
},
{
"quotaid": 2,
"valueid": 8,
"label": {
"name": "Germany",
"value": 2000,
"act_value": 0,
"diff_value": 2000
},
"container": false,
"children": null
}
]
}
]
},
"errors": []
}
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.