List of layers in a project

(fr) Cette page n’est plus maintenue depuis la version 2022 de Geoconcept Web. Pour accéder à la documentation à jour de ce web service, veuillez suivre ce lien.

Basic principles

This web service returns a list of all the layers in a particular project/portal.

Availability

This web service is available at all times with Geoconcept Web.

V1

Settings / properties

Input

parameter description optional default

name

Project name

no

Output

parameter type min/max description

type

string

1/1

Types of layers
- raster: tiled layers
- vector: vector layers
- groupLayer: hybrid layers
- group: groups of layers

name

string

1/1

Layer name

label

string

1/1

Label for the layer displayed in the layer manager

depth

string

1/1

0 = base level, 1 = layers in a group

internalName

string

1/1

non-used

rights

string

1/1

non-used

disabled

string

1/1

non-used

metadataUrl

string

1/1

Metadata URL

legendUrl

string

1/1

Legend URL

format

string

1/1

image format (PNG, JPG, PNG24)

transparent

string

1/1

PNG image transparency (true/false)

visibility

string

1/1

1 = visible , O = invisible in the layer manager

opacity

string

1/1

Layer opacity (0 - 100)

background

string

1/1

Main layer (true/false)

singleTiledLayer

string

1/1

dynamic layer (true/false)

expanded

string

1/1

Developed group (true/false)

layerId

string

1/1

Layer identifier

legend

string

1/1

Display legend (true/false)

isDefaultLayer

string

1/1

Main layer (true/false)

isWebmap

string

1/1

Webmap layer (true/false)

tabname

string

1/1

Map tab

map

string

REST (GET)

Query

JSON query 

http://<server>/<webapp>/api/easy/project/layers.json?name=Loire-Atlantique

Response

The response is always encoded in UTF-8.

JSON format 

{
  "result": {
    "layers": [
      {
        "type": "vector",
        "name": "samplePoints",
        "label": "Letterbox",
        "depth": 0,
        "internalName": null,
        "rights": "",
        "disabled": false,
        "metadataUrl": null,
        "legendUrl": null,
        "visibility": 0,
        "opacity": 100,
        "layerId": "122",
        "legend": true
      },
      {
        "type": "layer",
        "name": "ADMINISTRATIVE",
        "label": "Administrative",
        "depth": 0,
        "internalName": null,
        "rights": "",
        "disabled": false,
        "metadataUrl": null,
        "legendUrl": null,
        "format": "pngt",
        "transparent": true,
        "visibility": 0,
        "opacity": 100,
        "background": false,
        "singleTiledLayer": false,
        "legend": true,
        "isDefaultLayer": false,
        "isWebmap": false,
        "tabname": "ADMINISTRATIVE",
        "map": "Loire-Atlantique"
      },
      {
        "type": "layer",
        "name": "BASEMAP",
        "label": "BASEMAP",
        "depth": 0,
        "internalName": null,
        "rights": "",
        "disabled": false,
        "metadataUrl": null,
        "legendUrl": null,
        "format": "pngt",
        "transparent": true,
        "visibility": 1,
        "opacity": 100,
        "background": true,
        "singleTiledLayer": false,
        "legend": false,
        "isDefaultLayer": true,
        "isWebmap": false,
        "tabname": "STANDARD",
        "map": "Loire-Atlantique"
      },
      {
        "type": "layer",
        "name": "COMPLETE",
        "label": "COMPLETE",
        "depth": 0,
        "internalName": null,
        "rights": "",
        "disabled": false,
        "metadataUrl": null,
        "legendUrl": null,
        "format": "png",
        "transparent": false,
        "visibility": 0,
        "opacity": 100,
        "background": false,
        "singleTiledLayer": false,
        "legend": true,
        "isDefaultLayer": false,
        "isWebmap": false,
        "tabname": "COMPLETE",
        "map": "Loire-Atlantique"
      }
    ]
  },
  "message": "Layers in project Loire-Atlantique",
  "status": "OK"
}