Jump to

• Request
• Response

Create or update quota

patch

/rest/ofscCapacity/v2/quota

The function allows to modify the quota information for set of days on different quota levels - Capacity Areas, Capacity Categories, Time slots or Intervals. The quota values can be retreived from various levels accordingly to the quota type configuration of each particular Capacity Area.

Request

Body ()

The schema of the request body parameters.

Root Schema : v2-patch-quota

Type: object

Array of objects with quota information for each date that should be updated

Show Source

• items: array items

{
    "description":"Array of objects with quota information for each date that should be updated",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/v2-patch-quota-request"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object v2-patch-quota-request

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/v2-patch-quota-request"
    }
}

Nested Schema : v2-patch-quota-request

Type: object

Show Source

• areas: array areas
  Array of objects with quota information for each capacity area that should be updated
• date: string(date)
  The date in 'YYYY-MM-DD' format.

  Example: 2023-12-01

{
    "type":"object",
    "properties":{
        "date":{
            "description":"The date in 'YYYY-MM-DD' format.",
            "type":"string",
            "format":"date",
            "example":"2023-12-01"
        },
        "areas":{
            "description":"Array of objects with quota information for each capacity area that should be updated",
            "type":"array",
            "items":{
                "$ref":"#/definitions/v2-patch-quota-area"
            }
        }
    }
}

Nested Schema : areas

Type: array

Array of objects with quota information for each capacity area that should be updated

Show Source

• Array of: object v2-patch-quota-area

{
    "description":"Array of objects with quota information for each capacity area that should be updated",
    "type":"array",
    "items":{
        "$ref":"#/definitions/v2-patch-quota-area"
    }
}

Nested Schema : v2-patch-quota-area

Type: object

Show Source

• categories: array categories
• intervals: array intervals
• label: string
  The label of the Capacity Area that should be updated.

  Example: capacity_area
• minQuota: integer
  The minimal quota value in minutes.

  Example: 200
• quota: integer
  Quota value in minutes. This parameter is ignored if the area is not configured to enter quota in minutes. For the quota based on booking intervals null can be used to unset the value.

  Example: 800
• quotaIsClosed: boolean
  Allows to open or close booking status at this level.

  Example: false
• quotaPercent: number
  The quota value in percent. This parameter is ignored If the area is not configured to enter quota in percent. For the quota based on intervals null can be used to unset the value.

  Example: 60
• timeSlots: array timeSlots

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the Capacity Area that should be updated.",
            "type":"string",
            "example":"capacity_area"
        },
        "quota":{
            "description":"Quota value in minutes. This parameter is ignored if the area is not configured to enter quota in minutes. For the quota based on booking intervals <b>null</b> can be used to unset the value.",
            "type":"integer",
            "example":"800"
        },
        "quotaPercent":{
            "description":"The quota value in percent. This parameter is ignored If the area is not configured to enter quota in percent. For the quota based on intervals <b>null</b> can be used to unset the value.",
            "type":"number",
            "example":"60"
        },
        "minQuota":{
            "description":"The minimal quota value in minutes.",
            "type":"integer",
            "example":"200"
        },
        "quotaIsClosed":{
            "description":"Allows to open or close booking status at this level.",
            "type":"boolean",
            "example":false
        },
        "intervals":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/v2-patch-quota-intervals"
            }
        },
        "categories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/v2-patch-quota-categories"
            }
        },
        "timeSlots":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/v2-patch-quota-time-slots"
            }
        }
    }
}

Nested Schema : categories

Type: array

Show Source

• Array of: object v2-patch-quota-categories
  Array of objects with quota information for each capacity category that should be updated. This list only accepted for Capacity Areas with quota by intervals configuration.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/v2-patch-quota-categories"
    }
}

Nested Schema : intervals

Type: array

Show Source

• Array of: object v2-patch-quota-intervals
  Array of objects containing the daily statuses of intervals. At this level an interval may be closed for all Capacity Categories of the area. Quota cannot be specified at this level.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/v2-patch-quota-intervals"
    }
}

Nested Schema : timeSlots

Type: array

Show Source

• Array of: object v2-patch-quota-time-slots
  Array of objects containing the quota information for each time slot.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/v2-patch-quota-time-slots"
    }
}

Nested Schema : v2-patch-quota-categories

Type: object

Array of objects with quota information for each capacity category that should be updated. This list only accepted for Capacity Areas with quota by intervals configuration.

Show Source

• intervals: array intervals
• label: string
  The label of the Capacity Category.

  Example: DEINSTALL
• minQuota: integer
  The minimal quota value in minutes.

  Example: 120
• quota: integer
  The quota value in minutes. This parameter is ignored if the area is not configured to enter quota in minutes at this level. null can be used to unset the value.

  Example: 240
• quotaIsClosed: boolean
  Allows to open or close booking status at this level.

  Example: false
• quotaPercent: number
  The quota value as a percent of the daily quota value of the capacity category. This parameter is ignored if the area is not configured to enter quota as percent of quota defined on parent level.

  Example: 15
