Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
=====================================================
MapServer Rest API - Rest Configuration API Reference
=====================================================
Formats and representations
===========================
The following table defines the ``content-type`` values for each format you can use.
+-------------+---------------------------------------------------------------+
| Format | Content-type |
+=============+===============================================================+
| XML | ``application/xml`` (or ``text/xml``) |
+-------------+---------------------------------------------------------------+
| JSON | ``application/json`` |
+-------------+---------------------------------------------------------------+
| HTML | ``text/html`` |
+-------------+---------------------------------------------------------------+
| SLD | ``application/vnd.ogc.sld+xml`` |
+-------------+---------------------------------------------------------------+
| MAP | ``text/plain`` |
+-------------+---------------------------------------------------------------+
Status codes
============
The following table sets out the main ``status-code`` you can obtain.
+-------------+---------------------------------------------------------------+
| Status-code | Definition |
+=============+===============================================================+
| 200 | The request was fulfilled |
+-------------+---------------------------------------------------------------+
| 201 | The request was fulfilled and resulted in a new resource |
| | being created |
+-------------+---------------------------------------------------------------+
| 403 | The server understood the request, but is refusing to fulfill |
| | it |
+-------------+---------------------------------------------------------------+
| 404 | The server has not found anything matching the URI given |
+-------------+---------------------------------------------------------------+
| 405 | The method is not allowed by the server |
+-------------+---------------------------------------------------------------+
| 500 | The server encountered an unexpected condition which |
| | prevented it from fulfilling the request |
+-------------+---------------------------------------------------------------+
| 501 | The server does not support the functionality required to |
| | fulfill the request. |
+-------------+---------------------------------------------------------------+
See `HTTP specification`_ for more information about status codes.
.. _HTTP specification: http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
Maps
====
``Maps`` includes all mapfiles.
The Mapfile is the heart of MapServer.
It defines the relationships between objects, points MapServer to where data are located and defines how things are to be drawn.
See `Mapfile specification`_ for more information about the Mapfile.
.. _Mapfile specification: http://www.mapserver.org/mapfile/
Operations
----------
``/maps.<format>``
^^^^^^^^^^^^^^^^^^
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | List all mapfiles | 200 | XML, JSON, HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | Create a new mapfile | 201 with | XML, JSON |
| | | ``location``| |
| | | header | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | | 405 | |
+--------+---------------------------------+-------------+--------------------+
*Exceptions:*
* POST for a mapfile already exist: 409 Conflict
``/maps/<map>.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | List all mapfiles | 200 | MAP, XML, JSON, |
| | | | HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| PUT | *TODO: Modify mapfile <map>* | | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | Delete mapfile <map> | | |
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
+--------+---------------------------------+-------------+--------------------+
*Exceptions:*
* GET for a mapfile does not exist: 404 Not Found
* *TODO: PUT that changes name of mapfile: 403 Forbidden*
* *TODO: DELETE against a mapfile that is non-empty: 403 Forbidden*
Workspaces
==========
A workspace is a grouping of data stores and coverage stores.
Operations
----------
``/maps/<map>/workspaces.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | List all workspaces | 200 | XML, JSON, HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | *TODO: Create a new workspace* | | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | | 405 | |
+--------+---------------------------------+-------------+--------------------+
``/maps/<map>/workspaces/<ws>.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For current version of MapServer Rest API, a ``workspace`` corresponds to a mapfile.
And so, only one workspace can be available.
Thus, in order to not confuse the two concepts, the workspace is set to 'default' value.
``/maps/<map>/workspaces/default.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | Return default workspace | 200 | XML, JSON, HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | | 405 | |
+--------+---------------------------------+-------------+--------------------+
Data stores
===========
A ``data store`` is a source of spatial data that is vector based.
Only the case of PostGIS is currently implemented.
Operations
----------
``/maps/<map>/workspaces/<ws>/datastores.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<ws>`` by the name of your workspace.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | List all data stores in | 200 | XML, JSON, HTML |
| | workspace/mapfile <ws> | | |
+--------+---------------------------------+-------------+--------------------+
| POST | Create new data store | 201 with | XML, JSON |
| | | ``location``| |
| | | header | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | | 405 | |
+--------+---------------------------------+-------------+--------------------+
*Exceptions:*
* POST for a data store already exist: 409 Conflict
``/maps/<map>/workspaces/<ws>/datastores/<ds>.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<ws>`` by the name of your workspace.
| Replace ``<ds>`` by the name of datastore available of your choice.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | Return data store <ds> | 200 | XML, JSON, HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| PUT | Modify data store <ds> | 200 | XML, JSON |
+--------+---------------------------------+-------------+--------------------+
| DELETE | Delete data store <ds> | 200 | |
+--------+---------------------------------+-------------+--------------------+
*Exceptions:*
* GET for a data store does not exist: 404 Not Found
* PUT that changes name of data store: 403 Forbidden
* DELETE against a data store that contains configured feature type: 403 Forbidden
``/maps/<map>/workspaces/<ws>/datastores/<ds>/file[.<extension>]``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Uploads a file from a local source. The body of the request is the file itself.
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<ws>`` by the name of your workspace.
| Replace ``<ds>`` by the name of datastore available of your choice.
The ``<extension>`` parameter specifies the type of data store.
The following extensions are supported:
+-------------------+---------------------------------------------------------+
| Extension | Datastore |
+===================+=========================================================+
+-------------------+---------------------------------------------------------+
+--------+--------------------------+-------------+-----------+---------------+
| Method | Action | Return Code | Formats | Parameters |
+========+==========================+=============+===========+===============+
| GET | | 405 | | |
+--------+--------------------------+-------------+-----------+---------------+
| POST | | 405 | | |
+--------+--------------------------+-------------+-----------+---------------+
| PUT | Uploads files to the | 200 | See notes | ``configure`` |
| | data stores <ds> | | below. | See notes |
| | | | | below. |
+--------+--------------------------+-------------+-----------+---------------+
| DELETE | | 405 | | |
+--------+--------------------------+-------------+-----------+---------------+
Data stores like Shapefile must be sent as a zip archive.
When uploading a zip archive the ``Content-type`` should be set to ``application/zip``
The ``configure`` parameter is used to control how the data store is configured upon file upload.
It can take one of the below values :
* ``none`` - Do not configure any feature types. This is the default value
* *TODO: ``first`` - Only setup the first feature type available in the data store.*
* *TODO: ``all` - Configure all feature types.*
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
Feature types
=============
A ``feature type`` is a data set that originates from a data store.
Operations
----------
``/maps/<map>/workspaces/<ws>/datastores/<ds>/featuretypes.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<ws>`` by the name of your workspace.
| Replace ``<ds>`` by the name of datastore available of your choice.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | List all feature types in | 200 | XML, JSON, HTML |
| | selected data store <ds> | | |
+--------+---------------------------------+-------------+--------------------+
| POST | Create a new feature type | 201 with | XML, JSON |
| | | ``location``| |
| | | header | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | | 405 | |
+--------+---------------------------------+-------------+--------------------+
*Exceptions:*
* GET for a feature type that does not exist: 404 Not Found
* POST for a feature type already exist: 409 Conflict
``/maps/<map>/workspaces/<ws>/datastores/<ds>/featuretypes/<ft>.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<ws>`` by the name of your workspace.
| Replace ``<ds>`` by the name of datastore available of your choice.
| Replace ``<ft>`` by the name of feature type available of your choice.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | Return feature type <ft> | 200 | XML, JSON, HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| PUT | Modify feature type <ft> | 200 | XML, JSON |
+--------+---------------------------------+-------------+--------------------+
| DELETE | Delete feature type <ft> | 200 | |
+--------+---------------------------------+-------------+--------------------+
*Exceptions:*
* GET for a feature type does not exist: 404 Not Found
* PUT that changes name of feature type: 403 Forbidden
* DELETE against a feature type which is used by a layer: 403 Forbidden
Coverage stores
===============
A ``coverage store`` is a source of spatial data that is raster based.
Operations
----------
``/maps/<map>/workspaces/<ws>/coveragestores.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<ws>`` by the name of your workspace.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | List all coverage stores in | 200 | XML, JSON, HTML |
| | workspace | | |
+--------+---------------------------------+-------------+--------------------+
| POST | Create new coverage store | 201 with | XML, JSON |
| | | ``location``| |
| | | header | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | | 405 | |
+--------+---------------------------------+-------------+--------------------+
*Exceptions:*
* POST for a coverage store already exist: 409 Conflict
``/maps/<map>/workspaces/<ws>/coveragestores/<cs>.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<ws>`` by the name of your workspace.
| Replace ``<cs>`` by the name of coverage store available of your choice.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | Return coverage store <cs> | 200 | XML, JSON, HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| PUT | Modify coverage store <ds> | 200 | XML, JSON |
+--------+---------------------------------+-------------+--------------------+
| DELETE | Delete coverage store <ds> | 200 | |
+--------+---------------------------------+-------------+--------------------+
*Exceptions:*
* GET for a coverage store does not exist: 404 Not Found
* PUT that changes name of coverage store: 403 Forbidden
* DELETE against a coverage store that contains configured coverage: 403 Forbidden
Coverages
=========
A ``coverage`` is a raster based data set which originates from a coverage store.
Operations
----------
``/maps/<map>/workspaces/<ws>/coveragestores/<cs>/coverages.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<ws>`` by the name of your workspace.
| Replace ``<cs>`` by the name of coverage store available of your choice.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | List all coverages in selected | 200 | XML, JSON, HTML |
| | coverages store <cs> | | |
+--------+---------------------------------+-------------+--------------------+
| POST | Create a new coverage | 201 With | XML, JSON |
| | | ``Location``| |
| | | header | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | | 405 | |
+--------+---------------------------------+-------------+--------------------+
*Exceptions:*
* POST for a coverage already exist: 409 Conflict
``/maps/<map>/workspaces/<ws>/coveragestores/<cs>/coverages/<c>.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<ws>`` by the name of your workspace.
| Replace ``<cs>`` by the name of coverage store available of your choice.
| Replace ``<c>`` by the name of coverage available of your choice.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | Return coverage <c> | 200 | XML, JSON, HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| PUT | Create new coverage <c> | 200 | XML, JSON |
+--------+---------------------------------+-------------+--------------------+
| DELETE | Delete coverage <c> | 200 | |
+--------+---------------------------------+-------------+--------------------+
*Exceptions:*
* GET for a coverage does not exist: 404 Not Found
* PUT that changes name of coverage: 403 Forbidden
* DELETE against a coverage which is used by a layer: 403 Forbidden
Styles
======
A ``style`` describes how a resource (feature type or coverage) should be symbolized or rendered by a Web Map Service.
Styles are specified with SLD and translated into the mapfile (with CLASS and STYLE blocs) to be applied.
Operations
----------
``/maps/<map>/styles.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | Return all styles for map <map> | 200 | XML, JSON, HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | Create a new style for map | 201 With | SLD (see note |
| | | ``Location``| below) |
| | | header | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | | 405 | |
+--------+---------------------------------+-------------+--------------------+
+--------+--------------------------+-------------+-----------+---------------+
| Method | Action | Return Code | Formats | Parameters |
+========+==========================+=============+===========+===============+
| GET | Return all styles | 200 | | |
+--------+--------------------------+-------------+-----------+---------------+
| POST | Create a new style | 201 With | SLD (see | name (see note|
| | | ``Location``| note | below) |
| | | header | below) | |
+--------+--------------------------+-------------+-----------+---------------+
| PUT | | 405 | | |
+--------+--------------------------+-------------+-----------+---------------+
| DELETE | | 405 | | |
+--------+--------------------------+-------------+-----------+---------------+
When executing a POST request with an SLD style, the Content-type header should be set to ``application/vnd.ogc.sld+xml``.
The ``name`` parameter specifies the name to be given to the style.
*Exceptions:*
* POST for a style already exist: 409 Conflict
``/maps/<map>/styles/<s>.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<s>`` by the name of the style for layer of your choice.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | Return style <s> | 200 | SLD, HTML, XML, |
| | | | JSON |
+--------+---------------------------------+-------------+--------------------+
| POST | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| PUT | Modify style <s> | 200 | SLD (see note |
| | | | below) |
+--------+---------------------------------+-------------+--------------------+
| DELETE | Delete style <s> | 200 | |
+--------+---------------------------------+-------------+--------------------+
When executing a POST request with an SLD style, the Content-type header should be set to ``application/vnd.ogc.sld+xml``.
*Exception:*
* GET for a style does not exist: 404 Not Found
* *TODO: PUT that changes name of style: 403 Forbidden*
* *DELETE against a coverage which is used by a layer: 403 Forbidden*
Layers
======
A ``layer`` is a published resource (feature type or coverage) from a mapfile.
Operations
----------
``/maps/<map>/layers.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | List all layers provided by | 200 | XML, JSON, HTML |
| | the mapfile <map> | | |
+--------+---------------------------------+-------------+--------------------+
| POST | Create a layer | 201 With | XML, JSON |
| | | ``Location``| |
| | | header | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | | 405 | |
+--------+---------------------------------+-------------+--------------------+
*Exception:*
* POST for a layer already exist: 409 Conflict
``/maps/<map>/layers/<l>.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<l>`` by the name of the layer of your choice.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | Return layer <l> | 200 | XML, JSON, HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| PUT | Modify layer <l> | 200 | XML, JSON |
+--------+---------------------------------+-------------+--------------------+
| DELETE | Delete layer <l> | 200 | |
+--------+---------------------------------+-------------+--------------------+
*Exception:*
* GET for a layer does not exist: 404 Not Found
* PUT that changes name of layer: 403 Forbidden
``/maps/<map>/layers/<l>/styles.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<l>`` by the name of the layer of your choice.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | Return all styles for layer <l> | 200 | XML, JSON, HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | Add a new style to layer <l> | 201 With | XML, JSON |
| | | ``Location``| |
| | | header | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | | 405 | |
+--------+---------------------------------+-------------+--------------------+
*Exception:*
* POST for a style already exist: 409 Conflict
``/maps/<map>/layers/<l>/styles/<s>.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<l>`` by the name of the layer of your choice.
| Replace ``<s>`` by the name of the style of your choice.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| POST | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | Remove style <s> from layer <l> | 200 | |
+--------+---------------------------------+-------------+--------------------+
Layergroups
===========
A ``layergroup`` is a grouping of layers and styles that can be accessed as a single layer in a WMS GetMap request.
Operations
----------
``/maps/<map>/layergroups.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | List all layer groups provided | 200 | XML, JSON, HTML |
| | by the mapfile <map> | | |
+--------+---------------------------------+-------------+--------------------+
| POST | Create a new layer group | 201 With | XML, JSON |
| | | ``Location``| |
| | | header | |
+--------+---------------------------------+-------------+--------------------+
| PUT | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| DELETE | | 405 | |
+--------+---------------------------------+-------------+--------------------+
*Exception:*
* POST for a layer group already exist: 409 Conflict
``/maps/<map>/layergroups/<lg>.<format>``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Replace ``<map>`` by the name of your mapfile.
| Replace ``<lg>`` by the name of the layer group of your choice.
| Replace ``<format>`` by the format extension of your choice.
+--------+---------------------------------+-------------+--------------------+
| Method | Action | Return Code | Formats |
+========+=================================+=============+====================+
| GET | Return layer group <lg> | 200 | XML, JSON, HTML |
+--------+---------------------------------+-------------+--------------------+
| POST | | 405 | |
+--------+---------------------------------+-------------+--------------------+
| PUT | Add layer group <lg> | 200 | XML, JSON |
+--------+---------------------------------+-------------+--------------------+
| DELETE | Delete layer group <lg> | 200 | |
+--------+---------------------------------+-------------+--------------------+
*Exception:*
* GET for a layer group does not exist: 404 Not Found
* PUT that changes name of layer group: 403 Forbidden