A valid request URL is required to generate request examples{
"locators": [
{
"discriminator": "LOC",
"sysidParentNode": 12345,
"sysidLocatorNode": 12345,
"locationMapImages": [
{
"name": "...",
"sysidLocationMapImage": 12345,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "...",
"description": "...",
"defaultImage": true,
"height": 12345,
"width": 12345
},
{
"name": "...",
"sysidLocationMapImage": 12345,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "...",
"description": "...",
"defaultImage": true,
"height": 12345,
"width": 12345
}
],
"displayOrder": 12345,
"locationImages": [
{
"width": 12345,
"name": "...",
"description": "...",
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"defaultImage": true,
"sysidLocationImage": 12345,
"thumbnailSource": "..."
},
{
"width": 12345,
"name": "...",
"description": "...",
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"defaultImage": true,
"sysidLocationImage": 12345,
"thumbnailSource": "..."
}
],
"name": "...",
"children": [
{},
{}
],
"locationLevel": 12345
},
{
"discriminator": "LOC",
"sysidParentNode": 12345,
"sysidLocatorNode": 12345,
"locationMapImages": [
{
"name": "...",
"sysidLocationMapImage": 12345,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "...",
"description": "...",
"defaultImage": true,
"height": 12345,
"width": 12345
},
{
"name": "...",
"sysidLocationMapImage": 12345,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "...",
"description": "...",
"defaultImage": true,
"height": 12345,
"width": 12345
}
],
"displayOrder": 12345,
"locationImages": [
{
"width": 12345,
"name": "...",
"description": "...",
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"defaultImage": true,
"sysidLocationImage": 12345,
"thumbnailSource": "..."
},
{
"width": 12345,
"name": "...",
"description": "...",
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"defaultImage": true,
"sysidLocationImage": 12345,
"thumbnailSource": "..."
}
],
"name": "...",
"children": [
{},
{}
],
"locationLevel": 12345
}
]
}Put locationslocators and structures
Updates the Locator Nodes and Locator Structures identified in the provided arrays. In cases where new Locator Nodes or Locator Structures are inserted in their respective hierarchies (i.e. new values are included in the children array field of a Locator Node or Locator Structure being updated), new Locator Nodes or Locator Structures will be created in the System. Likewise, in cases where Locator Nodes or Locator Structures have been removed from their respective hierarchies, those missing Nodes and Structures will be marked as deleted in the System.
Locator Nodes are used to define and describe location information in a tree hierarchy. Parent locator nodes represent ‘areas’ which ‘contain’ the locations represented by child locator nodes.
Locations and Location Structures are updated as sets of data. When a Location set is updated, any locations that are removed from the original set created will be deleted from the System. Any Locator Nodes added to the set as part of the Update operation will be added to the System. Likewise, Locator Structures are added and removed as they are present in the update set.
Note: If a Locator Node has a Venue Node within its tree, that Locator Node cannot be deleted from the set. Locator Structures which are associated with existing Locator Nodes also cannot be deleted.
The requesting User must have the following rights to perform this task:
This operation requires an Update Locations Request argument. The request has the following attributes:
This operation returns a Locator Node Wrapper with the following attributes:
A valid request URL is required to generate request examples{
"locators": [
{
"discriminator": "LOC",
"sysidParentNode": 12345,
"sysidLocatorNode": 12345,
"locationMapImages": [
{
"name": "...",
"sysidLocationMapImage": 12345,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "...",
"description": "...",
"defaultImage": true,
"height": 12345,
"width": 12345
},
{
"name": "...",
"sysidLocationMapImage": 12345,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "...",
"description": "...",
"defaultImage": true,
"height": 12345,
"width": 12345
}
],
"displayOrder": 12345,
"locationImages": [
{
"width": 12345,
"name": "...",
"description": "...",
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"defaultImage": true,
"sysidLocationImage": 12345,
"thumbnailSource": "..."
},
{
"width": 12345,
"name": "...",
"description": "...",
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"defaultImage": true,
"sysidLocationImage": 12345,
"thumbnailSource": "..."
}
],
"name": "...",
"children": [
{},
{}
],
"locationLevel": 12345
},
{
"discriminator": "LOC",
"sysidParentNode": 12345,
"sysidLocatorNode": 12345,
"locationMapImages": [
{
"name": "...",
"sysidLocationMapImage": 12345,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "...",
"description": "...",
"defaultImage": true,
"height": 12345,
"width": 12345
},
{
"name": "...",
"sysidLocationMapImage": 12345,
"displayOrder": 12345,
"thumbnailSource": "...",
"imageSource": "...",
"description": "...",
"defaultImage": true,
"height": 12345,
"width": 12345
}
],
"displayOrder": 12345,
"locationImages": [
{
"width": 12345,
"name": "...",
"description": "...",
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"defaultImage": true,
"sysidLocationImage": 12345,
"thumbnailSource": "..."
},
{
"width": 12345,
"name": "...",
"description": "...",
"displayOrder": 12345,
"imageSource": "...",
"height": 12345,
"defaultImage": true,
"sysidLocationImage": 12345,
"thumbnailSource": "..."
}
],
"name": "...",
"children": [
{},
{}
],
"locationLevel": 12345
}
]
}Body
A wrapper class with a list of LocatorNode elements and a list of LocatorStructure elements. The locator structure defines how locator nodes are to be organized and at what level a node must have a Venue. The LocatorNode is a user-defined, self referencing data object that will be used to drill down to Containers with Resources
Response
List of updated Locator Node elements or Response(AgilquestExceptionData) com.agilquest.phoenix.shared.data.rest.wrapper.LocatorNodeWrapper