forked from City-of-Helsinki/smbackend
-
Notifications
You must be signed in to change notification settings - Fork 0
/
specification.swagger.yaml
1624 lines (1565 loc) · 59.8 KB
/
specification.swagger.yaml
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
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
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Servicemap API
description: >-
The Servicemap API provides categorized data on services, both public and
private, and service locations within a city or metropolitan area.
The API provides data in the JSON format, in a RESTful fashion.
The two most important resources provided by the API are
1. **units**, concrete physical locations which provide services to citizens, and
2. **services**, which are the categories of services that can be provided by units.
There are several more supporting resources linked to units in one way or another, and they are all specified in this documentation.
Several fields are multilingual. These are implemented as objects with each language variant as property.
termsOfService: https://hri.fi/data/fi/dataset/paakaupunkiseudun-palvelukartan-rest-rajapinta
version: v2
tags:
- name: unit
description: Retrieve units (service points) filtered by various criteria
- name: service
description: Get categories of services that can be provided by units
- name: organization
description: Retrieve information about organizations providing services
- name: search
description: Full text search through units, services, and also street addresses
- name: accessibility
description: Get rules for calculating accessibility shortcomings of a unit
- name: geography
description: Spatial information about municipalities where the services are located
- name: observation
description: A measured or observed value of a property of a unit at a certain time.
paths:
"/unit/{id}/":
get:
summary: Retrieve single unit by id
operationId: Retrieve unit
tags:
- unit
responses:
"200":
description: Single unit object
content:
application/json:
schema:
$ref: "#/components/schemas/unit"
parameters:
- name: id
in: path
description: Unit identifier as defined in unit schema
required: true
schema:
type: integer
example: 58520
- $ref: "#/components/parameters/include_param"
- $ref: "#/components/parameters/only_param"
- $ref: "#/components/parameters/geometry_param"
/unit/:
get:
operationId: Retrieve unit list
summary: Return a list of units
description: |
Without parameters, return a list of all units. With query
parameters, the set of returned units is filtered and the
structure of returned units can be fine tuned.
tags:
- unit
parameters:
- $ref: "#/components/parameters/page_param"
- $ref: "#/components/parameters/pagesize_param"
- $ref: "#/components/parameters/include_param"
- $ref: "#/components/parameters/only_param"
- name: service
in: query
style: form
explode: false
description: A comma-separated list of service ids to be used as a filter
schema:
type: array
items:
type: integer
example: 868,873
- name: id
in: query
style: form
explode: false
description: A comma-separated list of one or more unit ids to be used as a filter
required: false
schema:
type: array
items:
type: integer
example: 58532, 58533
- name: lat
in: query
description: A latitude coordinate to be used as part of a location filter
required: false
schema:
type: number
example: 60.1695096
- name: lon
in: query
description: A longitude coordinate to be used as part of a location filter
required: false
schema:
type: number
example: 24.9405559
- name: distance
in: query
description: A distance radius filter to be used as part of a location filter
along with lat and lon
required: false
schema:
type: number
example: 20.20
- name: municipality
in: query
style: form
explode: false
description: A comma-separated list of one or more municipality ids. The returned
units will be located within the municipalities\' boundaries. The
municipality ids are either municipality names in Finnish, or full
OCD IDs of the form ocd-division/country\:fi/kunta\:helsinki (URL
encoded) See the [OpenCivicData
Site](http://opencivicdata.readthedocs.io/en/latest/ocdids.html) for
more information
required: false
schema:
type: array
items:
type: string
example: helsinki,espoo
- name: city_as_department
in: query
style: form
explode: false
description: Retrieve units which are _either_ owned/provided by the desired
cities _or_ contained within the city's geographical boundaries. The
parameter value must be an UUID identifying a top-level department
which is a city.
required: false
schema:
type: array
items:
type: string
example: 83e74666-0836-4c1d-948a-4b34a8b90301,520a4492-cb78-498b-9c82-86504de88dce
- name: provider_type
in: query
style: form
explode: false
description: A comma-separated list of unit provider types to be used as a filter
required: false
schema:
type: array
items:
type: integer
example: 1,8
- name: provider_type__not
in: query
style: form
explode: false
description: A comma-separated list of unit provider types to be used as an
exclusion filter
required: false
schema:
type: array
items:
type: integer
example: 2,3
- name: level
in: query
description: >
A string value from a predefined list, which acts as a shorthand
filter that aggregates several thematic services together, for
example \"most common public services\". Accepted values are 'common' and 'customer_service'
required: false
schema:
type: string
example: common
- name: service_node
in: query
style: form
explode: false
description: A comma-separated list of service node ids to be used as a filter.
Prefer the *services* parameter unless service nodes are
specifically needed.
schema:
type: array
items:
type: integer
example: 2125,1090
- name: exclude_service_nodes
in: query
style: form
explode: false
description: A comma-separated list of service node ids to be used as an
exclusion filter
schema:
type: array
items:
type: integer
example: 2125,1090
- name: division
in: query
style: form
explode: false
description: A comma-separated list of administrative divisions to be used as a
filter. Use either full division ids or shorthands of the form
muni/type\:id
required: false
schema:
type: array
items:
type: string
example: helsinki/kaupunginosa:kallio
- $ref: "#/components/parameters/unit_bbox_param"
- name: bbox_srid
in: query
description: An SRID coordinate reference system identifier which specifies the
coordinate system used in the bbox parameter. Currently supported values are 4326 and 3046.
schema:
type: integer
example: 3046
- $ref: "#/components/parameters/geometry_param"
- name: maintenance_organization
in: query
description: >
A lowercase municipality name in Finnish specifying which
organization is responsible for maintenance of this unit.
Needed mainly because of skiing trails near the border of
two municipalities where the maintaining municipality is
not always the same as the municipality (location) of the
unit.
schema:
type: string
example: helsinki
- name: category
in: query
style: form
explode: false
description: >
Comma-separated value specifying which services or service
nodes to filter units by. The values are of the form
[category_type]:[id] where category_type is either
"service" or "service_node" and id is the primary id of a
resource of the corresponding type. Eg. "service:234".
schema:
type: array
items:
type: string
example: service:234,service:863
- name: address
in: query
description: >
Retrive units with the given address.
schema:
type: string
example: Mannerheimintie
responses:
"200":
description: List of units, paginated
content:
application/json:
schema:
type: object
allOf:
- properties:
results:
type: array
items:
$ref: "#/components/schemas/unit"
- $ref: "#/components/schemas/common_collection"
"/service/{id}/":
get:
summary: Retrieve single service by id
operationId: Retrieve service
tags:
- service
responses:
"200":
description: Single service object
content:
application/json:
schema:
$ref: "#/components/schemas/service"
parameters:
- name: id
in: path
description: Service identifier as defined in service schema
required: true
schema:
type: integer
example: 811
- $ref: "#/components/parameters/include_param"
- $ref: "#/components/parameters/only_param"
- $ref: "#/components/parameters/geometry_param"
/service/:
get:
operationId: Retrieve service list
summary: Return a list of services
description: |
Without parameters, return a list of all services.
tags:
- service
parameters:
- $ref: "#/components/parameters/page_param"
- $ref: "#/components/parameters/pagesize_param"
- name: id
in: query
style: form
explode: false
description: A comma-separated list of service ids to filter by
schema:
type: array
items:
type: integer
example: 811,663
responses:
"200":
description: List of services, paginated
content:
application/json:
schema:
type: object
allOf:
- properties:
results:
type: array
items:
$ref: "#/components/schemas/service"
- $ref: "#/components/schemas/common_collection"
"/service_node/{id}/":
get:
summary: Retrieve single service node by id. Always prefer the **service**
endpoint unless service nodes are specifically required.
operationId: Retrieve service node
tags:
- service
responses:
"200":
description: Single service node object
content:
application/json:
schema:
$ref: "#/components/schemas/service_node"
parameters:
- name: id
in: path
description: Service identifier as defined in service_node schema
required: true
schema:
type: integer
example: 2125
- $ref: "#/components/parameters/include_param"
- $ref: "#/components/parameters/only_param"
- $ref: "#/components/parameters/geometry_param"
/service_node/:
get:
operationId: Retrieve service node list
summary: Return a list of service nodes. Always prefer the **service** endpoint
unless service nodes are specifically required.
description: |
Without parameters, return a list of all service nodes.
tags:
- service
parameters:
- $ref: "#/components/parameters/page_param"
- $ref: "#/components/parameters/pagesize_param"
- $ref: "#/components/parameters/include_param"
- $ref: "#/components/parameters/only_param"
- name: id
in: query
style: form
explode: false
description: A comma-separated list of service_node ids to filter by
schema:
type: array
items:
type: integer
example: 2125,1090
- name: ancestor
in: query
description: The id of a service_node whose descendants are to be returned in the
response
schema:
type: integer
example: 870
responses:
"200":
description: List of service nodes, paginated
content:
application/json:
schema:
type: object
allOf:
- properties:
results:
type: array
items:
$ref: "#/components/schemas/service_node"
- $ref: "#/components/schemas/common_collection"
"/department/{id}/":
get:
operationId: Retrieve a single department
summary: Return a single department
description: Return a single department
tags:
- organization
parameters:
- name: id
in: path
description: Department uuid
required: true
schema:
type: string
example: 520a4492-cb78-498b-9c82-86504de88dce
- name: include_hierarchy
in: query
description: With an empty value or any value other than *no*, *false*, or *0*,
include the whole descendant hierarchy beginning at this department
in the response. Omitting this parameter, or including it with the
value *no*, *false*, or *0*, disables expanding the hierarchy.
schema:
type: string
example: 1
- $ref: "#/components/parameters/include_param"
- $ref: "#/components/parameters/only_param"
- $ref: "#/components/parameters/geometry_param"
responses:
"200":
description: The requested department
content:
application/json:
schema:
$ref: "#/components/schemas/department"
/department/:
get:
operationId: Retrieve list of departments
summary: Return a list of departments
description: Return a list of all departments
tags:
- organization
parameters:
- $ref: "#/components/parameters/page_param"
- $ref: "#/components/parameters/pagesize_param"
- $ref: "#/components/parameters/include_param"
- $ref: "#/components/parameters/only_param"
responses:
"200":
description: List of departments, paginated
content:
application/json:
schema:
type: object
allOf:
- properties:
results:
type: array
items:
$ref: "#/components/schemas/department"
- $ref: "#/components/schemas/common_collection"
/search/:
get:
operationId: Full text search
summary: Full text search through units, services, service nodes, and addresses
description: Return a heterogeneous list of full text matches for given queries.
Supports both full queries and autosuggest queries with partial input.
If the parameter *q* is used, a complete search will be performed. If
the parameter *input* is used, an autosuggest search will be performed.
tags:
- search
parameters:
- name: type
in: query
description: If present, this parameter will restrict the types of resources
returned in the results. Possible values are *service_node*,
*service*, *unit*, *address*. If not present, the default types are
*service*, *unit*, *address*.
schema:
type: string
example: service_node
- name: language
in: query
description: The two-character ISO 639-1 language code to be used in the search.
If missing, the search will use the default language Finnish.
schema:
type: string
example: fi
- name: q
in: query
description: The complete search query to be used.
schema:
type: string
example: sairaala helsinki
- name: input
in: query
description: A partial user input to be used in an autosuggest search
schema:
type: string
example: sairaal
- name: municipality
in: query
style: form
explode: false
description: A comma-separated list of municipalities to be used to filter units.
Uses the simple format of lowercase municipality name in Finnish
instead of an OCD id.
schema:
type: array
items:
type: string
example: helsinki,espoo
- name: service
in: query
style: form
explode: false
description: A comma-separated list of service ids to be used to filter units.
schema:
type: array
items:
type: integer
example: 456,567
- name: include
in: query
style: form
explode: false
description: Embed the complete content of given reference-type fields directly
into the response, otherwise they are returned as identifiers.
Separate field names by commas. In the search endpoint, you must
qualify the field names with the resource names because many kinds
of resources are searched through. For example, instead of
**include=department** you must specify **include=unit.department**.
The set of valid prefixes is the same as the set of valid values in
the type field of the search endpoint.
schema:
type: array
items:
type: string
example: unit.department
- name: only
in: query
style: form
explode: false
description: >
Restrict the field returned in the results. Separate field
names by commas. In the search endpoint, you must qualify
the field names with the resource names using the format
[resource].[field] because the endpoint contains resources
of several kinds.
schema:
type: array
items:
type: string
example: unit.organizer_name
- $ref: "#/components/parameters/page_param"
- $ref: "#/components/parameters/pagesize_param"
responses:
"200":
description: List of search results, paginated
content:
application/json:
schema:
type: object
allOf:
- properties:
results:
type: array
items:
type: object
description: An object of type *unit*, *service*, *address*, or
*service_node*. The field *object_type* reveals the
type of the resource. **Note that in this field
only, service_node is spelled servicenode**.
- $ref: "#/components/schemas/common_collection"
/accessibility_rule/:
get:
operationId: Retrieve accessibility rule list
summary: Retrieve the rule database for calculating the accessibility
shortcomings of any unit
deprecated: true
tags:
- accessibility
responses:
"200":
description: List of accessibility rules and shortcoming messages
content:
application/json:
schema:
$ref: "#/components/schemas/accessibility_rule"
/observation/:
get:
operationId: Retrieve list of observations
summary: Retrieve list of observations
description: Retrieve list of observations
tags:
- observation
parameters:
- $ref: "#/components/parameters/page_param"
- $ref: "#/components/parameters/pagesize_param"
- $ref: "#/components/parameters/include_param"
- $ref: "#/components/parameters/only_param"
responses:
"200":
description: List of all observations made about units
content:
application/json:
schema:
$ref: "#/components/schemas/observation"
"/administrative_division/{id}/":
get:
operationId: Retrieve a single administrative division
summary: Retrieve a single administrative division
description: Retrieve a single administrative division
tags:
- geography
responses:
"200":
description: The requested administrative division
content:
application/json:
schema:
$ref: "#/components/schemas/administrative_division"
parameters:
- name: id
in: path
description: Administrative division identifier as defined in administrative
division schema
required: true
schema:
type: string
example: 222
- $ref: "#/components/parameters/include_param"
- $ref: "#/components/parameters/only_param"
- $ref: "#/components/parameters/geometry_param"
/administrative_division/:
get:
operationId: Retrieve list of administrative divisions
summary: Retrieve list of administrative divisions
description: Retrieve list of administrative divisions
tags:
- geography
parameters:
- name: input
in: query
description: A partial user input to be used in an autosuggest search, matching names of administrative divisions
schema:
type: string
example: hel
- name: ocd_id
in: query
style: form
explode: false
description: Comma-separated list of ocd_ids of administrative divisions to match
schema:
type: array
items:
type: string
example: vantaa/äänestysalue:5
- $ref: "#/components/parameters/only_param"
- name: origin_id
in: query
description: Filter by origin_id, which is usually a primary id used in the original data source
schema:
type: string
example: 694
- name: date
in: query
description: >
Some administrative divisions such as school districts are
only valid during a specified period of time, eg. from
August 2019 to May 2020. The date filter is used to return only
the divisions whose associated time period contain the requested
date.
schema:
type: string
example: 2020-02-22
responses:
"200":
description: List of administrative divisions, paginated
content:
application/json:
schema:
type: object
allOf:
- properties:
results:
type: array
items:
$ref: "#/components/schemas/administrative_division"
- $ref: "#/components/schemas/common_collection"
/street/:
get:
operationId: Retrieve list of streets
summary: Retrieve list of streets
tags:
- geography
parameters:
- name: language
in: query
description: The two-character ISO 639-1 language code to be used in the street
names. If missing, the street name parameter will use the default
language Finnish.
schema:
type: string
example: fi
- name: municipality
in: query
description: A municipality id. The returned addresses will be located within the
municipalitie\'s boundaries. The municipality id is either a
municipality name in Finnish, or a full OCD ID of the form
ocd-division/country\:fi/kunta\:helsinki (URL encoded) See the
[OpenCivicData
Site](http://opencivicdata.readthedocs.io/en/latest/ocdids.html) for
more information
schema:
type: string
example: ocd-division/country\:fi/kunta\:helsinki
- name: input
in: query
description: An autosuggest search for street names, resulting in a prefix search.
schema:
type: string
example: siltasaar
responses:
"200":
description: A list of street resources
content:
application/json:
schema:
allOf:
- properties:
results:
type: array
items:
$ref: "#/components/schemas/street"
- $ref: "#/components/schemas/common_collection"
"/street/{id}/":
get:
operationId: Retrieve a single street resource
summary: Retrieve a single street resource
tags:
- geography
parameters:
- name: id
in: path
required: true
description: Internal id of street. Notice, not persistent. Should only be used
when resolving street ids from address resources.
schema:
type: integer
example: 2
responses:
"200":
description: A single street resource
content:
application/json:
schema:
$ref: "#/components/schemas/street"
/address/:
get:
operationId: Retrieve a list of addresses
summary: Retrieve a list of addresses
parameters:
- name: lat
in: query
description: The latitude coordinate to be used in reverse geocoding
schema:
type: number
example: 60.1695096
- name: lon
in: query
description: The longitude coordinate to be used in reverse geocoding
schema:
type: number
example: 24.9405559
- name: language
in: query
description: The two-character ISO 639-1 language code to be used in the street
names of the addresses. If missing, the street name parameter will
use the default language Finnish.
schema:
type: string
example: fi
- name: municipality
in: query
description: A municipality id. The returned addresses will be located within the
municipalitie\'s boundaries. The municipality id is either a
municipality name in Finnish, or a full OCD ID of the form
ocd-division/country\:fi/kunta\:helsinki (URL encoded) See the
[OpenCivicData
Site](http://opencivicdata.readthedocs.io/en/latest/ocdids.html) for
more information
schema:
type: string
example: espoo
- name: municipality_name
in: query
description: >
A municipality name to be used as a filter, in the
language specified by the language parameter. This is
mainly used to support UIs in different languages - the
municipality filter should be used in most cases.
schema:
type: string
example: helsinki
- name: street
in: query
description: Filter address by street. If a numeric identifier, the parameter is
interpreted as a street resource identifier (id field). If not, it
is interpreted as the exact street name, case insensitive.
schema:
type: string
example: siltasaarenkatu
- name: number
in: query
description: Filter by the number field of addresses.
schema:
type: integer
example: 1
tags:
- geography
responses:
"200":
description: List of address resources
content:
application/json:
schema:
allOf:
- properties:
results:
type: array
items:
$ref: "#/components/schemas/address"
- $ref: "#/components/schemas/common_collection"
servers:
- url: https://api.hel.fi/servicemap/v2
components:
parameters:
page_param:
name: page
in: query
description: Request particular page in paginated results
required: false
schema:
type: integer
example: 1
pagesize_param:
name: page_size
in: query
description: Request that server delivers page_size results in response
required: false
schema:
type: integer
example: 10
include_param:
name: include
in: query
style: form
explode: false
description: Embed the complete content of given reference-type fields directly into
the response, otherwise they are returned as identifiers. Separate field
names by commas.
schema:
type: array
items:
type: string
only_param:
name: only
in: query
style: form
explode: false
description: Restrict the field returned in the results. Separate field names by
commas.
schema:
type: array
items:
type: string
unit_bbox_param:
name: bbox
in: query
style: form
explode: false
description: Search for events that are within this bounding box. Decimal coordinates
are given in order west, south, east, north. Period is used as decimal
separator.
schema:
type: array
items:
type: number
example: 24.9405559,60.1695096,24.9805559,60.1895096
geometry_param:
name: geometry
in: query
description: If parameter value is either true or 1, return the complex geometry
of the unit in the field "geometry". Most units only have point type
geometries, which are returned in the location field. Some however
have polygon type geometries, eg. skiing tracks or outdoor areas.
These complex geometries must be explicitly requested with this
parameter.
schema:
oneOf:
- type: boolean
example: true
- type: integer
example: 1
example: true
schemas:
unit:
type: object
title: Unit
description: Units are physical locations where organizations provide services for
patrons. Please note that the observations field is only displayed in the unit
endpoint if "observations" is supplied as a value to the "include" parameter.
required:
- id
- name
- last_modified_time
- service_nodes
- services
allOf:
- $ref: "#/components/schemas/common_single"
- properties:
id:
description: The primary, unique and persistent identifier of the unit
type: integer
name:
description: The name of the unit [multilingual]
type: object
location:
type: object
properties:
type:
type: string
description: Currently always \"Point\"
coordinates:
type: array
description: The unit\'s coordinates in WGS84.
items:
type: number
description: a coordinate
services:
$ref: "#/components/schemas/service"
service_nodes:
$ref: "#/components/schemas/service_node"
root_service_nodes:
type: array
description: The unique roots of the service node hierarchy for this unit\'s
service nodes, as integer identifiers
items:
type: integer
street_address:
description: The first part of the street address, containing the street name
and building number. This address should be used for locating
the unit geographically, not for sending mail.
type: string
address_zip:
description: The postal code for the street address
type: string
municipality:
type: integer
description: The municipality in which the unit is located
address_postal_full:
description: The full postal address, which should be used for sending mail,
not for locating the unit.
type: string
email:
description: The main email address
type: string
phone:
description: The phone number or numbers for contacting the unit
type: string
call_charge_info:
description: Information about the fees accumulated when calling the unit
type: string
fax:
description: The fax number
type: string
www:
description: The main home page, or the most relevant site available for the
unit
type: string
description:
type: string
description: A textual description of the unit, provided for the end user
short_description:
type: string
description: A rarely used field containing a shorter description of the unit
connections:
type: array
items:
$ref: "#/components/schemas/unit_connection"