'set_quota' Response

The 'set_quota' response includes one or several 'result' elements containing the following data for a single bucket:

'set_quota' response parameters

Name

Type

Description

bucket_id

string

external ID of the capacity bucket (absent if the whole transaction failed)

date

date

date for which quota was set or updated in the YYYY-MM-DD format

If not returned, the transaction is successful for the specified bucket.

time_slot

string

label of the time slot for which quota was set or updated

If not returned, the rule defines that quota should be set on the day level. In this case the record contains no 'category' and 'work_zone' fields either.

category

string

label of the capacity category for which quota was set or updated

If not returned, the rule defines that quota should be set on the time slot level.

work_zone

string

label of the work zone for which quota was set or updated

If not returned, the rule defines that quota should be set on the capacity category level.

result_code

int

result of the performed operation

'result_code' is returned in every 'result' element

For a successful transaction 'result_code' = 0 is returned.

If transaction fails, the 'result_code' > 0.

error_msg

string

text description of the error

'error_msg' is returned only if 'result_code' is other than 0