LocationsResource
LocationsResource REST endpoint to access and manipulate collections of Location data. Copyright 2013 WANdisco.
The following resources are part of this group:
/locations
Mount Point: /api/locations
GET
Returns the LocationListDTO containing all known locations
Parameters
| name | description | type | default |
|---|---|---|---|
| order | optional order parameter can be ASC or DESC | query |
Response Body
| element: | (custom) |
| media types: | application/xml |
(no documentation provided)
/locations/inducted
Mount Point: /api/locations/inducted
GET
Returns the LocationListDTO containing all known locations which have completed induction
Parameters
| name | description | type | default |
|---|---|---|---|
| order | optional order parameter can be ASC or DESC | query |
Response Body
| element: | (custom) |
| media types: | application/xml |
(no documentation provided)
/locations/local
Mount Point: /api/locations/local
GET
Returns the LocationDTO which is local to this node if it exists or a 404 not found exception if the element does not exist
Response Body
| element: | (custom) |
| media types: | application/xml |
(no documentation provided)
PUT
Request Body
| element: | node |
| media types: | application/xml |
(no documentation provided)
Response Body
| element: | (custom) |
| media types: | */* application/xml |
(no documentation provided)
/locations/pending-induction
Mount Point: /api/locations/pending-induction
GET
Returns the LocationListDTO containing all known locations which are pending induction
Parameters
| name | description | type | default |
|---|---|---|---|
| order | optional order parameter can be ASC or DESC | query |
Response Body
| element: | (custom) |
| media types: | application/xml |
(no documentation provided)