The schema of the request body parameters.
Root Schema : quotaPatchList
Type: object
The collection of quota values.
Show Source
{
"description":"The collection of quota values.",
"properties":{
"items":{
"type":"array",
"items":{
"$ref":"#/definitions/quotaPatchRequest"
}
}
}
}
Nested Schema : items
Type: array
Show Source
{
"type":"array",
"items":{
"$ref":"#/definitions/quotaPatchRequest"
}
}
Nested Schema : quotaPatchRequest
Type: object
Show Source
{
"type":"object",
"properties":{
"date":{
"description":"The date the quota is created or updated. Specify the date in YYYY-MM-DD format.",
"type":"string",
"format":"date",
"example":"2016-07-22"
},
"areas":{
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity area.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quotaPercent":{
"description":"The quota value in percentage. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quota":{
"description":"The quota value in minutes. Valid values are 0..16777215. If request has a value out of this range then zero value is assumed.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"categories":{
"description":"The capacity categories assigned to the capacity area.",
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity category.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quotaPercentCategory":{
"description":"The quota value defined as a percent of the Max Available value of the capacity category.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"quotaPercentDay":{
"description":"The quota value defined as a percent of the daily quota value of the capacity category. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"stopBookingAt":{
"description":"The percent at which the booking of activities stops for the timeslot-based quota.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"intervals":{
"description":"An array of quota values for the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
}
}
}
}
}
}
}
}
Nested Schema : areas
Type: array
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity area.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quotaPercent":{
"description":"The quota value in percentage. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quota":{
"description":"The quota value in minutes. Valid values are 0..16777215. If request has a value out of this range then zero value is assumed.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"categories":{
"description":"The capacity categories assigned to the capacity area.",
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity category.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quotaPercentCategory":{
"description":"The quota value defined as a percent of the Max Available value of the capacity category.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"quotaPercentDay":{
"description":"The quota value defined as a percent of the daily quota value of the capacity category. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"stopBookingAt":{
"description":"The percent at which the booking of activities stops for the timeslot-based quota.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"intervals":{
"description":"An array of quota values for the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
}
}
}
}
}
}
Nested Schema : items
Type: object
Show Source
-
categories:
array categories
The capacity categories assigned to the capacity area.
-
label:
string
Minimum Length: 1
Maximum Length: 40
The label of the capacity area.
-
minQuota:
integer
The minimum quota value in minutes.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
quota:
integer
The quota value in minutes. Valid values are 0..16777215. If request has a value out of this range then zero value is assumed.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
quotaPercent:
number(float)
The quota value in percentage.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity area.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quotaPercent":{
"description":"The quota value in percentage. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quota":{
"description":"The quota value in minutes. Valid values are 0..16777215. If request has a value out of this range then zero value is assumed.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"categories":{
"description":"The capacity categories assigned to the capacity area.",
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity category.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quotaPercentCategory":{
"description":"The quota value defined as a percent of the Max Available value of the capacity category.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"quotaPercentDay":{
"description":"The quota value defined as a percent of the daily quota value of the capacity category. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"stopBookingAt":{
"description":"The percent at which the booking of activities stops for the timeslot-based quota.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"intervals":{
"description":"An array of quota values for the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
}
}
}
}
}
Nested Schema : categories
Type: array
The capacity categories assigned to the capacity area.
Show Source
{
"description":"The capacity categories assigned to the capacity area.",
"type":"array",
"items":{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity category.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quotaPercentCategory":{
"description":"The quota value defined as a percent of the Max Available value of the capacity category.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"quotaPercentDay":{
"description":"The quota value defined as a percent of the daily quota value of the capacity category. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"stopBookingAt":{
"description":"The percent at which the booking of activities stops for the timeslot-based quota.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"intervals":{
"description":"An array of quota values for the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
}
}
}
Nested Schema : items
Type: object
Show Source
-
intervals:
array intervals
An array of quota values for the booking intervals.
-
label:
string
Minimum Length: 1
Maximum Length: 40
The label of the capacity category.
-
minQuota:
integer
The minimum quota value in minutes.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
quota:
integer
The quota value in minutes.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
quotaPercentCategory:
number(float)
The quota value defined as a percent of the Max Available value of the capacity category.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
quotaPercentDay:
number(float)
The quota value defined as a percent of the daily quota value of the capacity category.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
stopBookingAt:
integer
The percent at which the booking of activities stops for the timeslot-based quota.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
{
"type":"object",
"properties":{
"label":{
"description":"The label of the capacity category.",
"type":"string",
"minLength":"1",
"maxLength":"40"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"quotaPercentCategory":{
"description":"The quota value defined as a percent of the Max Available value of the capacity category.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"quotaPercentDay":{
"description":"The quota value defined as a percent of the daily quota value of the capacity category. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"number",
"format":"float"
},
"minQuota":{
"description":"The minimum quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"stopBookingAt":{
"description":"The percent at which the booking of activities stops for the timeslot-based quota.<ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"intervals":{
"description":"An array of quota values for the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
}
}
Nested Schema : intervals
Type: array
An array of quota values for the booking intervals.
Show Source
{
"description":"An array of quota values for the booking intervals.",
"type":"array",
"items":{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}
}
Nested Schema : items
Type: object
Show Source
-
quota:
integer
The quota value in minutes.
- If the value of the parameter is zero, then zero is returned in the response.
- If no value is specified for the parameter, then the quota parameter is not returned.
-
status:
integer
The status of the quota value.
It has the following modes:
- Regular: Populates quota values from the past days.
- Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.
-
timeFrom:
string
The start time of the time interval in HH:MM format.
Example: 12:30
-
timeTo:
string
The end time of the time interval in HH:MM format.
Example: 14:00
-
used:
integer
The amount of existing capacity consumed in minutes.
{
"type":"object",
"properties":{
"timeFrom":{
"description":"The start time of the time interval in HH:MM format.",
"type":"string",
"example":"12:30"
},
"timeTo":{
"description":"The end time of the time interval in HH:MM format.",
"type":"string",
"example":"14:00"
},
"quota":{
"description":"The quota value in minutes. <ul><li>If the value of the parameter is zero, then zero is returned in the response.</li><li>If no value is specified for the parameter, then the quota parameter is not returned.</li></ul>",
"type":"integer"
},
"used":{
"description":"The amount of existing capacity consumed in minutes.",
"type":"integer"
},
"status":{
"description":"The status of the quota value. <p>It has the following modes:<ul><li>Regular: Populates quota values from the past days.</li><li>Aggregate: Aggregates the quota values for an interval, if the quota values are read-only values.</li></p>",
"type":"integer"
}
}
}