• quotaPercentCategory: number
  The quota value defined as a percent of the Max Available value of the Capacity Category. This parameter is ignored if the area is not configured to enter quota as percent of maximum capacity available in the category.

  Example: 30
• quotaPercentDay: number
  The quota value as a percent of the daily quota value of the capacity category. This parameter is ignored if the area is not configured to enter quota as percent of quota defined on parent level.

  Example: 15
• stopBookingAt: integer
  The percent of the used quota at which the booking of activities stops.

  Example: 90
• workZones: array workZones

{
    "description":"Array of objects with quota information for each capacity category that should be updated. This list only accepted for Capacity Areas with quota by intervals configuration.",
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the Capacity Category.",
            "type":"string",
            "example":"DEINSTALL"
        },
        "quota":{
            "description":"The quota value in minutes. This parameter is ignored if the area is not configured to enter quota in minutes at this level. <b>null</b> can be used to unset the value.",
            "type":"integer",
            "example":"240"
        },
        "quotaPercent":{
            "description":"The quota value as a percent of the daily quota value of the capacity category. This parameter is ignored if the area is not configured to enter quota as percent of quota defined on parent level.",
            "type":"number",
            "example":"15"
        },
        "quotaPercentDay":{
            "description":"The quota value as a percent of the daily quota value of the capacity category. This parameter is ignored if the area is not configured to enter quota as percent of quota defined on parent level.",
            "type":"number",
            "example":"15"
        },
        "quotaPercentCategory":{
            "description":"The quota value defined as a percent of the Max Available value of the Capacity Category. This parameter is ignored if the area is not configured to enter quota as percent of maximum capacity available in the category.",
            "type":"number",
            "example":"30"
        },
        "minQuota":{
            "description":"The minimal quota value in minutes.",
            "type":"integer",
            "example":"120"
        },
        "stopBookingAt":{
            "description":"The percent of the used quota at which the booking of activities stops.",
            "type":"integer",
            "example":"90"
        },
        "quotaIsClosed":{
            "description":"Allows to open or close booking status at this level.",
            "type":"boolean",
            "example":false
        },
        "workZones":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/v2-patch-quota-work-zones"
            }
        },
        "intervals":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/v2-patch-quota-category-intervals"
            }
        }
    }
}

Nested Schema : intervals

Type: array

Show Source

• Array of: object v2-patch-quota-category-intervals
  Array of objects containing the quota information for intervals within the Capacity Category

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/v2-patch-quota-category-intervals"
    }
}

Nested Schema : workZones

Type: array

Show Source

• Array of: object v2-patch-quota-work-zones

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/v2-patch-quota-work-zones"
    }
}

Nested Schema : v2-patch-quota-category-intervals

Type: object

Array of objects containing the quota information for intervals within the Capacity Category

Show Source

• quota: integer
  The quota value in minutes. This parameter is ignored if the area is not configured to enter quota in minutes at this level. null can be used to unset the value.

  Example: 180
• quotaIsClosed: boolean
  Allows to open or close booking status at this level.

  Example: false
• timeFrom: string
  The start time of the time interval in HH:MM format.

  Example: 08:00
• timeTo: string
  The end time of the time interval in HH:MM format.

  Example: 12:00
• workZones: array workZones

{
    "description":"Array of objects containing the quota information for intervals within the Capacity Category",
    "type":"object",
    "properties":{
        "timeFrom":{
            "description":"The start time of the time interval in HH:MM format.",
            "type":"string",
            "example":"08:00"
        },
        "timeTo":{
            "description":"The end time of the time interval in HH:MM format.",
            "type":"string",
            "example":"12:00"
        },
        "quota":{
            "description":"The quota value in minutes. This parameter is ignored if the area is not configured to enter quota in minutes at this level. <b>null</b> can be used to unset the value.",
            "type":"integer",
            "example":"180"
        },
        "quotaIsClosed":{
            "description":"Allows to open or close booking status at this level.",
            "type":"boolean",
            "example":false
        },
        "workZones":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/v2-patch-quota-work-zones"
            }
        }
    }
}

Nested Schema : workZones

Type: array

Show Source

• Array of: object v2-patch-quota-work-zones

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/v2-patch-quota-work-zones"
    }
}

Nested Schema : v2-patch-quota-work-zones

Type: object

Show Source

• label: string
  Example: WZ1
• quotaIsClosed: boolean
  Example: false

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "example":"WZ1"
        },
        "quotaIsClosed":{
            "type":"boolean",
            "example":false
        }
    }
}

Nested Schema : v2-patch-quota-intervals

Type: object

Array of objects containing the daily statuses of intervals. At this level an interval may be closed for all Capacity Categories of the area. Quota cannot be specified at this level.

Show Source

• quotaIsClosed: boolean
  Allows to open or close booking status at this level.

  Example: false
• timeFrom: string
  The start time of the time interval in HH:MM format.

  Example: 08:00
• timeTo: string
  The end time of the time interval in HH:MM format.

  Example: 12:00

