Area



[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/areas

Summary


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

GET  Retrieves list of all available areas.

https://localhost:8443/api/rest/areas/{area-identifier}

GET  Retrieves area with passed area-identifier.

Resources


https://localhost:8443/api/rest/areas


Methods

GET


Retrieves list of all available areas.
[tags: RPRM]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-area-list+xml
application/vnd.plcm.plcm-area-list+json
Area list information successfully retrieved.
304
Area list information has not changed since the last search.

Note: The API client must provide the "plcm-area-list" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-area-list" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
users on the server.

https://localhost:8443/api/rest/areas/{area-identifier}


Template Parameters

Name Type Description
area-identifier xs:string

Methods

GET


Retrieves area with passed area-identifier.
[tags: RPRM]

Response

Status Representation Description
200 application/vnd.plcm.plcm-area+xml
application/vnd.plcm.plcm-area+json
Area successfully retrieved.
304
Area information has not changed since the last search.

Note: The API client must provide the "plcm-area" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-area" ETag can be accessed from the initial search result's HTTP
response header. Also, subsequent searches require the identical search filter
to ensure an equivalent ETag value. This also assumes no other client made changes to
users on the server.