Yleiset käsittelysäännöt

Tämä sivu on alustava ja täydentyy syksyn 2026 aikana rajapintaversion 12 kehitystyön edetessä.

Sisällön julkaisemisen säännöt

Sisällön julkaiseminen

• Rajapintaversion 12 kautta voidaan tuoda ja päivittää ainoastaan julkaistu -tilaista sisältöä.
• Palvelun tai asiointikanavan kieliversion voi julkaista vain silloin, kun palvelun päävastuuorganisaatio tai asiointikanavan organisaatio on julkaistu kyseisellä kieliversiolla.

Sisällön hakeminen

• Rajapinnan kautta voidaan hakea vain julkaistua sisältöä.
• Poikkeus: Arkistoitua sisältöä (esim. palvelut ja asiointikanavat) voidaan hakea, jotta integraattori voi poistaa omasta järjestelmästään arkistoidun sisällön.

Sisällön näkyvyys suomi.fi-verkkopalvelussa

• Suomi.fi:ssä näkyvät ne organisaatiot, palvelut ja asiointikanavat, jotka on julkaistu. Mikäli organisaatiolla ei ole julkaistuja palveluita tai asiointikanavia, sen tietoja ei näytetä.

Tietojen yleiset säännöt

Sisällön tilan säännöt

• Sallitut tilasiirtymät ovat (täydentyy myöhemmin)

Kieliversiot

• Tietosisältöjen mahdolliset kieliversiot ovat suomi, ruotsi, englanti, pohjoissaame, inarinsaame ja koltansaame

Muotoiltu tekstikenttä

• Kenttään (esim. Palvelun kuvaus) voidaan syöttää tekstiä, jossa käytetään muotoiluja (esim. otsikot, listat, korostukset). Rajoitukset: kuvien ja hyperlinkkien lisääminen ei ole mahdollista. Rajapinta vastaanottaa ja palauttaa muotoilut Markdown -syntaksin mukaisesti.

Aluetiedot

• Valitse yksi seuraavista: Koko maa, Koko maa paitsi Ahvenanmaa, Rajattu alue
• Jos aluetiedoksi on valittu Rajattu alue, ks. kohta Aluetiedot -rajattu alue

Aluetiedot -rajattu alue

• Valitse vähintään yksi vaihtoehto (kunta, maakunta tai hyvinvointialue)
• Kunta: voidaan valita yksi tai useampi kunta
• Maakunta: voidaan valita yksi tai useampi maakunta
• Hyvinvointialue: voidaan valita yksi tai useampi hyvinvointialue
• Voit valita useita vaihtoehtoja kaikkiin seuraaviin kohtiin: Kunta, Maakunta, Hyvinvointialue. On siis mahdollista valita esim. kolme kuntaa, yksi maakunta ja yksi hyvinvointialue.

Palveluaika

• ks. Palveluaikojen käsittelysäännöt

Puhelinasiointikanavan puhelinnumero

• Suuntanumero on pakollinen
• Puhelinnumero on pakollinen. Maksimipituus on 20 merkkiä.
• Lisätieto on valinnainen. Maksimipituus on 300 merkkiä.
• Puhelun hintatieto on pakollinen. Valitse yksi seuraavista: Maksullinen, Maksuton, Lisämaksullinen
• Hintatiedon kuvaus on pakollinen, jos hintatiedoksi on valittu Lisämaksullinen. Maksimipituus on 300 merkkiä.

Verkkosivu

• Nimi on pakollinen
• Nimen maksimipituus on 100 merkkiä
• Verkko-osoite on pakollinen
• Verkko-osoitteen maksimipituus on 500 merkkiä
• Verkko-osoitteen alussa tulee olla merkkijono: http:// tai https://
• Kuvaus on valinnainen
• Kuvauksen maksimipituus on 500 merkkiä.

Sijaintitiedot

Voi olla katuosoite, muu sijaintieto tai ulkomainen osoite

Yhteystiedot

Voi olla sähköpostiosoite, faksinumero, puhelinnumero, verkkosivu tai postiosoite.

Postiosoite voi olla katuosoite, postilokero-osoite tai ulkomainen osoite.

Sähköpostiosoite

