'activity_field' Node

Subject to the specific flags set 'true' in the request, the 'activity_field' node can contain:

All properties used to define the activity duration as defined in the Manage Application → Company Settings → Statistics Parameters → Activity duration stats fields.

All properties used to define the travel time as defined in the Manage Application→ Company Settings → Statistics Parameters → Activity travel stats fields.

All properties used to define the capacity category, i.e. values of all properties used to define work skills for the specific capacity category and used in the Manage Application → Company Settings → Work Skill Conditions.

Along with that, if the Quota is closed at the Work Zone level for the specified time slot and capacity category, or if no time slot and capacity category are specified and the Quota is closed at the Work Zone level anywhere for the date, all properties used to define the work zone (defined in Manage Application → Company Settings → Work Zone Dictionary → Work zone key) must be specified.

The work zone key fields are not mandatory if the 'Quota can be closed for' option is disabled at the work zone level in Manage Application → Settings → Technician/Bucket info → Quota management.

However, if the 'determine_location_by_work_zone' option is enabled, the work zone key fields also become mandatory.

Activity type: if activity type is selected as the key field for defining activity duration and travel time, it is mandatory to define the activity type in the request. The activity type is defined by either the 'aworktype' field or 'worktype_label' field.

Note: the 'aworktype' field accepts activity type Ids while the 'worktype_label' field accepts only activity type labels. At the same time, an invalid 'aworktype' value sent in the request is ignored (for backward compatibility purposes) and the request is still processed without error responses, while an invalid label sent in 'worktype_label' leads to an error response. A request containing an invalid 'worktype_label' value will not be processed.

The following table describes the 'activity_field' node mandatory parameters.

'activity_field' node mandatory parameters

Name	Type	Description
name	string	label of the field or property that should contain a user-defined value. The value can be found in Manage Application → Company Settings → Properties
value	string	value that should be contained in the defined field. For enum properties – the value type is integer (can be found in Manage Application → Company Settings → Properties/Modify)

Note: If any property is added to a key or condition and is not present in the request, the error will be returned (even if the request was processed correctly before).