'get_quota_close_time' Response

The 'get_quota_close_time' response includes one or several 'close_schedule' elements containing the following data for a single quota cell:

'get_quota_close_time' response parameters

Name

Type

Description

bucket_id

string

external ID of the capacity bucket

day_offset

unsignedByte

offset of the day the quota should be closed for (the returned values are in the range of 0 – 255)

time_slot

string

label of the time slot to be closed

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

category

string

label of the capacity category to be closed

If not returned, the rule defines the time when quota should be closed on the time slot level. In this case the record contains no 'work_zone' field either.

work_zone

string

label of the work zone to be closed

If not returned, the rule defines the time when quota should be closed on the capacity category level.

close_time

time

time in the time zone of the capacity bucket at which quota should be closed in the HH:MM:SS format