• Sähköpostiosoite on pakollinen
• Maksimipituus 100 merkkiä
• Lisätieto on valinnainen

Käytön tuki - sähköpostiosoite

• Sähköpostiosoite on pakollinen
• Maksimipituus 100 merkkiä

Faksinumero

• Maakohtainen suuntanumero on pakollinen
• Puhelinnumero on pakollinen.
• Puhelinnumeron maksimpituus on 20 merkkiä.

Puhelinnumero

• Onko suomalainen (valtakunnallinen) palvelunumero, johon ei voi soittaa ulkomailta, Kyllä/Ei
• Suuntanumero on pakollinen, jos "Onko kyseessä suomalainen (valtakunnallinen) palvelunumero" on Ei
• Puhelinnumero on pakollinen. Maksimpituus on 20 merkkiä.
• Lisätieto on valinnainen. Maksimpituus on 300 merkkiä.
• Puhelun hintatieto on pakollinen. Valitse yksi seuraavista: Maksullinen, Maksuton, Muu
• Hintatiedon kuvaus on pakollinen, jos hintatiedoksi on valittu Muu. Maksimipituus on 300 merkkiä.

Katuosoite

• Kadunnimi on pakollinen
• Kadunnimen makismipituus on 100 merkkiä
• Osoitenumero on valinnainen
• Osoitenumeron maksimipituus on 30 merkkiä
• Postinumero ja -toimipaikka on pakollinen
• Postinumeron maksimipituus on 5 merkkiä
• Osoitteen lisätieto on valinnainen. Maksimipituus on on 300 merkkiä.

Postilokero-osoite

• Postilokero-osoite on pakollinen. Maksimipituus on 30 merkkiä.
• Postinumero ja -toimipaikka on pakollinen
• Postinumeron maksimipituus on 5 merkkiä.
• Osoitteen lisätieto on valinnainen. Maksimipituus on on 300 merkkiä.

Muu sijaintitieto

• Postinumero ja -toimipaikka on valinnainen
• Postinumeron maksimipituus on 5 merkkiä
• Leveysaste on pakollinen
• Pituusaste on pakollinen
• Osoitteen lisätieto on valinnainen. Maksimipituus on on 300 merkkiä.

Ulkomainen osoite 

• Ulkomainen osoite vapaatekstinä on valinnainen. Maksimipituus on 500 merkkiä.
• Maa (maakoodi), jossa osoite sijaitse, on pakollinen.

PTV:n tietosisällön tunnisteet

Content id - PTV:n sisäinen tunnus

Sisällön yksilöivä, PTV:n generoima tunniste. Pysyy aina samana, vaikka sisällöstä tulee uusia versioita.

• Content id on uniikki PTV:n saman sisältötyypin sisällä

Content id - käyttö päivityksissä

• Content id:tä käytetään sisällön päivittämiseen API:n PUT-metodeilla

Version id -versiotunniste

Sisällön version yksilöivä PTV:n generoima tunniste. Kaikilla saman sisällön versioilla on sama content id ja eri version id.

PTV:n tietosisällön ulkoinen tunniste

ExternalId - ulkoinen tunniste

Sisällön yksilöivä, ulkoisen lähdejärjestelmän tunniste.

• ExternalId on uniikki PTV:n saman organisaation (API-tunnus) ja sisällön tyypin sisällä.
• Jos externalId:tä ei anneta luontivaiheessa, sitä ei voi lisätä myöhemmin.
• Huom. externalId:tä ei voi käyttää tunnuksena sisällön päivittämiseen API:n PUT- tai DELETE-metodeilla.

Esimerkit sisältötyypeittäin:

• Organisaatio: jokaisella organisaatiolla on oltava oma uniikki externalId. Se voi olla sama kuin jonkin palvelun tai kanavan ExternalId.
• Palvelu: jokaisella palvelulla on oltava oma uniikki externalId. Se voi olla sama kuin jonkin organisaation tai kanavan ExternalId.
• Asiointikanava: jokaisella asiointikanavalla on oltava oma uniikki externalId. Se voi olla sama kuin jonkin organisaation tai palvelun ExternalId.
• Poikkeus: eri asiointikanavatyypit (esim. puhelinkanava ja palvelupiste) eivät saa käyttää samaa ExternalIdtä.