'set_quota_close_time' Request

The 'set_quota_close_time' request consists of one or several 'close_schedule' elements containing the following data for a single quota cell:

'set_quota_close_time' request parameters

Name

Required

Type

Description

user

Yes

struct

'user' structure

bucket_id

Yes

string

external ID of the capacity bucket

day_offset

No

unsignedByte

offset of the day the quota should be closed for

valid values: 0 – 255

default value: 0 (current day)

time_slot

No

string

label of the time slot to be closed

If omitted, quota is to be closed on the day level. In this case the request should not contain the 'category' and 'work_zone' fields, either.

category

No

string

label of the capacity category to be closed

If omitted, quota is to be closed on the time slot level. In this case the request should not contain the 'work_zone' field, either.

work_zone

No

string

label of the work zone to be closed

If omitted, quota is to be closed on the 'capacity category' level.

close_time

No

time

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

If omitted, the existing close time is deleted.