| Name
(* = required)
|
Data Type | Description |
| id
*
|
int |
facility id |
| selectTop
|
int |
the first location to return from the sorted list; null = don't trim top |
| selectBottom
|
int |
the last location to return from the sorted list; null = don't trim bottom |
| rql
|
string |
see RQL documentation
|
| sort
|
string |
see RQL documentation
|
| excludeAuditing
|
bool |
true: filters out locations contained in an active audit; however, this makes the response not cacheable. |
|
Type |
Description |
| ResourceList |
IList<Property.Models.LocationBrief>
|
|
| LocationId |
int
|
|
| Name |
string
|
|
| Deactivated |
bool
|
|
| HasInventory |
bool
|
|
| Links |
IList<WebApi.Hal.Link>
|
|
|
-
/rels/properties/location
|
|
Sample accept: application/hal+json
{
"_embedded": {
"item": [
{
"locationId": 1,
"name": "str",
"deactivated": true,
"hasInventory": true
}
]
}
}