'get_quota_data' Request

The following table describes the 'get_quota_data’ request parameters.

get_quota_data request parameters

Name

Required

Type

Description

user

Yes

struct

'user' structure

date

Yes

date

date to be processed

resource_id

Yes

string

resource represented by external ID

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

aggregate_results

No

bool

if multiple capacity buckets are selected, this option defines whether their results are to be aggregated (value set to '1') or returned individually (value set to '0').

default value: '0'

The enabled 'aggregate_results' option restricts the list of quota parameters returned. When this option is enabled only the following parameters are returned:

  • 'quota'

  • 'max_available'

  • 'other_activities'

  • 'used'

  • 'count'

  • 'plan'

calculate_totals

No

bool

option defining whether totals are to be calculated and returned in the response (value set to '1'). The totals are calculated on the 'time_slot' and 'day' levels.

default value: '0'

Totals can be calculated for the following parameters:

  • 'quota'

  • 'max_available'

  • 'other_activities'

  • 'used'

  • 'count'

  • 'plan'

If none of the above parameters are sent in the request, the response will contain an empty <total> element.

The full total is calculated regardless of the 'time_slot' and 'category' filters.

time_slot

No

string

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

When omitted, data 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 data is to be returned.

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

day_quota_field

No

string

label of the field to be returned at the 'day' level. The following fields can be returned:

  • 'quota_percent'

  • 'min_quota'

  • 'quota'

  • 'status'

  • 'close_time'

  • 'closed_at'

  • 'max_available'

  • 'other_activities'

  • 'used'

  • 'used_quota_percent'

  • 'count'

time_slot_quota_field

No

string

label of the field to be returned at the 'time slot' level. The following fields can be returned:

  • 'quota_percent'

  • 'min_quota'

  • 'quota'

  • 'stop_booking_at'

  • 'status'

  • 'close_time'

  • 'closed_at'

  • 'max_available'

  • 'other_activities'

  • 'used'

  • 'used_quota_percent'

  • 'count'

category_quota_field

No

string

label of the field to be returned at the 'capacity category' level. The following fields can be returned:

  • 'quota_percent'

  • 'min_quota'

  • 'quota'

  • 'stop_booking_at'

  • 'weight'

  • 'estimated_quota_percent'

  • 'status'

  • 'close_time'

  • 'closed_at'

  • 'max_available'

  • 'used'

  • 'used_quota_percent'

  • 'count'

  • 'plan'

work_zone_quota_field

No

string

label of the field to be returned at the 'work zone' level. The following fields can be returned:

  • 'status'

  • 'close_time'

  • 'closed_at'

Note: Note: a 'get_quota_data' request must contain at least one of the following fields: 'day_quota_field', 'time_slot_quota_field', 'category_quota_field', 'work_zone_quota_field'. Otherwise, the following SOAP fault is returned: "Bad request format – At least one of these fields must be present: 'day_quota_field', 'time_slot_quota_field', 'category_quota_field', 'work_zone_quota_field'".