This repository has been archived by the owner on Sep 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathopenapi.json
1256 lines (1255 loc) · 51.6 KB
/
openapi.json
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.3",
"info": {
"title": "AuroraAI core components API",
"description": "API endpoints implemented by AuroraAI core components",
"version": "0.0.1",
"contact": {
"name": "AuroraAI core components",
"url": "https://auroraai.fi",
"email": "auroraai@suomi.fi"
}
},
"servers": [
{
"url": "/",
"description": "AuroraAI core components"
}
],
"paths": {
"/service-recommender/v1/recommend_service": {
"post": {
"summary": "Ask for service recommendations",
"operationId": "post-recommend_service",
"description": "Recommend services from PTV based on users input on 3X10D life situation meters. Recommendation results can be limited by filters specified in service_filters field. If all filter types are used, result set includes services that belong to ANY of the specified geographic areas AND to ANY of the specified service classes. For details on life situation meters see https://www.diak.fi/tyoelamapalvelut/kehittamistyokalut/3x10d/",
"requestBody": {
"content": {
"application/json": {
"example": {
"life_situation_meters": {
"family": [
8
],
"finance": [
9
],
"friends": [
3
],
"health": [
2
],
"housing": [
9
],
"improvement_of_strengths": [
5
],
"life_satisfaction": [
6
],
"resilience": [
7
],
"self_esteem": [
10
],
"working_studying": [
1
]
},
"service_filters": {
"only_national_services": false,
"include_national_services": false,
"municipality_codes": [
"091",
"638"
],
"region_codes": [
"02",
"19"
],
"hospital_district_codes": [
"04",
"12"
],
"service_classes": [
"http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P1.2",
"http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P25.3"
],
"target_groups": [
"KR1"
],
"service_collections": [
"744c4b61-fde5-4d23-a844-cee5728b9119"
],
"funding_type": ["PubliclyFunded"],
"wellbeing_service_county_codes": [
"02",
"03"
]
},
"limit": 5,
"rerank": true,
"session_id": "xyz-123"
},
"schema": {
"$ref": "#/components/schemas/RecommendServiceInput"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"auroraai_recommendation_id": 93,
"recommended_services": [
{
"charge_additional_info": "",
"charge_type": "",
"requirements": [],
"service_channels": [
{
"service_name": "Paikallismuseoiden neuvonta",
"address": "Pohjoisranta 4, 96200, Rovaniemi",
"emails": [],
"phone_numbers": [],
"service_channel_description_summary": "Alueellinen vastuumuseo",
"service_channel_id": "1d50cfb5-04f8-410a-83de-ff6208ac6b26",
"service_channel_name": "Lapin maakuntamuseo",
"service_channel_type": "ServiceLocation",
"service_hours": [
"Tuesday 08:00:00 - 16:00:00, Wednesday 08:00:00 - 16:00:00, Thursday 08:00:00 - 16:00:00"
],
"location": {
"latitude": "00.00",
"longitude": "00.00"
},
"session_transfer": false,
"web_pages": [
"https://www.rovaniemi.fi/Vapaa-aika/Kulttuuriyksikot-ja-museot"
]
}
],
"service_description": "Neuvomme museokokoelmien tallentamiseen, luettelointiin ja säilyttämiseen, näyttelyiden suunnitteluun ja toteutukseen sekä museorakennusten kunnostamiseen liittyvissä asioissa. Paikallismuseot voivat hakea näihin tehtäviin Museovirastolta harkinnanvaraista avustusta. Neuvontaa annetaan myös yksityishenkilöiden omistamien kokoelmien hoitamiseen. \\n\\nMaakuntamuseo järjestää vuosittain museotapaamisen, jossa käsitellään museotyön ajankohtaisia asioita sekä kuullaan asiantuntijaluentoja. Tapaamisia on järjestetty eri paikkakunnilla ja samalla on päästy tutustumaan erilaisiin museokohteisiin.\\n\\nPaikallismuseoille tiedotetaan ajankohtaisista asioista sähköpostitse. ",
"service_description_summary": "Lapin maakuntamuseo ohjaa ja neuvoo kuntien, yhdistysten ja säätiöiden omistamia ja yksityisiä museoita sekä edistää näiden välistä yhteistyötä.",
"user_instruction": "Voit kysyä museosta sen toimialueen paikallismuseoista ja niiden kokoelmista. Alueen paikallismuseot voivat pyytää neuvoja ja ohjausta museonhoitoon liittyen. Ota yhteyttä neuvontatyötä tekevään amanuenssiin. ",
"service_id": "42346c30-58ef-48f5-8c10-0cef5681652b",
"service_name": "Lapin maakuntamuseon neuvontatyö paikallismuseoille",
"responsible_organization": {
"id": "38899ac0-9efe-425a-978e-f873c4819df9",
"name": "Rovaniemen kaupunki"
},
"funding_type": "PubliclyFunded",
"area_type": "LimitedType",
"areas": [
{
"code": "19",
"municipalities": [
{
"code": "698",
"name": [
{
"language": "sv",
"value": "Rovaniemi"
},
{
"language": "en",
"value": "Rovaniemi"
},
{
"language": "fi",
"value": "Rovaniemi"
}
]
},
{
"code": "890",
"name": [
{
"language": "sv",
"value": "Utsjoki"
},
{
"language": "en",
"value": "Utsjoki"
},
{
"language": "fi",
"value": "Utsjoki"
}
]
}
],
"name": [
{
"language": "sv",
"value": "Lappland"
},
{
"language": "en",
"value": "Lapland"
},
{
"language": "fi",
"value": "Lappi"
}
],
"type": "Region"
}
],
"similarity_score": 2.89905107,
"rank": 1,
"service_class_uris": [
"http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P25.3"
]
}
]
},
"schema": {
"$ref": "#/components/schemas/RecommendServiceOutput"
}
}
},
"description": "Success"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"basic_client_id_client_secret": []
}
],
"tags": [
"Service recommendation"
]
}
},
"/service-recommender/v1/text_search": {
"post": {
"summary": "Search services by freeform text.",
"operationId": "post-term-search",
"description": "Compares the input text against service descriptions in PTV and returns the most relevant services. Note that the example below displays application of available service filters, which may be too numerous to produce results. In that case, try removing all or some of the filters.",
"requestBody": {
"content": {
"application/json": {
"example": {
"search_text": "nuorten työttömyys",
"service_filters": {
"only_national_services": false,
"include_national_services": true,
"municipality_codes": [
"091",
"638"
],
"region_codes": [
"02",
"19"
],
"hospital_district_codes": [
"04",
"12"
],
"service_classes": [
"http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P1.2",
"http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P19"
],
"target_groups": [
"KR1"
],
"service_collections": [
"744c4b61-fde5-4d23-a844-cee5728b9119"
],
"funding_type": [ "PubliclyFunded" ],
"wellbeing_service_county_codes": [
"02",
"03"
]
},
"limit": 5,
"rerank": true
},
"schema": {
"$ref": "#/components/schemas/TextSearchInput"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"recommended_services": [
{
"charge_additional_info": "",
"charge_type": "FreeOfCharge",
"requirements": [
"Hätätekstiviestin voi lähettää vain sellaisesta puhelinnumerosta, mikä on rekisteröity etukäteen. Ennakkorekisteröinti tehdään suomi.fi-sivustolla."
],
"service_channels": [
{
"address": "",
"emails": [],
"phone_numbers": [
"112",
"112",
"112"
],
"service_channel_description_summary": "Suomessa on käytössä vain yksi hätänumero, 112. \nHätänumeroon 112 tulee soittaa aina kiireellisissä, todellisissa hätätilanteissa.",
"service_channel_id": "c7cad442-1820-4854-8d40-48536e6d7fcd",
"service_channel_name": "Hätänumero 112",
"service_channel_type": "Phone",
"service_hours": [
"Aina avoinna"
],
"location": {
"latitude": "00.00",
"longitude": "00.00"
},
"web_pages": []
},
{
"address": "",
"emails": [],
"phone_numbers": [],
"service_channel_description_summary": "Hätäilmoituksen voi tehdä tekstiviestillä hätänumeroon 112.",
"service_channel_id": "8419a556-b19b-40c2-b7a3-03c36399ce5c",
"service_channel_name": "Hätätekstiviesti numeroon 112",
"service_channel_type": "Phone",
"service_hours": [
"Aina avoinna"
],
"location": {
"latitude": "00.00",
"longitude": "00.00"
},
"web_pages": []
}
],
"service_description": "HÄTÄNUMERO 112\\nSuomessa on käytössä vain yksi hätänumero, 112. Hätänumeroon 112 tulee soittaa aina kiireellisissä, todellisissa hätätilanteissa hengen, terveyden, omaisuuden tai ympäristön ollessa uhattuna tai vaarassa, tai jos on syytä epäillä näin olevan. Hätäilmoituksen voi tarvittaessa tehdä tekstiviestillä hätänumeroon 112.",
"service_description_summary": "Suomessa on käytössä vain yksi hätänumero, 112. Hätänumeroon 112 tulee soittaa aina kiireellisissä, todellisissa hätätilanteissa.",
"user_instruction": "Milloin soitat 112?\n* Kun kohtaat hätätilanteen tai tarvitset kiireellisesti viranomaisapua paikalle.\n* Kun tiedät tai epäilet hengen, terveyden, omaisuuden tai ympäristön ollessa uhattuna tai vaarassa.",
"service_id": "01a571b5-3eb9-4b49-a27e-ec8427737c5b",
"area_type": "NationwideExceptAlandIslands",
"areas": [],
"service_name": "Hätäilmoituksen tekeminen",
"responsible_organization": {
"id": "eb46ae8b-e9cb-4f61-b393-811809da7856",
"name": "Hätäkeskuslaitos"
},
"funding_type": "PubliclyFunded",
"service_class_uris": [
"http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P19",
"http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P19.3"
],
"similarity_score": 1.0,
"rank": 1
}
]
},
"schema": {
"$ref": "#/components/schemas/TextSearchOutput"
}
}
},
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Endpoint disabled in the specific environment"
}
},
"security": [
{
"basic_client_id_client_secret": []
}
],
"tags": [
"Service recommendation"
]
}
},
"/service-recommender/v1/recommendation_feedback": {
"post": {
"summary": "Give feedback for a recommendation",
"operationId": "post-recommendation_feedback",
"description": "Provide feedback to given service recommendations",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecommendationFeedback"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "call successful"
}
},
"security": [
{
"basic_client_id_client_secret": []
}
],
"tags": [
"Service recommendation"
]
}
},
"/service-recommender/v1/session_attributes": {
"post": {
"summary": "Send session attributes to a recommended service",
"operationId": "post-session_attributes",
"description": "Send session attributes to make a session transfer to recommended service",
"requestBody": {
"content": {
"application/json": {
"example": {
"service_channel_id": "5894b8d5-a7be-47f2-8474-8f476a933e94",
"service_id": "07058248-f002-4897-b1d5-7df9aa734c55",
"auroraai_recommendation_id": 123,
"session_attributes": {
"age": 20,
"life_situation_meters": {
"family": [
8
],
"finance": [
9
],
"friends": [
3
],
"health": [
2
],
"housing": [
9
],
"improvement_of_strengths": [
5
],
"life_satisfaction": [
6
],
"resilience": [
7
],
"self_esteem": [
10
],
"working_studying": [
1
]
},
"municipality_code": "049"
}
},
"schema": {
"$ref": "#/components/schemas/PostSessionAttributesInput"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"text/html": {
"example": "https://example.com/?auroraai_access_token=b96e485b8d37dc7762df04b0ebb8a7cc67e4f456c9104b71f547ab2d6b8c6975"
}
},
"description": "Success"
},
"400": {
"description": "Bad Request"
}
},
"security": [
{
"basic_client_id_client_secret": []
}
],
"tags": [
"Service recommendation"
]
},
"get": {
"summary": "Get session attributes",
"operationId": "get-session_attributes",
"description": "Get session attributes that were stored when recommendations were asked",
"parameters": [
{
"name": "access_token",
"description": "Token that grants access to the session attributes",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"life_situation_meters": {
"family": [
8
],
"finance": [
9
],
"friends": [
3
],
"health": [
2
],
"housing": [
9
],
"improvement_of_strengths": [
5
],
"life_satisfaction": [
6
],
"resilience": [
7
],
"self_esteem": [
10
],
"working_studying": [
1
]
},
"municipality_code": "091",
"age": 20
},
"schema": {
"$ref": "#/components/schemas/UserAttributeValues"
}
}
},
"description": "Success"
},
"400": {
"description": "Bad Request"
}
},
"tags": [
"Service recommendation"
]
}
},
"/service-recommender/v1/translation/search_text": {
"post": {
"summary": "Experimental: Get a Finnish translation of a foreign language text.",
"operationId": "post-translation-search-text",
"description": "This endpoint can be used to translate a foreign language search query to Finnish. The Finnish translation can then be used in /text_search endpoint. Currently not available in production.",
"requestBody": {
"content": {
"application/json": {
"example": {
"search_text": "youth unemployment",
"source_language": "en"
},
"schema": {
"properties": {
"search_text": {
"type": "string",
"description": "The search query to be translated."
},
"source_language": {
"type": "string",
"description": "Language code indicating the source language for translation."
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"search_text": "nuorisotyöttömyys",
"target_language": "fi"
},
"schema": {
"properties": {
"search_text": {
"type": "string",
"description": "Translated text"
},
"target_language": {
"type": "string",
"description": "Target language code (always fi)"
}
}
}
}
},
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Endpoint disabled in the specific environment"
}
},
"security": [
{
"basic_client_id_client_secret": []
}
],
"tags": [
"Service recommendation"
]
}
},
"/service-recommender/v1/translation/ptv_service": {
"post": {
"summary": "Experimental: Partially translate Finnish PTV data of a service to a foreign language.",
"operationId": "post-translation-ptv-service",
"description": "This endpoint can be used to translate a PTV service's name, summary and description from Finnish to the selected language. Also service channel names and descriptions are translated. If PTV-data is available in the target-language that will be used, otherwise the data is machine-translated. Currently this endpoint is not available in production.",
"requestBody": {
"content": {
"application/json": {
"example": {
"service_id": "01a571b5-3eb9-4b49-a27e-ec8427737c5b",
"target_language": "de"
},
"schema": {
"properties": {
"service_id": {
"type": "string",
"format": "uuid",
"description": "PTV id of the service."
},
"target_language": {
"type": "string",
"description": "Language code for the translation target language."
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"target_language": "de",
"service": {
"service_id": "01a571b5-3eb9-4b49-a27e-ec8427737c5b",
"service_name": "Eine Notfallerklärung abgeben",
"service_name_orig": "Hätäilmoituksen tekeminen",
"service_description": "NOTRUF NUMMER 112\nIn Finnland wird nur eine Notrufnummer verwendet, 112. Die Notrufnummer 112 sollte in dringenden, realen Notfällen jederzeit angerufen werden, wenn Leben, Gesundheit, Eigentum oder Umwelt bedroht oder gefährdet sind oder wenn Grund zu der Annahme besteht, dass dies der Fall ist. Bei Bedarf kann eine Notfallerklärung per SMS an die Notrufnummer 112 abgegeben werden. ",
"service_description_orig": "HÄTÄNUMERO 112\nSuomessa on käytössä vain yksi hätänumero, 112. Hätänumeroon 112 tulee soittaa aina kiireellisissä, todellisissa hätätilanteissa hengen, terveyden, omaisuuden tai ympäristön ollessa uhattuna tai vaarassa, tai jos on syytä epäillä näin olevan. Hätäilmoituksen voi tarvittaessa tehdä tekstiviestillä hätänumeroon 112.",
"service_description_summary": "In Finnland gibt es nur eine Notrufnummer, 112. Die Notrufnummer 112 sollte in dringenden, echten Notfällen jederzeit angerufen werden. ",
"service_description_summary_orig": "Suomessa on käytössä vain yksi hätänumero, 112. Hätänumeroon 112 tulee soittaa aina kiireellisissä, todellisissa hätätilanteissa.",
"machine_translated": true,
"service_channels": [
{
"service_channel_id": "c7cad442-1820-4854-8d40-48536e6d7fcd",
"service_channel_name": "Notrufnummer 112",
"service_channel_name_orig": "Hätänumero 112",
"service_channel_description": "Rufen Sie in dringenden Fällen 112 an\n\nDie Notrufnummer 112 sollte in dringenden, realen Notfällen jederzeit angerufen werden, wenn Leben, Gesundheit, Eigentum oder Umwelt bedroht oder gefährdet sind oder wenn Grund zu der Annahme besteht, dass dies der Fall ist.\n\nWenn Sie 911 112 anrufen:\n• Beantworten Sie Fragen\n• gemäß den gegebenen Anweisungen handeln\n• Beenden Sie den Anruf nur, wenn Sie Ihre Berechtigung erhalten haben",
"service_channel_description_orig": "Kiireellisessä tilanteessa soita 112\n\nHätänumeroon 112 tulee soittaa aina kiireellisissä, todellisissa hätätilanteissa hengen, terveyden, omaisuuden tai ympäristön ollessa uhattuna tai vaarassa, tai jos on syytä epäillä näin olevan.\n\nKun soitat hätänumeroon 112:\n• vastaa kysymyksiin\n• toimi annettujen ohjeiden mukaisesti\n• lopeta puhelu vasta, kun saat luvan",
"service_channel_description_summary": "In Finnland gibt es nur eine Notrufnummer, 112. \nDie Notrufnummer 112 sollte in dringenden, echten Notfällen jederzeit angerufen werden. ",
"service_channel_description_summary_orig": "Suomessa on käytössä vain yksi hätänumero, 112. \nHätänumeroon 112 tulee soittaa aina kiireellisissä, todellisissa hätätilanteissa.",
"service_channel_type": "Phone",
"service_hours": [
"Aina avoinna"
],
"address": "",
"emails": [],
"location": "",
"phone_numbers": [
"112",
"112",
"112"
],
"web_pages": []
},
{
"address": "",
"emails": [],
"location": "",
"phone_numbers": [],
"service_channel_description": "Eine Notfallbenachrichtigung per SMS machen\n\nDie Verwendung von Notfall-Textnachrichten richtet sich in erster Linie an Personen, die Sprache nicht hören oder produzieren können. \n\nIm Notfall sollten Sie nach Möglichkeit immer die 112 anrufen. Telefonieren ist eine technisch sicherere Option als SMS, da es bei Textnachrichten beispielsweise zu Verzögerungen bei der Weiterleitung kommen kann oder der Telefonspeicher voll ist.\n\nDer 911-Notfallhelfer fragt den Empfänger in Notfall-Textnachrichten nach denselben grundlegenden Informationen wie bei einem Notruf und führt eine gesetzlich vorgeschriebene Risikobewertung für die Weiterleitung von Unterstützung durch. Es lohnt sich, schnelle Hilfe zu gewährleisten, indem Sie bereits in der ersten Nachricht so viele Informationen wie möglich senden. \n\nNach der ersten Nachricht fragt der Notfallzentrale nach den erforderlichen zusätzlichen Informationen.\n",
"service_channel_description_orig": "Hätäilmoituksen tekeminen tekstiviestillä\n\nHätätekstiviestien käyttö on suunnattu ensisijaisesti henkilöille, jotka eivät kuule tai pysty tuottamaan puhetta. \n\nHätätilanteessa 112:een kannattaa aina soittaa, jos se on mahdollista. Soitto on teknisesti varmempi vaihtoehto kuin tekstiviesti, sillä tekstiviesteissä voi esimerkiksi esiintyä välitysviiveitä tai puhelimen muisti voi olla täynnä.\n\nHätäkeskuspäivystäjä kysyy avuntarvitsijalta samat perustiedot hätätekstiviesteissä kuin hätäpuhelun aikana ja tekee lain mukaisen riskinarvion avun välittämisestä. Nopea avun saaminen kannattaa varmistaa lähettämällä mahdollisimman paljon tietoa jo ensimmäisessä viestissä. \n\nEnsimmäisen viestin jälkeen hätäkeskuspäivystäjä kysyy tarvittavia lisätietoja.\n",
"service_channel_description_summary": "Notfallbenachrichtigung kann per SMS an 911 112 erfolgen. ",
"service_channel_description_summary_orig": "Hätäilmoituksen voi tehdä tekstiviestillä hätänumeroon 112.",
"service_channel_id": "8419a556-b19b-40c2-b7a3-03c36399ce5c",
"service_channel_name": "Notfall-SMS an 112",
"service_channel_name_orig": "Hätätekstiviesti numeroon 112",
"service_channel_type": "Phone",
"service_hours": [
"Aina avoinna"
],
"web_pages": []
}
],
"area_type": "NationwideExceptAlandIslands",
"areas": [],
"charge_additional_info": "",
"charge_type": "FreeOfCharge",
"requirements": [
"Hätätekstiviestin voi lähettää vain..."
],
"responsible_organization": {
"id": "eb46ae8b-e9cb-4f61-b393-811809da7856",
"name": "Hätäkeskuslaitos"
},
"service_class_uris": [
"http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P19",
"http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P19.3"
],
"service_collections": [],
"target_groups": [
"KR1"
],
"user_instruction": "Milloin soitat 112?\n* Kun kohtaat..."
}
},
"schema": {
"properties": {
"service": {
"description": "Service data from PTV where selected fields are translated. The schema shows only fields that differ from the recommendation API response format.",
"properties": {
"service_channels": {
"type": "array",
"items": {
"properties": {
"service_channel_name": {"type": "string", "description": "Translated channel name."},
"service_channel_name_orig": {"type": "string", "description": "Original channel name."},
"service_channel_description": {"type": "string", "description": "Translated description."},
"service_channel_description_orig": {"type": "string", "description": "Original description."},
"service_channel_description_summary": {"type": "string", "description": "Translated summary."},
"service_channel_description_summary_orig": {"type": "string", "description": "Original summary"}
}
}
},
"service_name": {"type": "string", "description": "Translated service name."},
"service_name_orig": {"type": "string", "description": "Original service name."},
"service_description": {"type": "string", "description": "Translated description."},
"service_description_orig": {"type": "string", "description": "Original description."},
"service_description_summary": {"type": "string", "description": "Translated summary."},
"service_description_summary_orig": {"type": "string", "description": "Original summary."},
"machine_translated": {
"type": "boolean",
"description": "False if the service's PTV data was available in the given language. True if machine translation was used."
}
}
},
"target_language": {
"type": "string",
"description": "Language code of the translation target language."
}
}
}
}
},
"description": "Success"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Endpoint disabled in the specific environment"
}
},
"security": [
{
"basic_client_id_client_secret": []
}
],
"tags": [
"Service recommendation"
]
}
}
},
"components": {
"schemas": {
"TextSearchInput": {
"properties": {
"search_text": {
"description": "Text to search for",
"example": "nuorten työttömyys",
"type": "string"
},
"service_filters": {
"$ref": "#/components/schemas/ServiceFilters"
},
"limit": {
"type": "integer",
"example": 5,
"minimum": 1,
"maximum": 50,
"default": 5
},
"rerank": {
"description": "Setting this value to true reranks recommendations based on feedback from users. Set to false returns values in decreasing order of similarity. See the schema for TextSearchOutput.",
"type": "boolean",
"example": false,
"default": false
}
},
"required": [
"search_text"
],
"type": "object"
},
"TextSearchOutput": {
"properties": {
"recommended_services": {
"description": "List of recommended services.",
"items": {
"$ref": "#/components/schemas/RecommendedService"
},
"type": "array"
}
},
"required": [
"auroraai_recommendation_id",
"recommended_services"
],
"type": "object"
},
"RecommendServiceInput": {
"properties": {
"life_situation_meters": {
"$ref": "attributes.json#/properties/life_situation_meters"
},
"limit": {
"description": "Number of recommended services to return. Defaults to 5.",
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"rerank": {
"description": "Setting this value to true reranks recommendations based on feedback from users. Set to false returns values in decreasing order of similarity. See the schema for RecommendServiceOutput.",
"type": "boolean",
"example": false,
"default": false
},
"service_filters": {
"$ref": "#/components/schemas/ServiceFilters"
},
"session_id": {
"description": "ID of the session",
"type": "string"
}
},
"required": [
"life_situation_meters"
],
"type": "object"
},
"UserAttributeValues": {
"$ref": "attributes.json"
},
"UserAttributeNames": {
"type": "object",
"properties": {
"user_id": {
"description": "ID of the user whose the listed attributes are",
"type": "string"
},
"user_attributes": {
"$ref": "#/components/schemas/AttributeNames"
}
},
"required": [
"user_id",
"user_attributes"
]
},
"PostSessionAttributesInput": {
"properties": {
"service_channel_id": {
"description": "Service channel id from PTV to which service send the attributes",
"type": "string"
},
"service_id": {
"description": "Optional. PTV service-id to define the session transfer target service. If the recommendation_id property is provided, then the service_id must be provided also.",
"type": "string"
},
"auroraai_recommendation_id": {
"description": "Optional. AuroraAI recommendation-id to define the recommendation query used to acquire the target service. If the recommendation_id property is provided, then the session-transfer link is returned as an AuroraAI redirect link to collect recommendation data. The service_id property must be provided with the recommendation_id.",
"type": "integer"
},
"session_attributes": {
"allOf": [
{
"$ref": "#/components/schemas/UserAttributeValues"
}
],
"description": "Attributes to send"
}
},
"required": [
"service_channel_id",
"session_attributes"
],
"type": "object"
},
"RecommendServiceOutput": {
"properties": {
"auroraai_recommendation_id": {
"description": "Id to identify individual recommendation given by Aurora AI. This should be used when giving feedback on recommendations on service feedback endpoint.",
"type": "integer"
},
"recommended_services": {
"description": "List of recommended services.",
"items": {
"$ref": "#/components/schemas/RecommendedService"
},
"type": "array"
}
},
"required": [
"auroraai_recommendation_id",
"recommended_services"
],
"type": "object"
},
"RecommendationFeedback": {
"properties": {
"auroraai_recommendation_id": {
"description": "Id to identify individual recommendation given by Aurora AI",
"type": "integer"
},
"feedback_score": {
"description": "Overall feedback from given recommendations. +1 for positive feedback, -1 for negative feedback",
"type": "integer",
"enum": [
-1,
1
]
},
"service_feedbacks": {
"description": "Feedbacks from individual services as recommendation",
"items": {
"$ref": "#/components/schemas/ServiceFeedback"
},
"type": "array"
}
},
"required": [
"auroraai_recommendation_id"
],
"type": "object"
},
"RecommendedService": {
"properties": {
"service_channels": {
"description": "Information about service channels for the service",
"items": {
"$ref": "#/components/schemas/ServiceChannel"
},
"type": "array"
},
"service_id": {
"description": "ID of the service in PTV.",
"type": "string"
},
"service_name": {
"description": "Name of the serivce.",
"type": "string"
},
"service_description": {
"description": "Full description of the service.",
"type": "string"
},
"service_description_summary": {
"description": "Short description of the service.",
"type": "string"
},
"user_instruction": {
"description": "Brief instructions for the usage of the service.",
"type": "string"
},
"responsible_organization": {
"properties": {
"name": {
"type": "string"