{
    "description":"Array of objects containing the daily statuses of intervals. At this level an interval may be closed for all Capacity Categories of the area. Quota cannot be specified at this level.",
    "type":"object",
    "properties":{
        "timeFrom":{
            "description":"The start time of the time interval in HH:MM format.",
            "type":"string",
            "example":"08:00"
        },
        "timeTo":{
            "description":"The end time of the time interval in HH:MM format.",
            "type":"string",
            "example":"12:00"
        },
        "quotaIsClosed":{
            "description":"Allows to open or close booking status at this level.",
            "type":"boolean",
            "example":false
        }
    }
}

Nested Schema : v2-patch-quota-time-slots

Type: object

Array of objects containing the quota information for each time slot.

Show Source

• categories: array categories
• label: string
  Label of the time slot

  Example: 8AM-11AM
• minQuota: integer
  The minimal quota value in minutes.

  Example: 200
• quota: integer
  The quota value in minutes. This parameter is ignored if the area is not configured to enter quota in minutes at this level.

  Example: 540
• quotaIsClosed: boolean
  Allows to open or close booking status at this level.

  Example: false
• quotaPercent: number
  The quota value as a percent of the day level or as a percent of max available for time slot depending on the configuration. This parameter is ignored if the area is not configured to enter quota as percent.

  Example: 30
• stopBookingAt: integer
  The percent of the used quota at which the booking of activities stops.

  Example: 60

{
    "description":"Array of objects containing the quota information for each time slot.",
    "type":"object",
    "properties":{
        "label":{
            "description":"Label of the time slot",
            "type":"string",
            "example":"8AM-11AM"
        },
        "quota":{
            "description":"The quota value in minutes. This parameter is ignored if the area is not configured to enter quota in minutes at this level.",
            "type":"integer",
            "example":"540"
        },
        "quotaPercent":{
            "description":"The quota value as a percent of the day level or as a percent of max available for time slot depending on the configuration. This parameter is ignored if the area is not configured to enter quota as percent.",
            "type":"number",
            "example":"30"
        },
        "minQuota":{
            "description":"The minimal quota value in minutes.",
            "type":"integer",
            "example":"200"
        },
        "stopBookingAt":{
            "description":"The percent of the used quota at which the booking of activities stops.",
            "type":"integer",
            "example":"60"
        },
        "quotaIsClosed":{
            "description":"Allows to open or close booking status at this level.",
            "type":"boolean",
            "example":false
        },
        "categories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/v2-patch-quota-time-slot-categories"
            }
        }
    }
}

Nested Schema : categories

Type: array

Show Source

• Array of: object v2-patch-quota-time-slot-categories
  Array of objects containing the quota information for each Capacity Category.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/v2-patch-quota-time-slot-categories"
    }
}

Nested Schema : v2-patch-quota-time-slot-categories

Type: object

Array of objects containing the quota information for each Capacity Category.

Show Source

• label: string
  The label of the Capacity Category.

  Example: DEINSTALL
• minQuota: integer
  The minimal quota value in minutes.

  Example: 60
• quota: integer
  The quota value in minutes. This parameter is ignored If the area is not configured to enter quota in minutes at this level.

  Example: 360
• quotaIsClosed: boolean
  Allows to open or close booking status at this level.

  Example: false
• quotaPercent: integer
  The quota value as a percent of the day level or as a percent of max available for time slot depending on the configuration . This parameter is ignored If the area is not configured to enter quota as percent .

  Example: 30
• stopBookingAt: integer
  The percent of the used quota at whitch the booking of activities stops.

  Example: 80
• workZones: array workZones

{
    "description":"Array of objects containing the quota information for each Capacity Category.",
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the Capacity Category.",
            "type":"string",
            "example":"DEINSTALL"
        },
        "quota":{
            "description":"The quota value in minutes. This parameter is ignored If the area is not configured to enter quota in minutes at this level.",
            "type":"integer",
            "example":"360"
        },
        "quotaPercent":{
            "description":"The quota value as a percent of the day level or as a percent of max available for time slot depending on the configuration . This parameter is ignored If the area is not configured to enter quota as percent .",
            "type":"integer",
            "example":"30"
        },
        "minQuota":{
            "description":"The minimal quota value in minutes.",
            "type":"integer",
            "example":"60"
        },
        "stopBookingAt":{
            "description":"The percent of the used quota at whitch the booking of activities stops.",
            "type":"integer",
            "example":"80"
        },
        "quotaIsClosed":{
            "description":"Allows to open or close booking status at this level.",
            "type":"boolean",
            "example":false
        },
        "workZones":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/v2-patch-quota-work-zones"
            }
        }
    }
}

Nested Schema : workZones

Type: array

Show Source

• Array of: object v2-patch-quota-work-zones

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/v2-patch-quota-work-zones"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/schema+json

200 Response

This section describes the success response for this operation.

Body ()

Root Schema : v2-patch-quota-result

Type: object

Show Source

• errors: array errors
  List of error messages related to current request
• errorsCount: integer
  Example: 0

{
    "type":"object",
    "properties":{
        "errorsCount":{
            "type":"integer",
            "example":"0"
        },
        "errors":{
            "description":"List of error messages related to current request",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

List of error messages related to current request

Show Source

• Array of: string

{
    "description":"List of error messages related to current request",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top