Esteettömyyssovelluksen rajapintaohje
Interface reference
Accessibility register
Sisällysluettelo
REST API: CLIENT DATA, MASSIVE QUERIES
WEB APPLICATION: URL INTERFACES
REST API: SYSTEM DATA
Get accessibility variables
| Get list of all accessibility variables | |
| URL | GET /api/v1/accessibility/variables |
| Parameters | |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/variables |
| Response sample (200 OK) | [ { ”variableId ”: 0, ”variableName ”: ”OUTSIDE.ACCESSIBLE_PARKING_SPACE.shared_parking_with_main_entrance”, ”values”: [ ”true”, ”false” ] }, { ”id”: 1, ”name”: ”OUTSIDE.ACCESSIBLE_PARKING_SPACE.count”, ”values”: [ ”0”, ”1”, ”2”, ”3”, ”4”, ”5”, ”6”, ”7”, ”8”, ”9”, ”10”, ”more_than_10” ] }, { ”variableId ”: 2, ”variableName”: ”OUTSIDE.ACCESSIBLE_PARKING_SPACE.location”, ”values”: [ ”outdoors”, ”canopy”, ”parking_hall”, ”separate_parking_hall”, ”along_street” ] }, >> rest of the response is omitted << ] |
Get accessibility viewpoints
| Get list of all accessibility viewpoints | |
| URL | GET /api/v1/accessibility/viewpoints |
| Parameters | |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/viewpoints |
| Response sample (200 OK) | [ { ”viewpointId ”: 11, ”names”: [ { ”language”: ”fi”, ”value”: ”Olen pyörätuolin käyttäjä” }, { ”language”: ”sv”, ”value”: ”Jag är en rullstolsanvändare” }, { ”language”: ”en”, ”value”: ”I am a wheelchair user” } ], ”values”: [ ”unknown”, ”green”, ”red” ], ”viewPointOrderText ”: ”11” }, { ”viewpointId”: 12, ”names”: [ { ”language”: ”fi”, ”value”: ”Olen pyörätuolin käyttäjä – saavun omalla autolla” }, { ”language”: ”sv”, ”value”: ”Jag är en rullstolsanvändare – kommer med min egen bil” }, { ”language”: ”en”, ”value”: ”I am a wheelchair user – arrive by my car” } ], ”values”: [ ”unknown”, ”green”, ”red” ], ”viewPointOrderText ”: ”12” }, >> rest of the response is omitted << ] |
Get accessibility requirements
| Get list of accessibility requirements | |
| URL | GET /api/v1/accessibility/requirements |
| Parameters | |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/requirements |
| Response sample (200 OK) | [ { ”requirementId”: 1, ”requirementText”: ”Toimipisteen edessä pitää olla vähintään yksi leveä esteetön autopaikka.”, ”isIndoorRequirement”: ”Y”, ”evaluationZone”: ”outsideServicePoint” }, { ”requirementId”: 2, ”requirementText”: ”Ulkoliikuntapaikan lähettyvillä pitää olla vähintään yksi leveä esteetön autopaikka.”, ”isIndoorRequirement”: ”N”, ”evaluationZone”: ”outsideServicePoint” }, { ”requirementId”: 3, ”requirementText”: ”Saattoliikenteen pysähtymispaikka pitää olla lähellä sisäänkäyntiä (etäisyys enintään 5 m).”, ”isIndoorRequirement”: ”Y”, ”evaluationZone”: ”outsideServicePoint” }, >> rest of the response is omitted << ][ { ”requirementId”: 1, ”requirementText”: ”Toimipisteen edessä pitää olla vähintään yksi leveä esteetön autopaikka.”, ”isIndoorRequirement”: ”Y”, ”evaluationZone”: ”outsideServicePoint” }, { ”requirementId”: 2, ”requirementText”: ”Ulkoliikuntapaikan lähettyvillä pitää olla vähintään yksi leveä esteetön autopaikka.”, ”isIndoorRequirement”: ”N”, ”evaluationZone”: ”outsideServicePoint” }, { ”requirementId”: 3, ”requirementText”: ”Saattoliikenteen pysähtymispaikka pitää olla lähellä sisäänkäyntiä (etäisyys enintään 5 m).”, ”isIndoorRequirement”: ”Y”, ”evaluationZone”: ”outsideServicePoint” }, >> rest of the response is omitted << ] |
Get accessibility places
| Get list of all accessibility places | |
| URL | GET /api/v1/accessibility/places |
| Parameters | |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/places |
| Response sample (200 OK) | [ { ”placeId”: 1, ”names”: [ { ”language”: ”fi”, ”value”: ”Pysäköintialue” }, { ”language”: ”sv”, ”value”: ”Parkeringsområdet” }, { ”language”: ”en”, ”value”: ”Parking area” } ], ”descriptions”: [], ”placeOrderText”: ”001” }, { ”placeId”: 2, ”names”: [ { ”language”: ”fi”, ”value”: ”Esteettömät autopaikat” }, { ”language”: ”sv”, ”value”: ”Bilplatserna för rörelsehindrade” }, { ”language”: ”en”, ”value”: ”Accessible parking spaces” } ], ”descriptions”: [], ”placeOrderText”: ”002” }, >> rest of the response is omitted << ] |
Get questionnaire
| Get contents of all separate multiple-choice questionnaires | |
| URL | GET /api/v1/accessibility/questionnaire |
| Parameters | |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/questionnaire |
| Response sample (200 OK) | [ { ”id”: 0, ”orderText”: ”00000000b”, ”structureCode”: null, ”color”: ”brown big”, ”contents”: [ { ”language”: ”fi”, ”value”: ”TOIMIPISTEIDEN KYSYMYKSET” } ] }, { ”id”: 0, ”orderText”: ”00000000c”, ”structureCode”: ”0”, ”color”: ”black big”, ”contents”: [ { ”language”: ”fi”, ”value”: ”Aloita tästä: toimipisteen tyyppi ja esteettömyyden yhteystiedot” }, { ”language”: ”sv”, ”value”: ”Börja här: typ av versamhetsställe och tillgänglighetskontaktinformation” }, { ”language”: ”en”, ”value”: ”Start here: service point type and accessibility contact information” } ] }, { ”id”: 801, ”orderText”: ”00010000e”, ”structureCode”: ”0.1”, ”color”: ”black”, ”contents”: [ { ”language”: ”fi”, ”value”: ”Tapahtuuko toimipisteen toiminta sisä- vai ulkotiloissa?” }, { ”language”: ”sv”, ”value”: ”Drivs verksamheten inomhus eller utomhus?” }, { ”language”: ”en”, ”value”: ”Does the activity of the facility take place indoors or outdoors?” } ] }, >> rest of the response is omitted << ] |
Get forms
| Get list of forms (in the accessibility application, a form contains question blocks that contain questions, which contain choices) | |
| URL | GET /api/v1/accessibility/forms |
| Parameters | |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/forms |
| Response sample (200 OK) | [ { ”formId”: 0, ”titles”: [ { ”language”: ”fi”, ”value”: ”Pääsisäänkäynti” }, { ”language”: ”sv”, ”value”: ”Huvudingång” }, { ”language”: ”en”, ”value”: ”Main entrance” } ], ”descriptions”: [ { ”language”: ”fi”, ”value”: ”Esteettömyyssovelluksen tarkoituksena on kerätä toimipisteiden esteettömyydestä perustietoa yhdenmukaisin kysymyksin ja kriteerein.” }, { ”language”: ”sv”, ”value”: ”Syftet med tillgänglighetsapplikationen är att samla in grundläggande information om verksamhetsställenas tillgänglighet genom standardiserade frågor och kriterier.” }, { ”language”: ”en”, ”value”: ”The purpose of the accessibility application is to gather basic information on the accessibility of facilities using standard questions and criteria.” } ] }, >> rest of the response is omitted << ] |
Get question blocks
| Get list of question blocks (in the accessibility application, a form contains question blocks that contain questions, which contain choices) | |
| URL | GET /api/v1/accessibility/questionblocks |
| Parameters | |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/questionblocks |
| Response sample (200 OK) | [ { ”questionBlockId”: 0, ”formId”: 0, ”questionBlockCode”: ”0”, ”questionBlocks”: [ { ”language”: ”fi”, ”value”: ”Aloita tästä: toimipisteen tyyppi ja esteettömyyden yhteystiedot?” }, { ”language”: ”sv”, ”value”: ”Börja här: typ av versamhetsställe och tillgänglighetskontaktinformation?” }, { ”language”: ”en”, ”value”: ”Start here: service point type and accessibility contact information?” } ], ”questionBlockOrderText”: ”00”, ”descriptions”: [ { ”language”: ”fi”, ”value”: ”Valitse ensin toimipisteen tapahtumapaikka, muut kysymykset riippuvat tästä valinnasta. Jokaiseen avautuvaan kysymykseen täytyy vastata ellei toisin mainita. Vastausten perusteella muodostuu esteettömyyslauseet suomeksi, ruotsiksi ja englanniksi.” }, { ”language”: ”sv”, ”value”: ”Välj först platsen för verksamheten, andra frågor beror på detta val. Varje öppen fråga ska besvaras om inget annat anges. Utifrån svaren bildas tillgänglighetsmeningar på finska, svenska och engelska.” }, { ”language”: ”en”, ”value”: ”First choose the venue of the place, other questions depend on this choice. Every open question must be answered unless otherwise mentioned. Accessibility sentences are formed based on the answers in Finnish, Swedish and English.” } ] ”photoUrl”: null, ”photoTexts”: [] }, >> rest of the response is omitted << ] |
Get questions
| Get list of questions (in the accessibility application, a form contains question blocks that contain questions, which contain choices) | |
| URL | GET /api/v1/accessibility/questions |
| Parameters | |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/questions |
| Response sample (200 OK) | [ { ”questionId”: 801, ”formId”: 0, ”questionBlockId”: 0, ”questionCode”: ”0.1”, ”questions”: [ { ”language”: ”fi”, ”value”: ”Tapahtuuko toimipisteen toiminta sisä- vai ulkotiloissa?” }, { ”language”: ”sv”, ”value”: ”Drivs verksamheten inomhus eller utomhus?” }, { ”language”: ”en”, ”value”: ”Does the activity of the facility take place indoors or outdoors?” } ], ”questionOrderText”: ”0001”, ”descriptions”: [], ”photoUrl”: null, ”photoTexts”: [] }, >> rest of the response is omitted << ] |
Get choices
| Get list of choices (in the accessibility application, a form contains question blocks that contain questions, which contain choices) | |
| URL | GET /api/v1/accessibility/choices |
| Parameters | |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/choices |
| Response sample (200 OK) | [ { ”choiceId”: 80101, ”formId”: 0, ”questionBlockId”: 0, ”questionId”: 801, ”choices”: [ { ”language”: ”fi”, ”value”: ”Sisätiloissa (asiointipiste, päiväkoti, koulu, sisäliikuntapaikka tms.)” }, { ”language”: ”sv”, ”value”: ”Inomhus (servicepunkt, daghem, skola, plats för inomhusmotion etc.)” }, { ”language”: ”en”, ”value”: ”Indoors (customer service point, day-care centre, school, indoor sports facility, etc.)” } ], ”choiceOrderText”: ”0001999999999999*01”, }, >> rest of the response is omitted << ] |
REST API: CLIENT DATA
Get service point
| Get single service point’s basic information (name, address etc.) | |
| URL | GET /api/v1/servicepoints/{systemId}/{servicePointId} |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/ |
| Response sample (200 OK) | { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”name”: ”PTV Affecto Espoo 2”, ”addressStreetName”: ”KEILARANTA”, ”addressNo”: ”17”, ”addressCity”: ”ESPOO”, ”locEasting”: 379922, ”locNorthing”: 6673299, ”accessibilityPhone”: ”+358 9 1234567”, ”accessibilityEmail”: ”esteettomyys@affecto.espoo.fi”, ”accessibilityWww”: ”https://tpr.hel.fi/kapaesteettomyys_testi/app/summary/ptv:af9f559f-3142-46f7-a98f-a02faa56ce36/”, ”contactPersons”: [], ”created”: ”2017-11-14T16:15:06”, ”modified”: ”2017-12-18T09:02:50”, ”entrances”: [ 19237, 19236, 19235 ] } |
Get service point’s entrances
| Get basic information of single service point’s entrances | |
| URL | GET /api/v1/servicepoints/{systemId}/{servicePointId}/entrances |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/entrances |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”isMainEntrance”: true, ”names”: [], ”locEasting”: 379922, ”locNorthing”: 6673299, ”photoUrl”: ”http://ec2-52-212-11-90.eu-west-1.compute.amazonaws.com/wp-content/uploads/2016/05/140416_HTC_keilaniemi_033-1024×683.jpg”, ”photoSource”: null, ”photoTexts”: [ { ”language”: ”fi”, ”value”: ”pääsisäänkäynnin valokuva” }, { ”language”: ”sv”, ”value”: ”foto på huvudingången” }, { ”language”: ”en”, ”value”: ”photo of the main entrance” } ], ”streetviewUrl”: null, ”created”: ”2017-11-14T16:15:06”, ”modified”: ”2017-11-21T11:181:57”, ”sentencesCreated”: ”2017-11-14T16:16:12”, ”sentencesModified”: ”2017-11-21T11:18:57” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19236, ”isMainEntrance”: false, ”names”: [ { ”language”: ”fi”, ”value”: ”Merenpuoleinen sisäänkäynti” }, { ”language”: ”sv”, ”value”: ”Merenpuoleinen sisäänkäynti (sv)” }, { ”language”: ”en”, ”value”: ”Merenpuoleinen sisäänkäynti (en)” } ], ”locEasting”: 380001, ”locNorthing”: 6673296, ”photoUrl”: ”http://ec2-52-212-11-90.eu-west-1.compute.amazonaws.com/wp-content/uploads/2016/08/140416_HTC_keilaniemi_011_vesifix_low-1920×1920.jpg”, ”photoSource”: null, ”photoTexts”: [ { ”language”: ”fi”, ”value”: ”lisäsisäänkäynnin valokuva” }, { ”language”: ”sv”, ”value”: ”foto av den extra ingången” }, { ”language”: ”en”, ”value”: ”photo of the additional entrance” } ], ”streetviewUrl”: null, ”created”: ”2017-11-15T15:34:39”, ”modified”: ”2017-11-15T15:35:42”, ”sentencesCreated”: ”2017-11-15T15:35:42”, ”sentencesModified”: ”2017-11-15T15:35:42” }, >> rest of the response is omitted << ] |
Get service point’s accessibility sentences
| Get service point’s accessibility sentences | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId}/sentences |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/sentences |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”sentences”: [ { ”language”: ”fi”, ”value”: ”Liikkumisesteisten 1 autopaikka sijaitsee ulkona alle 10 m sisäänkäynnistä. Pysäköintiruudun leveys on alle 3,6 m.” }, { ”language”: ”sv”, ”value”: ”Bilplatsen för rörelsehindrade ligger utomhus under 10 m från ingången. Parkeringsrutans bredd är under 3,6 m.” }, { ”language”: ”en”, ”value”: ”The accessible parking space is located outdoors under 10 m from the entrance. The width of the parking space is less than 3.6 m.” } ], ”sentenceOrderText”: ”0192350001 0001021Esteettömät autopaikat” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”sentences”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti sisäänkäynnille on epätasainen sekä valaistu ja siinä on liikkumista ohjaavaa pintamateriaalia.” }, { ”language”: ”sv”, ”value”: ”Rutten till ingången är ojämn samt belyst och dess ytmaterial ger anvisningar för hur man tar sig fram.” }, { ”language”: ”en”, ”value”: ”The route to the entrance is rough and illuminated and it uses movement-guiding surface material.” } ], ”sentenceOrderText”: ”0192350004 0004021Kulkureitti pääsisäänkäynnille” }, >> rest of the response is omitted << ] |
Get entrance’s accessibility sentences
| Get entrance’s basic accessibility sentences | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId} /entrances/{entranceId}/sentences |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system entranceId = unique id for entrance in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/entrances/19235/sentences |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”sentences”: [ { ”language”: ”fi”, ”value”: ”Liikkumisesteisten 1 autopaikka sijaitsee ulkona alle 10 m sisäänkäynnistä. Pysäköintiruudun leveys on alle 3,6 m.” }, { ”language”: ”sv”, ”value”: ”Bilplatsen för rörelsehindrade ligger utomhus under 10 m från ingången. Parkeringsrutans bredd är under 3,6 m.” }, { ”language”: ”en”, ”value”: ”The accessible parking space is located outdoors under 10 m from the entrance. The width of the parking space is less than 3.6 m.” } ], ”sentenceOrderText”: ”0192350001 0001021Esteettömät autopaikat” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”sentences”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti sisäänkäynnille on epätasainen sekä valaistu ja siinä on liikkumista ohjaavaa pintamateriaalia.” }, { ”language”: ”sv”, ”value”: ”Rutten till ingången är ojämn samt belyst och dess ytmaterial ger anvisningar för hur man tar sig fram.” }, { ”language”: ”en”, ”value”: ”The route to the entrance is rough and illuminated and it uses movement-guiding surface material.” } ], ”sentenceOrderText”: ”0192350004 0004021Kulkureitti pääsisäänkäynnille” }, >> rest of the response is omitted << ] |
Get service point’s accessibility shortages
| Get service point’s accessibility shortages | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId}/shortages |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/shortages |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 11, ”requirementId”: 6, ”shortages”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti pääsisäänkäynnille ei ole tasainen.” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången är inte jämn.” }, { ”language”: ”en”, ”value”: ”The route to the main entrance is not even.” } ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 11, ”requirementId”: 10, ”shortages”: [ { ”language”: ”fi”, ”value”: ”Kulkureitillä pääsisäänkäynnille on jyrkkä mäki.” }, { ”language”: ”sv”, ”value”: ”På rutten till huvudingången finns en brant backe.” }, { ”language”: ”en”, ”value”: ”The route to the main entrance has a steep slope.” } ] }, >> rest of the response is omitted << ] |
Get service point’s accessibility shortages by viewpoint
| Get service point’s accessibility shortages by viewpoint | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId}/viewpoints/ {viewPointId}/shortages |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system viewPointId = id for requested viewpoint |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/viewpoints/31/shortages |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 31, ”requirementId”: 61, ”shortages”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti pääsisäänkäynnille ei ole tasainen.” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången är inte jämn.” }, { ”language”: ”en”, ”value”: ”The route to the main entrance is not even.” } ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 31, ”requirementId”: 65, ”shortages”: [ { ”language”: ”fi”, ”value”: ”Kulkureitillä pääsisäänkäynnille on jyrkkä mäki.” }, { ”language”: ”sv”, ”value”: ”På rutten till huvudingången finns en brant backe.” }, { ”language”: ”en”, ”value”: ”The route to the main entrance has a steep slope.” } ] }, >> rest of the response is omitted << ] |
Get service point’s accessibility properties
| Get accessibility properties of a single service point | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId}/properties |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/properties |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”variableId”: 500, ”variableName”: ”SERVICE_POINT.general_type”, ”value”: ”indoor_facility” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”variableId”: 1, ”variableName”: ”OUTSIDE.ACCESSIBLE_PARKING_SPACE.count”, ”value”: ”1” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”variableId”: 2, ”variableName”: ”OUTSIDE.ACCESSIBLE_PARKING_SPACE.location”, ”value”: ”outdoors” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”variableId”: 3, ”variableName”: ”OUTSIDE.ACCESSIBLE_PARKING_SPACE.width”, ”value”: ”less_than_3600mm” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”variableId”: 4, ”variableName”: ”OUTSIDE.ACCESSIBLE_PARKING_SPACE.distance_from_entrance”, ”value”: ”under_10m” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”variableId”: 5, ”variableName”: ”OUTSIDE.PICKUP_AND_DROPOFF_AREA.near_entrance”, ”value”: ”false” }, >> rest of the response is omitted << ] |
Get entrance’s accessibility properties
| Get entrance’s accessibility properties | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId} /entrances/{entranceId}/properties |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system entranceId = unique id for entrance in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/entrances/19235/properties |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”variableId”: 103, ”variableName”: ”INTERIOR.wheelchair_lift”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”variableId”: 17, ”variableName”: ”ROUTE_TO_ENTRANCE.surface”, ”value”: ”rough” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”variableId”: 107, ”variableName”: ”INTERIOR.ACCESSIBLE_WC.existing”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”variableId”: 3, ”variableName”: ”OUTSIDE.ACCESSIBLE_PARKING_SPACE.width”, ”value”: ”less_than_3600mm” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”variableId”: 40, ”variableName”: ”ENTRANCE.STEPS.easy”, ”value”: ”false” }, >> rest of the response is omitted << ] |
Get service point’s entrances’ accessibility properties
| Get accessibility properties of single service point’s entrances | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId}/entrances /properties |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/entrances/properties |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”variableId”: 103, ”variableName”: ”INTERIOR.wheelchair_lift”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”variableId”: 17, ”variableName”: ”ROUTE_TO_ENTRANCE.surface”, ”value”: ”rough” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19236, ”variableId”: 0, ”variableName”: ”OUTSIDE.ACCESSIBLE_PARKING_SPACE.shared_parking_with_main_entrance”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19236, ”variableId”: 33, ”variableName”: ”ROUTE_TO_ENTRANCE.level_lift”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19236, ”variableId”: 22, ”variableName”: ”ROUTE_TO_ENTRANCE.steep_slope”, ”value”: ”false” }, >> rest of the response is omitted << ] |
Get service point’s choices
| Get answers to multiple-choice questions of a single service point | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId}/choices |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/choices |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”questionId”: 801, ”questionOrderText”: ”001424500192350001”, ”choiceId”: 80101, ”choices”: [ { ”language”: ”fi”, ”value”: ”Sisätiloissa (asiointipiste, päiväkoti, koulu, sisäliikuntapaikka tms.)” }, { ”language”: ”sv”, ”value”: ”Inomhus (servicepunkt, daghem, skola, plats för inomhusmotion etc.)” }, { ”language”: ”en”, ”value”: ”Indoors (customer service point, day-care centre, school, indoor sports facility, etc.)” } ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”questionId”: 1, ”questionOrderText”: ”001424500192350101”, ”choiceId”: 102, ”choices”: [ { ”language”: ”fi”, ”value”: ”1” }, { ”language”: ”sv”, ”value”: ”1” }, { ”language”: ”en”, ”value”: ”1” } ] }, >> rest of the response is omitted << ] |
Get entrance’s choices
| Get answers to multiple-choice questions of a single entrance | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId} /entrances/{entranceId}/choices |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client systementranceId = unique id for entrance in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/entrances/19235/choices |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”questionId”: 801, ”questionOrderText”: ”001424500192350001”, ”choiceId”: 80101, ”choices”: [ { ”language”: ”fi”, ”value”: ”Sisätiloissa (asiointipiste, päiväkoti, koulu, sisäliikuntapaikka tms.)” }, { ”language”: ”sv”, ”value”: ”Inomhus (servicepunkt, daghem, skola, plats för inomhusmotion etc.)” }, { ”language”: ”en”, ”value”: ”Indoors (customer service point, day-care centre, school, indoor sports facility, etc.)” } ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”questionId”: 1, ”questionOrderText”: ”001424500192350101”, ”choiceId”: 102, ”choices”: [ { ”language”: ”fi”, ”value”: ”1” }, { ”language”: ”sv”, ”value”: ”1” }, { ”language”: ”en”, ”value”: ”1” } ] }, >> rest of the response is omitted << ] |
Get service point’s places
| Get accessibility places of a single service point | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId}/places |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/places |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”headings”: [ { ”language”: ”fi”, ”value”: ”Pääsisäänkäynti ja saapuminen” }, { ”language”: ”sv”, ”value”: ”Huvudingången och ankomsten” }, { ”language”: ”en”, ”value”: ”The main entrance and arrival” } ], ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”placeId”: 1, ”place”: [ { ”language”: ”fi”, ”value”: ”Pysäköintialue” }, { ”language”: ”sv”, ”value”: ”Parkeringsområdet” }, { ”language”: ”en”, ”value”: ”Parking area” } ], ”placeOrderText”: ”001424521a001001”, ”locEasting”: 379949, ”locNorthing”: 6673315, ”locationTexts”: [ { ”language”: ”fi”, ”value”: ”Pysäköintialueen sijainti” }, { ”language”: ”sv”, ”value”: ”Pysäköintialueen sijainti (sv)” }, { ”language”: ”en”, ”value”: ”Pysäköintialueen sijainti (en)” } ], ”photoUrl”: ”https://upload.wikimedia.org/wikipedia/commons/thumb/c/c9/Carpark_in_canberra.jpg/1200px-Carpark_in_canberra.jpg”, ”photoSource”: ”Wikipedia, Public Domain”, ”photoTexts”: [ { ”language”: ”fi”, ”value”: ”Pysäköintialue” }, { ”language”: ”sv”, ”value”: ”Pysäköintialue (sv)” }, { ”language”: ”en”, ”value”: ”Pysäköintialue (en)” } ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”headings”: [ { ”language”: ”fi”, ”value”: ”Pääsisäänkäynti ja saapuminen” }, { ”language”: ”sv”, ”value”: ”Huvudingången och ankomsten” }, { ”language”: ”en”, ”value”: ”The main entrance and arrival” } ], ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”placeId”: 5, ”place”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti tontin rajalta sisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten från tomtens gräns till entrén” }, { ”language”: ”en”, ”value”: ”Route from the boundary of the lot to the entrance” } ], ”placeOrderText”: ”001424521a005001”, ”locEasting”: 379994, ”locNorthing”: 6673188, ”locationTexts”: [ { ”language”: ”fi”, ”value”: ”Kulkureitin sijainti” }, { ”language”: ”sv”, ”value”: ”Kulkureitin sijainti (sv)” }, { ”language”: ”en”, ”value”: ”Kulkureitin sijainti (en)” } ], ”photoUrl”: ”https://upload.wikimedia.org/wikipedia/commons/d/da/Nokia_headquarters_main_entrance.jpg”, ”photoSource”: ”Wikipedia, Public Domain”, ”photoTexts”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti” }, { ”language”: ”sv”, ”value”: ”Kulkureitti (sv)” }, { ”language”: ”en”, ”value”: ”Kulkureitti (en)” } ] } ] |
Get entrance’s places
| Get accessibility places of a single entrance | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId}/ entrances/{entranceId}/places |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/entrances/19235/places |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”headings”: [ { ”language”: ”fi”, ”value”: ”Pääsisäänkäynti ja saapuminen” }, { ”language”: ”sv”, ”value”: ”Huvudingången och ankomsten” }, { ”language”: ”en”, ”value”: ”The main entrance and arrival” } ], ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”placeId”: 1, ”place”: [ { ”language”: ”fi”, ”value”: ”Pysäköintialue” }, { ”language”: ”sv”, ”value”: ”Parkeringsområdet” }, { ”language”: ”en”, ”value”: ”Parking area” } ], ”placeOrderText”: ”001424521a001001”, ”locEasting”: 379949, ”locNorthing”: 6673315, ”locationTexts”: [ { ”language”: ”fi”, ”value”: ”Pysäköintialueen sijainti” }, { ”language”: ”sv”, ”value”: ”Pysäköintialueen sijainti (sv)” }, { ”language”: ”en”, ”value”: ”Pysäköintialueen sijainti (en)” } ], ”photoUrl”: ”https://upload.wikimedia.org/wikipedia/commons/thumb/c/c9/Carpark_in_canberra.jpg/1200px-Carpark_in_canberra.jpg”, ”photoSource”: ”Wikipedia, Public Domain”, ”photoTexts”: [ { ”language”: ”fi”, ”value”: ”Pysäköintialue” }, { ”language”: ”sv”, ”value”: ”Pysäköintialue (sv)” }, { ”language”: ”en”, ”value”: ”Pysäköintialue (en)” } ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”headings”: [ { ”language”: ”fi”, ”value”: ”Pääsisäänkäynti ja saapuminen” }, { ”language”: ”sv”, ”value”: ”Huvudingången och ankomsten” }, { ”language”: ”en”, ”value”: ”The main entrance and arrival” } ], ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”placeId”: 5, ”place”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti tontin rajalta sisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten från tomtens gräns till entrén” }, { ”language”: ”en”, ”value”: ”Route from the boundary of the lot to the entrance” } ], ”placeOrderText”: ”001424521a005001”, ”locEasting”: 379994, ”locNorthing”: 6673188, ”locationTexts”: [ { ”language”: ”fi”, ”value”: ”Kulkureitin sijainti” }, { ”language”: ”sv”, ”value”: ”Kulkureitin sijainti (sv)” }, { ”language”: ”en”, ”value”: ”Kulkureitin sijainti (en)” } ], ”photoUrl”: ”https://upload.wikimedia.org/wikipedia/commons/d/da/Nokia_headquarters_main_entrance.jpg”, ”photoSource”: ”Wikipedia, Public Domain”, ”photoTexts”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti” }, { ”language”: ”sv”, ”value”: ”Kulkureitti (sv)” }, { ”language”: ”en”, ”value”: ”Kulkureitti (en)” } ] } ] |
Get service point’s accessibility summary
| Get accessibility summary of a single service point | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId}/summary |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/summary |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicepointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 12, ”isAccessible”: ”red”, ”shortageCount”: 10 }, { ”systemId”: ”[ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicepointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 12, ”isAccessible”: ”red”, ”shortageCount”: 10 }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicepointId”: ” af9f559f-3142-46f7-a98f-a02faa56ce36″, ”viewpointId”: 21, ”isAccessible”: ”red”, ”shortageCount”: 6 }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicepointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 51, ”isAccessible”: ”red”, ”shortageCount”: 6 }, >> rest of the response is omitted << ] |
Get service point’s accessibility summary by viewpoint
| Get service point’s accessibility summary by viewpoint | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId} /viewpoints/{viewpointId}/summary |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system viewpointId = viewpoint id |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/viewpoints/21/summary |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicepointId”: “af9f559f-3142-46f7-a98f-a02faa56ce36″, ”viewpointId”: 21, ”isAccessible”: ”red”, ”shortageCount”: 6 } ] |
Get service point’s accessibility shortages for reporting purposes
| Get service point’s accessibility shortages with additional data for reports | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId}/reportshortages |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/reportshortages |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 11, ”isIndoorServicepoint”: true, ”evaluationZone”: ”outsideServicePoint”, ”easyToFix”: false, ”requirementId”: 1, ”requirementText”: ”Toimipisteen edessä pitää olla vähintään yksi leveä esteetön autopaikka.”, ”explanationWhyNot”: ”Esteettömiksi merkittyjä autopaikkoja on, mutta ne eivät ole tarpeeksi leveitä.”, ”shortages”: [ { ”language”: ”fi”, ”value”: ”Esteettömiksi merkittyjä autopaikkoja on, mutta ne eivät ole tarpeeksi leveitä.” }, { ”language”: ”sv”, ”value”: ”Det finns p-platser som har angetts som tillgängliga, men de är inte tillräckligt breda.” }, { ”language”: ”en”, ”value”: ”There are parking spaces marked as accessible but they are not sufficiently wide.” } ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 11, ”isIndoorServicepoint”: true, ”evaluationZone”: ”outsideServicePoint”, ”easyToFix”: false, ”requirementId”: 3, ”requirementText”: ”Saattoliikenteen pysähtymispaikka pitää olla lähellä sisäänkäyntiä (etäisyys enintään 5 m).”, ”explanationWhyNot”: ”Saattoliikenne ei voi pysähtyä sisäänkäynnin eteen.”, ”shortages”: [ { ”language”: ”fi”, ”value”: ”Saattoliikenne ei voi pysähtyä pääsisäänkäynnin eteen.” }, { ”language”: ”sv”, ”value”: ”Angöringstafiken kan inte stoppa framför huvudingången.” }, { ”language”: ”en”, ”value”: ”Pick-up and drop-off traffic cannot stop in front of the main entrance.” } ] }, >> rest of the response is omitted << ] |
Get service point’s accessibility summary for reporting purposes
| Get service point’s accessibility summary with additional data for reports | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/{servicePointId}/reportsummary |
| Parameters | systemId = unique id for client system in accessibility registerservicePointId = unique id for service point in client system |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/reportsummary |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”isAccessible”: [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”isAccessible”: ”red”, ”shortageCount”: 19, ”shortageCountEasyToFix”: 1, ”wheelIsAccessible”: ”red”, ”wheelShortageCount”: 11, ”wheelShortageCountEasyToFix”: 1, ”wheelShortageCountOutside”: 5, ”wheelShortageCountEntrance”: 4, ”wheelShortageCountInside”: 2, ”visualIsAccessible”: ”red”, ”visualShortageCount”: 7, ”visualShortageCountEasyToFix”: 0, ”visualShortageCountOutside”: 3, ”visualShortageCountEntrance”: 2, ”visualShortageCountInside”: 2, ”hearingIsAccessible”: ”red”, ”toiletIsAccessible”: ”red” } ] |
Delete service point
| Delete service point information (entrances, accessibility information, service point basic information) from accessibility register | |
| URL | DELETE /api/v1/servicepoints/{systemId}/{servicePointId}/ ?user={user}&validUntil={validUntil}&checksum={checksum} |
| Parameters | – systemId = unique id for client system in accessibility register – servicePointId = unique id for service point in client system – user = userid/username to identify client systems user – validUntil = ISO8601 datetime value for AR to check if request is still valid (client system sets this value) – checksum = sha256 hash calculated from concatenated secret key and parameter values (concatenation order: checksumSecret + systemId + servicePointId + user + validUntil) All parameters are mandatory! |
| Authorization | 1. System id is validated (is existing client system in AR) 2. Valid until is validated (compared to current date & time) 3. Checksum is validated |
| Request sample | DELETE https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/af9f559f-3142-46f7-a98f-a02faa56ce36/?user=ptvtest%40ptv.fi&validUntil=2017-11-21T20%3a20%3a26&checksum=400F74DADAF645FF32BF4DE4E949718CF2242238EBACA9EB04C7468477F8987E |
| Response sample (200 OK) | ”Deleted” |
| Code sample (C#) | HttpClient Client = new HttpClient(); Guid systemId = Guid.Parse(”ab6e2755-19a2-45b4-b5cd-484098b6c511”); string servicePointId = ”af9f559f-3142-46f7-a98f-a02faa56ce36”; string validUntil = DateTime.Now.AddMinutes(240).ToString(”s”); string user = ”ptvtest@ptv.fi”; string checksumSecret = ”[this will be provided per client system]”; // calculate hash from concatenated parameter values var values = checksumSecret + systemId + servicePointId + user + validUntil; var hash = CryptoHelper.CreateSHA256Hash(values); Client.BaseAddress = new Uri(”https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/”); Client.DefaultRequestHeaders.Accept.Clear(); Client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(”application/json”)); var url = $”v1/servicepoints/{systemId}/{servicePointId}/” + $”?user={HttpUtility.UrlEncode(user)}” + $”&validUntil={HttpUtility.UrlEncode(validUntil)}” + $”&checksum={hash}”; HttpResponseMessage response = await Client.DeleteAsync(url); |
Add external service point reference
| Add external system’s service point reference to accessibility register’s service point à Accessibility register’s accessibility information can be found with external system’s service point id (e.g. Helsinki TPR service point accessibility data can be found with PTV service point id). If no accessibility register service point is found then one is added with given service point id. Not to be used from PTV! | |
| URL | POST /api/v1/servicepoints/{systemId}/{servicePointId}/externalservicepoint/ |
| Parameters | URL – systemId = unique id for client system in accessibility register – servicePointId = unique id for service point in client system DATA extServicePointData – systemId = external system’s id in accessibility register – servicepointId = external system’s service point id – user = userid/username to identify client systems user – validUntil = ISO8601 datetime value for AR to check if request is still valid (client system sets this value) – checksum = sha256 hash calculated from concatenated secret key and parameter values (concatenation order: checksumSecret + systemId + servicePointId + user + validUntil + external systemId + external servicepointId) All parameters are mandatory! |
| Authorization | 1. System id is validated (is existing client system in AR) 2. Valid until is validated (compared to current date & time) 3. Checksum is validated |
| Request sample | POST https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/servicepoints/e186251e-1fb6-4f21-901c-cb6820aee164/123456/externalservicepoint/ { ”ServicePointId”:”338de29b-a5e5-47a9-a79f-80cb6c3a303b”, ”SystemId”:”ab6e2755-19a2-45b4-b5cd-484098b6c511″, ”User”:”user@tpr.fi”, ”ValidUntil”:”2018-01-30T18:08:01″, ”Checksum”:”C6FC721604E5F093B19071DD8903C5643B6BDE0EF1C8D62CBE869A7416BF9551″ } |
| Response sample (200 OK) | |
| Code sample (C#) | HttpClient Client = new HttpClient(); Guid systemId = Guid.Parse(”e186251e-1fb6-4f21-901c-cb6820aee164”); string servicePointId = ”123456”; Guid externalSystemId = Guid.Parse(”ab6e2755-19a2-45b4-b5cd-484098b6c511”); string externalServicePointId = ”338de29b-a5e5-47a9-a79f-80cb6c3a303b”; string validUntil = DateTime.Now.AddMinutes(240).ToString(”s”); string user = ”testuser@tprperhe.fi”; string checksumSecret = ”[this will be provided per client system]”; // calculate hash from concatenated parameter values var values = checksumSecret + systemId + servicePointId + user + validUntil + externalSystemId + externalServicePointId; var hash = CryptoHelper.CreateSHA256Hash(values); var data = new ExternalServicePointData() { SystemId = externalSystemId, ServicePointId = externalServicePointId, User = user, ValidUntil = DateTime.Parse(validUntil), Checksum = hash }; Client.BaseAddress = new Uri(”https://tpr.hel.fi/kapaesteettomyys_testi/api/”); var uri = $”v1/servicepoints/{systemId}/{servicePointId}/externalservicepoint/”; Client.DefaultRequestHeaders.Accept.Clear(); Client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(”application/json”)); HttpResponseMessage response = await Client.PostAsJsonAsync(uri, data); |
REST API: CLIENT DATA, MASSIVE QUERIES
Get system’s service points
| Get basic information (name, address etc.) of system’s all service points. | |
| URL | GET /api/v1/servicepoints/{systemId} |
| Parameters | – systemId = unique id for client system in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511 |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”name”: ”PTV Affecto Espoo 2”, ”addressStreetName”: ”KEILARANTA”, ”addressNo”: ”17”, ”addressCity”: ”ESPOO”, ”locEasting”: 379922, ”locNorthing”: 6673299, ”accessibilityPhone”: ”+358 9 1234567”, ”accessibilityEmail”: ”esteettomyys@affecto.espoo.fi”, ”accessibilityWww”: ”https://tpr.hel.fi/kapaesteettomyys_testi/app/summary/ptv:af9f559f-3142-46f7-a98f-a02faa56ce36/”, ”contactPersons”: [], ”created”: ”2017-11-14T16:15:06”, ”modified”: ”2017-12-18T09:02:50”, ”entrances”: [ 19237, 19235, 19236 ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce37”, ”name”: ”PTV Affecto Espoo 2”, ”addressStreetName”: ”KEILARANTA”, ”addressNo”: ”17”, ”addressCity”: ”ESPOO”, ”locEasting”: 379922, ”locNorthing”: 6673299, ”accessibilityPhone”: null, ”accessibilityEmail”: null, ”accessibilityWww”: ”https://tpr.hel.fi/kapaesteettomyys_testi/app/summary/ptv:af9f559f-3142-46f7-a98f-a02faa56ce37/”, ”contactPersons”: [], ”created”: ”2018-01-10T09:55:22”, ”modified”: ”2018-01-18T08:03:28”, ”entrances”: [ 19255 ] }, >> rest of the response is omitted << ] |
Get system’s entrances
| Get basic information of system’s all service point entrances. | |
| URL | GET /api/v1/servicepoints/{systemId}/entrances |
| Parameters | systemId = unique id for client system in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/entrances |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”isMainEntrance”: true, ”names”: [], ”locEasting”: 379922, ”locNorthing”: 6673299, ”photoUrl”: ”http://ec2-52-212-11-90.eu-west-1.compute.amazonaws.com/wp-content/uploads/2016/05/140416_HTC_keilaniemi_033-1024×683.jpg”, ”photoSource”: null, ”photoTexts”: [ { ”language”: ”fi”, ”value”: ”pääsisäänkäynnin valokuva” }, { ”language”: ”sv”, ”value”: ”foto på huvudingången” }, { ”language”: ”en”, ”value”: ”photo of the main entrance” } ], ”streetviewUrl”: null, ”created”: ”2017-11-14T16:15:06”, ”modified”: ”2017-11-21T11:18:57”, ”sentencesCreated”: ”2017-11-14T16:16:12”, ”sentencesModified”: ”2017-11-21T11:18:57” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19236, ”isMainEntrance”: false, ”names”: [ { ”language”: ”fi”, ”value”: ”Merenpuoleinen sisäänkäynti” }, { ”language”: ”sv”, ”value”: ”Merenpuoleinen sisäänkäynti (sv)” }, { ”language”: ”en”, ”value”: ”Merenpuoleinen sisäänkäynti (en)” } ], ”locEasting”: 380001, ”locNorthing”: 6673296, ”photoUrl”: ”http://ec2-52-212-11-90.eu-west-1.compute.amazonaws.com/wp-content/uploads/2016/08/140416_HTC_keilaniemi_011_vesifix_low-1920×1920.jpg”, ”photoSource”: null, ”photoTexts”: [ { ”language”: ”fi”, ”value”: ”lisäsisäänkäynnin valokuva” }, { ”language”: ”sv”, ”value”: ”foto av den extra ingången” }, { ”language”: ”en”, ”value”: ”photo of the additional entrance” } ], ”streetviewUrl”: null, ”created”: ”2017-11-15T15:34:39”, ”modified”: ”2017-11-15T15:35:42”, ”sentencesCreated”: ”2017-11-15T15:35:42”, ”sentencesModified”: ”2017-11-15T15:35:42” }, >> rest of the response is omitted << ] |
Get system’s accessibility sentences
| Get system’s accessibility sentences | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/sentences |
| Parameters | – systemId = unique id for client system in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/sentences |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”sentences”: [ { ”language”: ”fi”, ”value”: ”Liikkumisesteisten 1 autopaikka sijaitsee ulkona alle 10 m sisäänkäynnistä. Pysäköintiruudun leveys on alle 3,6 m.” }, { ”language”: ”sv”, ”value”: ”Bilplatsen för rörelsehindrade ligger utomhus under 10 m från ingången. Parkeringsrutans bredd är under 3,6 m.” }, { ”language”: ”en”, ”value”: ”The accessible parking space is located outdoors under 10 m from the entrance. The width of the parking space is less than 3.6 m.” } ], ”sentenceOrderText”: ”0192350001 0001021Liikkumisesteisten autopaikat” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”sentences”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti sisäänkäynnille on epätasainen sekä valaistu ja siinä on liikkumista ohjaavaa pintamateriaalia.” }, { ”language”: ”sv”, ”value”: ”Rutten till ingången är ojämn samt belyst och dess ytmaterial ger anvisningar för hur man tar sig fram.” }, { ”language”: ”en”, ”value”: ”The route to the entrance is rough and illuminated and it uses movement-guiding surface material.” } ], ”sentenceOrderText”: ”0192350004 0004021Kulkureitti pääsisäänkäynnille” }, >> rest of the response is omitted << ] |
Get system’s accessibility shortages
| Get system’s accessibility shortages | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/shortages |
| Parameters | – systemId = unique id for client system in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/shortages |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 11, ”requirementId”: 6, ”shortages”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti pääsisäänkäynnille ei ole tasainen.” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången är inte jämn.” }, { ”language”: ”en”, ”value”: ”The route to the main entrance is not even.” } ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 11, ”requirementId”: 10, ”shortages”: [ { ”language”: ”fi”, ”value”: ”Kulkureitillä pääsisäänkäynnille on jyrkkä mäki.” }, { ”language”: ”sv”, ”value”: ”På rutten till huvudingången finns en brant backe.” }, { ”language”: ”en”, ”value”: ”The route to the main entrance has a steep slope.” } ] }, >> rest of the response is omitted << ] |
Get system’s accessibility properties
| Get system’s accessibility properties | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/properties |
| Parameters | – systemId = unique id for client system in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/properties |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”variableId”: 50[ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”variableId”: 500, ”variableName”: ”SERVICE_POINT.general_type”, ”value”: ”indoor_facility” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”variableId”: 107, ”variableName”: ”INTERIOR.ACCESSIBLE_WC.existing”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”variableId”: 105, ”variableName”: ”INTERIOR.DOORS.glass_door”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce37”, ”variableId”: 58, ”variableName”: ”ENTRANCE.FOYER.sufficiently_room_for_wheelchair”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce37”, ”variableId”: 57, ”variableName”: ”ENTRANCE.FOYER.existing”, ”value”: ”true” }, >> rest of the response is omitted << ] |
Get system’s entrances’ accessibility properties
| Get accessibility properties of system’s all service point entrances. | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId/entrances/properties |
| Parameters | – systemId = unique id for client system in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/entrances/properties |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”variableId”: 103, ”variableName”: ”INTERIOR.wheelchair_lift”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”variableId”: 17, ”variableName”: ”ROUTE_TO_ENTRANCE.surface”, ”value”: ”rough” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 192[ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”variableId”: 103, ”variableName”: ”INTERIOR.wheelchair_lift”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”variableId”: 17, ”variableName”: ”ROUTE_TO_ENTRANCE.surface”, ”value”: ”rough” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19236, ”variableId”: 0, ”variableName”: ”OUTSIDE.ACCESSIBLE_PARKING_SPACE.shared_parking_with_main_entrance”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19236, ”variableId”: 33, ”variableName”: ”ROUTE_TO_ENTRANCE.level_lift”, ”value”: ”false” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce37”, ”entranceId”: 19255, ”variableId”: 37, ”variableName”: ”ENTRANCE.illuminated”, ”value”: ”true” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce37”, ”entranceId”: 19255, ”variableId”: 25, ”variableName”: ”ROUTE_TO_ENTRANCE.STEPS.easy”, ”value”: ”false” }, >> rest of the response is omitted << ] |
Get system’s choices
| Get answers to multiple-choice questions of a system | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/choices |
| Parameters | – systemId = unique id for client system in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/choices |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”questionId”: 801, ”questionOrderText”: ”001424500192350001”, ”choiceId”: 80101, ”choices”: [ { ”language”: ”fi”, ”value”: ”Sisätiloissa (asiointipiste, päiväkoti, koulu, sisäliikuntapaikka tms.)” }, { ”language”: ”sv”, ”value”: ”Inomhus (servicepunkt, daghem, skola, plats för inomhusmotion etc.)” }, { ”language”: ”en”, ”value”: ”Indoors (customer service point, day-care centre, school, indoor sports facility, etc.)” } ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”questionId”: 1, ”questionOrderText”: ”001424500192350101”, ”choiceId”: 102, ”choices”: [ { ”language”: ”fi”, ”value”: ”1” }, { ”language”: ”sv”, ”value”: ”1” }, { ”language”: ”en”, ”value”: ”1” } ] }, >> rest of the response is omitted << ] |
Get system’s places
| Get accessibility places of a system | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/places |
| Parameters | – systemId = unique id for client system in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/places |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”headings”: [ { ”language”: ”fi”, ”value”: ”Pääsisäänkäynti ja saapuminen” }, { ”language”: ”sv”, ”value”: ”Huvudingången och ankomsten” }, { ”language”: ”en”, ”value”: ”The main entrance and arrival” } ], ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”placeId”: 1, ”place”: [ { ”language”: ”fi”, ”value”: ”Pysäköintialue” }, { ”language”: ”sv”, ”value”: ”Parkeringsområdet” }, { ”language”: ”en”, ”value”: ”Parking area” } ], ”placeOrderText”: ”001424521a001001”, ”locEasting”: 379949, ”locNorthing”: 6673315, ”locationTexts”: [ { ”language”: ”fi”, ”value”: ”Pysäköintialueen sijainti” }, { ”language”: ”sv”, ”value”: ”Pysäköintialueen sijainti (sv)” }, { ”language”: ”en”, ”value”: ”Pysäköintialueen sijainti (en)” } ], ”photoUrl”: ”https://upload.wikimedia.org/wikipedia/commons/thumb/c/c9/Carpark_in_canberra.jpg/1200px-Carpark_in_canberra.jpg”, ”photoSource”: ”Wikipedia, Public Domain”, ”photoTexts”: [ { ”language”: ”fi”, ”value”: ”Pysäköintialue” }, { ”language”: ”sv”, ”value”: ”Pysäköintialue (sv)” }, { ”language”: ”en”, ”value”: ”Pysäköintialue (en)” } ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”entranceId”: 19235, ”headings”: [ { ”language”: ”fi”, ”value”: ”Pääsisäänkäynti ja saapuminen” }, { ”language”: ”sv”, ”value”: ”Huvudingången och ankomsten” }, { ”language”: ”en”, ”value”: ”The main entrance and arrival” } ], ”sentenceGroups”: [ { ”language”: ”fi”, ”value”: ”Reitti pääsisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten till huvudingången” }, { ”language”: ”en”, ”value”: ”The route to the main entrance” } ], ”placeId”: 5, ”place”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti tontin rajalta sisäänkäynnille” }, { ”language”: ”sv”, ”value”: ”Rutten från tomtens gräns till entrén” }, { ”language”: ”en”, ”value”: ”Route from the boundary of the lot to the entrance” } ], ”placeOrderText”: ”001424521a005001”, ”locEasting”: 379994, ”locNorthing”: 6673188, ”locationTexts”: [ { ”language”: ”fi”, ”value”: ”Kulkureitin sijainti” }, { ”language”: ”sv”, ”value”: ”Kulkureitin sijainti (sv)” }, { ”language”: ”en”, ”value”: ”Kulkureitin sijainti (en)” } ], ”photoUrl”: ”https://upload.wikimedia.org/wikipedia/commons/d/da/Nokia_headquarters_main_entrance.jpg”, ”photoSource”: ”Wikipedia, Public Domain”, ”photoTexts”: [ { ”language”: ”fi”, ”value”: ”Kulkureitti” }, { ”language”: ”sv”, ”value”: ”Kulkureitti (sv)” }, { ”language”: ”en”, ”value”: ”Kulkureitti (en)” } ] } >> rest of the response is omitted << ] |
Get system’s accessibility summary
| Get accessibility summary of a system | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/summary |
| Parameters | systemId = unique id for client system in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/summary |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 11, ”isAccessible”: ”red”, ”shortageCount”: 9 }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce37”, ”viewpointId”: 11, ”isAccessible”: ”red”, ”shortageCount”: 7 }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce37”, ”viewpointId”: 12, ”isAccessible”: ”red”, ”shortageCount”: 8 }, >> rest of the response is omitted << ] |
Get system’s accessibility shortages for reporting purposes
| Get system’s accessibility shortages with additional data for reports | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/reportshortages |
| Parameters | systemId = unique id for client system in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/reportshortages |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 11, ”isIndoorServicepoint”: true, ”evaluationZone”: ”outsideServicePoint”, ”easyToFix”: false, ”requirementId”: 1, ”requirementText”: ”Toimipisteen edessä pitää olla vähintään yksi leveä esteetön autopaikka.”, ”explanationWhyNot”: ”Esteettömiksi merkittyjä autopaikkoja on, mutta ne eivät ole tarpeeksi leveitä.”, ”shortages”: [ { ”language”: ”fi”, ”value”: ”Esteettömiksi merkittyjä autopaikkoja on, mutta ne eivät ole tarpeeksi leveitä.” }, { ”language”: ”sv”, ”value”: ”Det finns p-platser som har angetts som tillgängliga, men de är inte tillräckligt breda.” }, { ”language”: ”en”, ”value”: ”There are parking spaces marked as accessible but they are not sufficiently wide.” } ] }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”viewpointId”: 11, ”isIndoorServicepoint”: true, ”evaluationZone”: ”outsideServicePoint”, ”easyToFix”: false, ”requirementId”: 12, ”requirementText”: ”Kulkureitillä sisäänkäynnille ei saa olla portaita mutta jos on, portaat pitää voida ohittaa joko tasonostimen tai pyörätuolinostimen avulla, tai loivaa luiskaa myöten, jossa on käsijohde vähintään toisella puolella.”, ”explanationWhyNot”: ”Ainakin yksi porras on, mutta ei luiskaa.”, ”shortages”: [ { ”language”: ”fi”, ”value”: ”Kulkureitillä pääsisäänkäynnille on ainakin yksi porrasaskelma, mutta ei luiskaa.” }, { ”language”: ”sv”, ”value”: ”På rutten till huvudingången finns minst ett trappsteg, men ingen ramp.” }, { ”language”: ”en”, ”value”: ”The route to the main entrance has at least one step but no ramp.” } ] }, >> rest of the response is omitted << ]] |
Get system’s accessibility summary for reporting purposes
| Get system’s accessibility summary with additional data for reports | |
| URL | GET /api/v1/accessibility/servicepoints/{systemId}/reportsummary |
| Parameters | systemId = unique id for client system in accessibility register |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/v1/accessibility/servicepoints/ab6e2755-19a2-45b4-b5cd-484098b6c511/reportsummary |
| Response sample (200 OK) | [ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”isAccessible”: ”red”, ”shortageCount”: 19, ”shortageCountEasyToFix”: 1, ”wheelIsAccessible”: ”red”, ”wheelShortageCount”: 11, ”wheelShortageCountEasyToFix”: 1, ”wheelShortageCountOutside”: 5, ”wheelShortageCountEntrance”: 4, ”wheelShortageCountInside”: 2, ”visualIsAccessible”: ”red”, ”visualShortageCount”: 7, ”visualShortageCountEasyToFix”: 0, ”visualShortageCountOutside”: 3, ”visualShortageCountEntrance”: 2, ”visualShortageCountInside”: 2, ”hearingIsAccessible”: ”red”, ”toiletIsAccessible”: ”red” }, { ”[ { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce36”, ”isAccessible”: ”red”, ”shortageCount”: 19, ”shortageCountEasyToFix”: 1, ”wheelIsAccessible”: ”red”, ”wheelShortageCount”: 11, ”wheelShortageCountEasyToFix”: 1, ”wheelShortageCountOutside”: 5, ”wheelShortageCountEntrance”: 4, ”wheelShortageCountInside”: 2, ”visualIsAccessible”: ”red”, ”visualShortageCount”: 7, ”visualShortageCountEasyToFix”: 0, ”visualShortageCountOutside”: 3, ”visualShortageCountEntrance”: 2, ”visualShortageCountInside”: 2, ”hearingIsAccessible”: ”red”, ”toiletIsAccessible”: ”red” }, { ”systemId”: ”ab6e2755-19a2-45b4-b5cd-484098b6c511”, ”servicePointId”: ”af9f559f-3142-46f7-a98f-a02faa56ce37”, ”isAccessible”: ”red”, ”shortageCount”: 13, ”shortageCountEasyToFix”: 0, ”wheelIsAccessible”: ”red”, ”wheelShortageCount”: 9, ”wheelShortageCountEasyToFix”: 0, ”wheelShortageCountOutside”: 4, ”wheelShortageCountEntrance”: 4, ”wheelShortageCountInside”: 1, ”visualIsAccessible”: ”red”, ”visualShortageCount”: 4, ”visualShortageCountEasyToFix”: 0, ”visualShortageCountOutside”: 2, ”visualShortageCountEntrance”: 2, ”visualShortageCountInside”: 0, ”hearingIsAccessible”: ”green”, ”toiletIsAccessible”: ”red” }, >> rest of the response is omitted << ] |
WEB APPLICATION: URL INTERFACES
Create/edit service point accessibility information
| Open accessibility register UI to create or modify service point’s accessibility information. If service point information is not found with system id and service point id combination then new service point and main entrance is added. User is then redirected to main entrance’s accessibility form. If service point EXISTS with system id & service point id combination then service points information is updated with values from parameters. User is then redirected to service point’s accessibility summary page. | |
| URL | GET app/ServicePoint/?systemId={systemId} &servicePointId={servicePointId} &user={user} &validUntil={validUntil} &name={name} &streetAddress={streetAddress} &postOffice={postOffice} &northing={northing} &easting={easting} &checksum={checksum} |
| Parameters | – systemId = unique id for client system in accessibility register – servicePointId = unique id for service point in client system – user = userid/username to identify client systems user – validUntil = ISO8601 datetime value for AR to check if request is still valid (client system sets value) – name = service point name street – Address = full street address (name + number etc.) – postOffice = post office name – northing = service point location northing TM35FIN – easting = service point location easting TM35FIN – checksum = sha256 hash calculated from concatenated secret key and parameter values (concatenation order: checksumSecret + systemId + servicePointId + user + validUntil) All parameters are mandatory! |
| Authorization | 1. System id is validated (is existing client system in AR) 2. Valid until is validated (compared to current date & time) 3. Checksum is validated If authorization is successful then user is granted access to requested service point’s accessibility information (for 1 hour). |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/app/ServicePoint/?systemId=ab6e2755-19a2-45b4-b5cd-484098b6c511&servicePointId=af9f559f-3142-46f7-a98f-a02faa56ce36&user=ptvtest%40ptv.fi&validUntil=2017-12-23T11%3a39%3a05&name=PTV+Affecto+Espoo+2&streetAddress=Keilaranta+17+C&postOffice=Espoo&northing=6673299&easting=379922&checksum=A90C14EBC8FAF4674EF6B22F6F2902B6FD2BC217AED2792E350D907E59F3931B |
| Response sample (200 OK) | |
| Code sample (C#) | Guid systemId = Guid.Parse(”ab6e2755-19a2-45b4-b5cd-484098b6c511”); string servicePointId = ”af9f559f-3142-46f7-a98f-a02faa56ce36”; string validUntil = DateTime.Now.AddMonths(1).ToString(”s”); string user = ”ptvtest@ptv.fi”; string name = ”PTV Affecto Espoo 2”; string streetAddress = ”Keilaranta 17 C”; string postOffice = ”Espoo”; int northing = 6673299; int easting = 379922; string checksumSecret = ”[this will be provided per client system]”; var values = checksumSecret + systemId + servicePointId + user + validUntil + streetAddress + postOffice + name + northing + easting; var hash = CryptoHelper.CreateSHA256Hash(values); var url = $”https://tpr.hel.fi/kapaesteettomyys_testi/app/ServicePoint/” + $”?systemId={SystemIdPTV}” + $”&servicePointId={servicePointId}” + $”&user={HttpUtility.UrlEncode(user)}” + $”&validUntil={HttpUtility.UrlEncode(validUntil)}” + $”&name={HttpUtility.UrlEncode(name)}” + $”&streetAddress={HttpUtility.UrlEncode(streetAddress)}” + $”&postOffice={HttpUtility.UrlEncode(postOffice)}” + $”&northing={northing}” + $”&easting={easting}” + $”&checksum={hash}”; Debug.Print(url); |
Get service point’s read-only accessibility information summary
| Opens the accessibility register UI to get a read-only summary of a service point’s accessibility information. If no service point information is found with the id provided, then the user is shown a message that the information is not available. If the service point information exists with the id provided, then the user is redirected to the service point’s read-only accessibility summary page. | |
| URL | GET app/summary/{servicePointId}/ |
| Parameters | – servicePointId = client system prefix + colon + unique id for service point in client system For example: – tpr:3266 – ptv:91c3953f-146a-4738-9228-6a925f26b4f6 Both of these example ids refer to the same service point, so either can be used to get the summary page. |
| Authorization | The read-only summary page does not require authorization. |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/app/summary/tpr:3266/ GET https://tpr.hel.fi/kapaesteettomyys_testi/app/summary/ptv:91c3953f-146a-4738-9228-6a925f26b4f6/ |
| Response sample (200 OK) | |
Output service point’s accessibility information as a PDF document
| Creates a PDF document for service point’s accessibility information. If no service point information is found with the id provided, then the user is shown a Server Error (500) message. If the service point information exists with the id provided, then the service point’s PDF document appears. | |
| URL | GET api/pdfview/{servicePointId}/?purpose={purpose} &language={language} &date={date} |
| Parameters | servicePointId = client system prefix + colon + unique id for service point in client system, for example tpr:3266 or ptv:91c3953f-146a-4738-9228-6a925f26b4f6 (both example ids refer to the same service point, so either can be used to get the PDF document) purpose = one of the following: – LAST_SENTENCE = service point’s current accessibility sentences – LAST_PLACE = service point’s current accessibility places with photos – LAST_QUESTION_ANSWER (default) = service point’s current answered questions – ARCHIVED_QUESTION_ANSWER = service point’s answered questions for any historical moment (see the date parameter) language = fi, sv, or en date = the historical moment (format yyyy-mm-dd) for service point’s answered questions (used with purpose=ARCHIVED_QUESTION_ANSWER) |
| Authorization | The PDF document does not require authorization. |
| Request sample | GET https://tpr.hel.fi/kapaesteettomyys_testi/api/pdfview/tpr:3266/?purpose=LAST_QUESTION_ANSWER&language=en GET https://tpr.hel.fi/kapaesteettomyys_testi/api/pdfview/tpr:3266/?purpose=ARCHIVED_QUESTION_ANSWER&language=en&date=2022-12-31 |
| Response sample (200 OK) | |
| Version history | |||
|---|---|---|---|
| # | Date | Author | Comments |
| v.0.1 | 22.11.2017 | EP / Affecto | Created |
| v.0.2 | 20.12.2017 | EP / Affecto | Coordinates added to “GET Service point” response sample |
| v.0.3 | 30.01.2018 | EP / CGI | New APIs added. Some API response properties renamed. Reference’s structure refactored. |
| v.0.4 | 02.02.2018 | EP / CGI | Valid coordinates are mandatory in “create/edit service point accessibility information” URL-interface + Heading & sample data fixes |
| v 0.5 | 26.10.2022 | AB / CGI | Added read-only summary url interface |
| v 0.6 | 16.2.2023 | JP / CGI | Added new queries for choices and places |
| v 0.7 | 21.9.2023 | JP / CGI | Added new url interface for PDF output |
| v 0.8 | 11.12.2023 | JP / CGI | Small fixes |