Error
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
}
]
}LocationService
Get locationslocators
This operation returns all Locator Node values associated with the Forum which is the home account forum for the authenticated requesting user. Venue Node values are excluded from the list of returned locators.
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.
The user must either be the System Administrator, or the Home Account of the user must be set as the Forum Owner for the Forum with which the user authentication token is associated.
All locators are returned, regardless of the active flag setting of the node.
The requesting User must have the following rights to perform this task:
This operation returns a Locator Node Wrapper which contains the following fields:
GET
/
locations
/
locators
Error
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
}
]
}Response
200 - application/json
LocatorNodeWrapper com.agilquest.phoenix.shared.data.rest.wrapper.LocatorNodeWrapper