Location



[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/locations

Summary


Resources Methods
https://localhost:8443/api/rest/locations

https://localhost:8443/api/rest/locations/locators-associated-location-informations

POST Query all location informations by Locators.

https://localhost:8443/api/rest/locations/location-identifier-associated-devices

GET Query all Device Id by Location Id.

https://localhost:8443/api/rest/locations/location-associated-devices

POST Query all Device Id by Location Id list.

Resources


https://localhost:8443/api/rest/locations


https://localhost:8443/api/rest/locations/locators-associated-location-informations


Methods

POST

Query all location informations by Locators.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-location-locator-list+xml
application/vnd.plcm.plcm-location-locator-list+json

Response

Status Representation Description
200 application/vnd.plcm.plcm-location-list+xml
application/vnd.plcm.plcm-location-list+json
Location list successfully retrieved.
If there are more one representations, Http Accept must be set with the right one.
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.

https://localhost:8443/api/rest/locations/location-identifier-associated-devices


Methods

GET

Query all Device Id by Location Id.
[tags: RPRM]

Request

Query Parameters

Name Type Description
location-identifier xs:string Return device id list that match the location-identifier.

Response

Status Representation Description
200 application/vnd.plcm.plcm-string-list+xml
application/vnd.plcm.plcm-string-list+json
Device id list successfully retrieved
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.

https://localhost:8443/api/rest/locations/location-associated-devices


Methods

POST

Query all Device Id by Location Id list.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-location-id-list+xml
application/vnd.plcm.plcm-location-id-list+json

Response

Status Representation Description
200 application/vnd.plcm.plcm-location-device-list+xml
application/vnd.plcm.plcm-location-device-list+json
Device id list successfully retrieved
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.