/regions
- Mount Point: /resource/rest/regions
The following operations are supported on this resource:
Retrieves list of all defined regions in EPG in specified format. In case format is not provided, default one is used.Note: this API might use caching configured in web.xml.
Parameters
name |
description |
type |
default |
start |
0..N - start offset for returned documents. Default value is 0. |
query |
0 |
count |
1..N - number of documents to return. By default, return all documents. |
query |
|
regionId |
EPG unique identifier for region. |
query |
|
externalId |
deprecated. not used anymore |
query |
|
servedId |
Identifier for the area served. Postal code is an example of such an identifier. |
query |
|
deviceType |
device type |
query |
|
zipCode |
zip code (used to filter regions if regionId, serveId is null) |
query |
|
ipAddress |
ip address (used to filter regions if regionId, serveId, zipCode is null) |
query |
|
useRequestIP |
if [true] tries to resolve ip address from request |
query |
|
formatCode |
Code of format in which result should be shown.* |
query |
|
Output Payload
element |
produceable content type(s) |
(custom) |
|
description |
Regions in specified format. |
Exceptions
name |
description |
RESTWebserviceException |
Thrown if an exception occurs. |