Skip to main content

LocationGroup Schema

Data structure for Location Group objects.

Fields​

FieldTypeRequiredDescriptionNotes
commentsstringNo--
default_extranet_groupbooleanNo-API field: default_extranet_group
deletedbooleanNo--
dynamic_location_group_criteriaDynamicLocationGroupCriteriaNo-API field: dynamic_location_group_criteria
extranet_location_groupbooleanNo-API field: extranet_location_group
group_typestringNo-API field: group_type
idintegerNo--
last_mod_timeintegerNo-API field: last_mod_time
last_mod_userEntityReferenceNo-API field: last_mod_user
locationsEntityReferenceWrapperCollectionNo--
locations_countlongNo-API field: locations_count
namestringNo--
predefinedbooleanNo--

Example​

{
"comments": "string",
"default_extranet_group": true,
"deleted": true,
"dynamic_location_group_criteria": {
"city": {
"match_string": "string",
"match_type": "string"
},
"countries": [
"value"
],
"enable_bandwidth_control": true
},
"extranet_location_group": true,
"group_type": "string",
"id": 123,
"last_mod_time": 123
}
// ... more fields