'get_quota_close_time' Request

The following table describes the 'get_quota_close_time' request parameters.

'get_quota_close_time' request parameters

Name

Required

Type

Description

user

Yes

struct

'user' structure

bucket_id

Yes

string

external ID of the capacity bucket

Note: results are only returned for capacity buckets or groups of capacity buckets

day_offset

No

unsignedByte

offset of the day the quota should be closed for

valid values: 0 – 255

If omitted, all rules are returned regardless of the days on which they should be applied

time_slot

No

string

time slot filter defining the time slots (identified by labels) for which quota close time is to be returned.

When omitted, close time for all time slots available for the specified capacity bucket is returned

category

No

string

capacity category filter defining the capacity categories (identified by labels) for which quota close time is to be returned.

When omitted, close time for all capacity categories available for the specified capacity bucket is returned

work_zone

No

string

work zone filter defining the work zones (identified by labels) for which quota close time is to be returned.

When omitted, close time for all work zones available for the specified capacity bucket is returned