‘preference’ Structure

'provider_preferences' structure is an array of 'preference' structures to define resources preferred, required or forbidden for the activity to implement company-specific business logics. 'preferences' structure contains the following elements:

'preference' structure elements

Name	Type	Description
'external_id'	string	ID of the resource for whom the preference is set (is mandatory for the structure)
'type'	enum	type of preference (is mandatory for the structure): valid values: required: if any of the resources in the 'provider_preferences' node have preference/type='required', only one of these resources can be assigned the activity preferred: if no resources the 'provider_preferences' node have preference/type='required', the resources with preference/type='preferred' will have the priority when the activity is assigned forbidden: resources with preference/type='forbidden', cannot be assigned the activity

Name

Type

Description

'external_id'

string

ID of the resource for whom the preference is set

(is mandatory for the structure)

'type'

enum

type of preference (is mandatory for the structure):

valid values:

required: if any of the resources in the 'provider_preferences' node have preference/type='required', only one of these resources can be assigned the activity

preferred: if no resources the 'provider_preferences' node have preference/type='required', the resources with preference/type='preferred' will have the priority when the activity is assigned

forbidden: resources with preference/type='forbidden', cannot be assigned the activity

Note: when 'provider_preferences' structure is present, but empty, the existing preferences are deleted.

'provider_preferences' Structure Example

<provider_preferences> 
	<preference> 
		<external_id>11103</external_id> 
		<type>forbidden</type> 
	</preference> 
	<preference> 
		<external_id>11104</external_id> 
		<type>preferred</type> 
	</preference> 
</provider_preferences>