Error Codes
Code |
Error Message Example |
Description |
|---|---|---|
0 |
no error. Request has been successfully processed |
|
1 |
Service is unavailable |
the application server is unavailable |
2 |
Internal error |
the error is returned by another module |
7 |
Authentication failed |
user authentication was unsuccessful |
9 |
Unknown category: <label> |
the system is unable to find the capacity category using the given label |
10 |
Unknown time slot: <label> |
the system is unable to find the time slot using the given label |
11 |
Undefined key field |
if 'calculate_duration'=1 and/or 'calculate_travel_time'=1, then'get_capacity' method tries to calculate activity duration and/or travel time based on 'activity_field' passed in the request The error is returned if 'get_capacity' cannot calculate duration and/or travel time. 'detail' field of the fault contains the field which must be present in the request to determine duration or travel time. Solution: consult the support team on the fields which must be passed to calculate the duration and/or travel time |
12 |
Unable to calculate work skill ID for given fields |
if 'calculate_work_skill'=1 and 'work_skill' is not present in the request, then 'get_capacity' tries to calculate the work skill based on the 'activity_field' passed in the request This error is returned if 'get_capacity' cannot calculate the work skill. Solution: consult support team on the fields which must be passed to calculate the work skill |
13 |
Invalid value of key field |
value of 'worktype_label' or other 'activity_field' parameter is invalid |
14 |
Unable to determine work zone for given fields |
'determine_location_by_work_zone' is 'true' but the work zone cannot be found from the provided activity fields, therefore, no capacity bucket can be determined |
29 |
Not permitted |
the capacity bucket is not accessible for the current user |
31 |
Invalid date: <value> |
he system is unable to convert the sent string to a date value |
32 |
Unknown resource: <external id> |
the system is unable to find the resource using the given ID |
33 |
Unknown quota field: <label> |
the system is unable to find the quota field using the given label |
34 |
Date is in past |
quota for a past date cannot be updated |
35 |
Unable to determine time zone difference |
the system is unable to determine the time zone difference for the given date |
36 |
Unknown work zone: <label> |
the system is unable to find the work zone using the given label |
37 |
Unknown capacity bucket |
the system is unable to find the capacity bucket using the given external ID |
38 |
Invalid quota percent value |
the system is unable to convert the given string to the valid quota percent value |
39 |
Quota percent is not supported |
configuration of the capacity bucket does not support direct modification of the quota percent value |
40 |
Invalid min quota value |
the system is unable to convert the given string to a valid 'min_quota' parameter value |
41 |
Min quota is not supported |
configuration of the capacity bucket does not support the 'min_quota' parameter |
42 |
Invalid quota value |
the system is unable to convert the given string to a valid quota value |
43 |
Quota is not supported |
configuration of the capacity bucket does not support direct modification of the quota value |
44 |
Invalid quota status value |
the system is unable to convert the given string to a valid 'status' parameter value |
45 |
Close quota is not supported |
configuration of the capacity bucket does not support closing of quota on the selected level |
46 |
Invalid '% to stop booking at' value |
the system is unable to convert the given string to a valid '% to stop booking at' parameter value |
47 |
'% to stop booking at' is not supported |
configuration of the capacity bucket does not support direct modification of the '% to stop booking at' parameter values |
48 |
Inconsistent data |
the request contains a combination of the 'time_slot_label', 'category_label', and 'work_zone_label' fields which is not allowed |
10009 |
'?' is not a valid DateTime value. Tag = date |
'date' parameter format is invalidthe date format should be YYYY-MM-DD '?' = actual value passed in request Note: if a valid date is passed for which the capacity is not known (e.g. 1900-01-01), then no error will be returned but the response will be empty. |
'?' is not a valid Enum value. Tag = calculate_duration |
'calculate_duration','calculate_travel_time','calculate_work_skill'are boolean and must have values {1 , 0 , true , false} Any other will cause an error. '?' = is the actual value passed in request |
|
'?' is not a valid Enum value. Tag = calculate_travel_time |
||
'?' is not a valid Enum value. Tag = calculate_work_skill |
||
10011 |
The mandatory 'location' field is not assigned. ParentTag = get_capacity |
The request contains no mandatory 'location' or 'date' parameters |
| The mandatory 'date' field is not assigned. ParentTag = get_capacity |