'set_quota' Request
The following table describes the 'set_quota’ request parameters.
Name |
Required |
Type |
Description |
|---|---|---|---|
user |
Yes |
struct |
'user' structure |
bucket |
No |
array |
array of 'bucket' elements defining parameters of a single bucket to be set or updated in the operation |
Name |
Required |
Type |
Description |
|---|---|---|---|
bucket_id |
Yes |
string |
external ID of the capacity bucket Note: results are only returned for capacity buckets or groups of capacity buckets |
day |
No |
array |
array of 'day' elements containing the quota data for a single day to be set or updated |
Name |
Required |
Type |
Description |
|---|---|---|---|
date |
Yes |
date |
date for which data is to be updated in the YYYY-MM-DD format valid values: current date – 2999-12-31 Note: if no time zone difference is defined for the specified date, quota will not be updated |
quota_percent |
No |
float |
quota value defined as percent valid values: 0 – 999.99 Should only be sent when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'day' and 'Quota is entered' field is set to 'as % of capacity available by calendar' at the day level |
min_quota |
No |
int |
minimum value of the quota (in minutes) valid values: 0 – 16,777,215 Should only be sent when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'day' and 'Quota is entered' field is set to 'as % of capacity available by calendar' at the day level |
quota |
No |
int |
quota value (in minutes) valid values: 0 – 16,777,215 Should only be sent when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'day'. |
status |
No |
unsignedByte |
status of the corresponding quota cell This field is a bitmask which contains the following flags: * 1 – Quota status is "closed" * 4 – Quota is auto-closed * 8 – Quota was closed on higher level * 16 – Quota is locked * 32 – Quota total is locked Individual bits can be checked using binary AND operator. For example in java/c++: status = 33; // binary '100001' if( status & 1 ) // bit 1 is set (Quota status is "closed") if( status & 32 ) // bit 32 is set Should only be sent when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'day'. |
time_slot |
No |
array |
array of 'time_slot' elements containing the quota data for a single time slot to be set or updated |
Name |
Required |
Type |
Description |
|---|---|---|---|
label |
Yes |
string |
label of the time slot |
quota_percent |
No |
float |
quota value defined as percent valid values: 0 – 999.99 Should only be sent when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'time slot' and the 'Quota is entered' field is set to 'as % of the maximum time slot capacity' or 'as % of the daily quota' at the time slot level |
min_quota |
No |
int |
minimum value of the quota (in minutes) valid values: 0 – 16,777,215 Should only be sent when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'time slot' and the 'Quota is entered' field is set to 'as % of the maximum time slot capacity' or 'as % of the daily quota' at the time slot level |
quota |
No |
int |
quota value (in minutes) valid values: 0 – 16,777,215 Should only be sent when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'time slot' |
stop_booking_at |
No |
unsignedShort |
The StopBookingAt constraint is considered for activity booking in an availability based quota bucket. The StopBookingAt value denotes the percentage of the used day quota where no more activities can be booked for the selected category. When the StopBookingAt percentage is reached, the method no longer returns the quota for the capacity category. |
status |
No |
unsignedByte |
status of the corresponding quota cell This field is a bitmask which contains the following flags: * 1 – Quota status is "closed" * 4 – Quota is auto-closed * 8 – Quota was closed on higher level * 16 – Quota is locked * 32 – Quota total is locked Individual bits can be checked using binary AND operator. For example in java/c++: status = 33; // binary '100001' if( status & 1 ) // bit 1 is set (Quota status is "closed") if( status & 32 ) // bit 32 is set Should only be sent when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'time slot' |
category |
No |
array |
array of 'category' elements containing the quota data for a single capacity category to be set or updated |
Name |
Required |
Type |
Description |
|---|---|---|---|
label |
Yes |
string |
label of the capacity category |
quota_percent |
No |
float |
quota value defined as percent valid values: 0 – 999.99 Should only be sent when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'capacity category' and the 'Quota is entered' field is set to 'as % of the maximum capacity available in this category' or 'as % of the time slot quota' at the capacity category level |
min_quota |
No |
int |
minimum value of the quota (in minutes) valid values: 0 – 16,777,215 Should only be sent when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'capacity category' and the 'Quota is entered' field is set to 'as % of the maximum capacity available in this category' or 'as % of the time slot quota' at the capacity category level |
quota |
No |
int |
quota value (in minutes) valid values: 0 – 16,777,215 Should only be sent when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'capacity category' |
stop_booking_at |
No |
unsignedShort |
The StopBookingAt constraint is considered for activity booking in an availability based quota bucket. The StopBookingAt value denotes the percentage of the used day quota where no more activities can be booked for the selected category. When the StopBookingAt percentage is reached, the method no longer returns the quota for the capacity category. |
status |
No |
unsignedByte |
status of the corresponding quota cell This field is a bitmask which contains the following flags: * 1 – Quota status is "closed" * 4 – Quota is auto-closed * 8 – Quota was closed on higher level * 16 – Quota is locked * 32 – Quota total is locked Individual bits can be checked using binary AND operator. For example in java/c++: status = 33; // binary '100001' if( status & 1 ) // bit 1 is set (Quota status is "closed") if( status & 32 ) // bit 32 is set Should only be sent when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'capacity category' |
work_zone |
No |
array |
array of 'work_zone' elements each containing the quota data for a single work zone to be set or updated |
Name |
Required |
Type |
Description |
|---|---|---|---|
label |
Yes |
string |
label of the work zone |
status |
No |
unsignedByte |
status of the corresponding quota cell This field is a bitmask which contains the following flags: * 1 – Quota status is "closed" * 2 – Quota status is "open" * 4 – Quota is auto-closed * 8 – Quota was closed on higher level * 16 – Quota is locked * 32 – Quota total is locked Individual bits can be checked using binary AND operator. For example in java/c++: status = 33; // binary '100001' if( status & 1 ) // bit 1 is set (Quota status is "closed") if( status & 32 ) // bit 32 is set Should only be sent when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'work zone' |