OmaPTV attribuutit

Ohita sivuvalikko ja siirry sisältöön

Services-attribuutit

id

  • Kuvaus: Objektin yksilöivä tunniste.
  • Tyyppi: UUID
  • Esimerkkiarvo: "bfc46496-fa78-450e-81e9-6fea1b854b35"

type

  • Kuvaus: Objektin tyyppi. Palveluiden tapauksessa arvo on aina "Service".
  • Tyyppi: string
  • Mahdolliset arvot: "Service"
  • Esimerkkiarvo: "Service"

fundingType

  • Kuvaus: Palvelun rahoitustyyppi.
  • Tyyppi: string
  • Mahdolliset arvot:
    • "PubliclyFunded" – Julkisesti rahoitettu
    • "MarketFunded" – Markkinarahoitteinen
  • Esimerkkiarvo: "PubliclyFunded"

serviceChargeType

  • Kuvaus: Palvelun maksullisuus.
  • Tyyppi: string
  • Mahdolliset arvot:
    • null – Maksuton
    • "Chargeable" – Maksullinen
  • Esimerkkiarvo: "Chargeable"

areaType

  • Kuvaus: Palvelun alue.
  • Tyyppi: string
  • Mahdolliset arvot:
    • "LimitedType" – Rajoitettu
    • "Nationwide" – Kansallinen
  • Esimerkkiarvo: "Nationwide"

languages

  • Kuvaus: Palvelun tarjoamisen kielet. Lista kielikoodeista, jotka kuvaavat millä kielillä palvelu on saatavilla.
  • Tyyppi: string[]
  • Mahdolliset arvot:
    • "fi" – Suomenkielinen palvelu
    • "sv" – Ruotsinkielinen palvelu
    • "en" – Englanninkielinen palvelu
    • "<kielikoodi>" – Muu kieli ISO 639-1 -standardin mukaisella kielikoodilla
  • Esimerkkiarvo: ["fi", "sv", "en"]

serviceClasses

  • Kuvaus: Palveluluokat, jotka kuvaavat mihin palvelukokonaisuuteen palvelu kuuluu. Kukin luokka sisältää nimen ja kuvauksen eri kielillä sekä luokittelutietoa.
  • Tyyppi: object[] (lista palveluluokkaobjekteja)

name

  • Kuvaus: Palveluluokan nimi eri kielillä
  • Tyyppi: object[]
  • Rakenne:
    language: string – Kielikoodi (esim. "fi", "en", "sv")
    value: string – Nimen teksti kyseisellä kielellä
  • Esimerkkiarvo:
      {
      "language": "fi",
      "value": "Lastensuojelu"
      }

description

  • Kuvaus: Palveluluokan kuvaus eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
  • language: string – Kielikoodi
  • value: string – Kuvausteksti kyseisellä kielellä
  • Esimerkkiarvo:
     {
     "language": "en",
     "value": "This service subclass contains services that safeguard   
     children’s growth environment..."
     }

code

  • Kuvaus: Palveluluokan koodi, joka yksilöi luokan.
  • Tyyppi: string
  • Rakenne: "P3.8"

ontologyType

  • Kuvaus: Ontologiatyyppi, joka kertoo luokan lähteen tai rakenteen.
  • Tyyppi: string
  • Esimerkkiarvo: "ptvserclass"

uri, newUri

  • Kuvaus: Luokan yksilöivä URI vanhassa ja uudessa muodossa.
  • Tyyppi: string
  • Rakenne: "http://uri.suomi.fi/codelist/ptv/ptvserclass2/code/P3.8

parentId, parentUri, newParentUri

  • Kuvaus: Viittaus ylempään palveluluokkaan.
  • Tyyppi: string tai null
  • Esimerkkiarvo: "77af99fa-93eb-4de6-ac83-1b161a961263"

ontologyTerms

  • Kuvaus: Palveluun liittyvät ontologiset termit, jotka kuvaavat palvelun sisältöä tai aihepiiriä semanttisesti. Termit perustuvat eri ontologioihin, kuten YSO tai JUPO.
  • Tyyppi: object[] – Lista ontologiatermiobjekteja

name

  • Tyyppi: object[]
  • Rakenne:
  • language: string – Kielikoodi (esim. "fi", "en", "sv")
  • value: string – Nimi kyseisellä kielellä
  • Esimerkki:

{
"language": "fi",
"value": "turvakodit"
}

ontologyType

  • Kuvaus: Ontologian tyyppi, josta termi on peräisin.
  • Tyyppi: string
  • Mahdolliset arvot: "YSO", "JUPO" jne.
  • Esimerkkiarvo: "YSO"

uri

  • Kuvaus: Termin yksilöivä URI-osoite.
  • Tyyppi: string
  • Esimerkkiarvo: "http://www.yso.fi/onto/koko/p4502"

parentUri

  • Kuvaus: Termin yläkäsite tai hierarkisesti ylempi termi.
  • Tyyppi: string
  • Esimerkkiarvo: "http://www.yso.fi/onto/koko/p48190"

code

  • Kuvaus: Termin mahdollinen koodi (usein null, ei aina käytössä).
  • Tyyppi: string | null
  • Esimerkkiarvo: null

boost

  • Kuvaus: Termin painotusarvo haussa tai luokittelussa (usein null).
  • Tyyppi: number | null
  • Esimerkkiarvo: null

targetGroups

  • Kuvaus: Palvelun kohderyhmät, eli ne ihmisryhmät, joille palvelu on suunnattu. Kukin kohderyhmä on kuvattu ontologisella termillä, joka sisältää nimen eri kielillä ja luokittelutietoa.
  • Tyyppi: object[] – Lista kohderyhmäobjekteja

name

  • Kuvaus: Kohderyhmän nimi eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
  • language: string – Kielikoodi (esim. ”fi”, ”en”, ”sv”)
  • value: string – Nimi kyseisellä kielellä
  • Esimerkki:

{
"language": "fi",
"value": "Nuoret"
}

code

  • Kuvaus: Kohderyhmän yksilöivä koodi.
  • Tyyppi: string
  • Esimerkkiarvo: "KR1.3"

ontologyType

  • Kuvaus: Ontologian tyyppi, josta kohderyhmä on peräisin.
  • Tyyppi: string
  • Mahdolliset arvot: "ptvkohderyhmat"
  • Esimerkkiarvo: "ptvkohderyhmat"

uri, newUri

  • Kuvaus: Kohderyhmän yksilöivä URI vanhassa ja uudessa muodossa.
  • Tyyppi: string
  • Esimerkkiarvo: "http://uri.suomi.fi/codelist/ptv/ptvkohderyhmat/code/KR1.3"

parentId, parentUri, newParentUri

  • Kuvaus: Viittaus ylempään kohderyhmään, jos kyseessä on alaryhmä.
  • Tyyppi: string | null
  • Esimerkkiarvo: "daff1fb9-9394-49b5-b033-d1d1c7005ab6"

boost

  • Kuvaus: Painotusarvo haussa tai luokittelussa (usein null).
  • Tyyppi: number | null
  • Esimerkkiarvo: null

lifeEvents

  • Kuvaus: Elämäntilanteet, joihin palvelu liittyy. Kukin elämäntapahtuma on kuvattu ontologisella termillä, joka sisältää nimen eri kielillä ja yksilöivän URI:n.
  • Tyyppi: object[] – Lista elämäntapahtumaobjekteja

name

  • Kuvaus: Elämäntapahtuman nimi eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
  • language: string – Kielikoodi (esim. ”fi”, ”en”, ”sv”)
  • value: string – Nimi kyseisellä kielellä
  • Esimerkki:

{
"language": "fi",
"value": "Avioero"
}

code

  • Kuvaus: Elämäntapahtuman yksilöivä koodi.
  • Tyyppi: string
  • Esimerkkiarvo: "KE7"

uri

  • Kuvaus: Elämäntapahtuman yksilöivä URI-osoite.
  • Tyyppi: string
  • Esimerkkiarvo: "http://urn.fi/URN:NBN:fi:au:ptvl:v3017"

ontology

  • Kuvaus: Ontologian nimi, josta elämäntapahtuma on peräisin
  • Tyyppi: string | null
  • Esimerkkiarvo: null

boost

  • Kuvaus: Painotusarvo haussa tai luokittelussa
  • Tyyppi: number | null
  • Esimerkkiarvo: null

industrialClasses (TBD)

legislation

  • Kuvaus: Palveluun liittyvä lainsäädäntö. Kukin lakiviite sisältää nimen eri kielillä ja linkin verkkosivulle, jossa laki on saatavilla.
  • Tyyppi: object[] – Lista lainsäädäntöobjekteja

names

  • Kuvaus: Lainsäädännön nimi eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
  • language: string – Kielikoodi (esim. "fi", "en", "sv”)
  • value: string – Lain nimi kyseisellä kielellä
  • Esimerkki:

{
"language": "fi",
"value": "Turvakotilaki"
}

webPages

  • Kuvaus: Linkit lainsäädäntöön eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
  • url: string – Verkkosivun osoite, jossa laki on saatavilla
  • language: string – Kielikoodi
  • value: string | null – Linkin kuvaus

{
"url": "
http://www.finlex.fi/fi/laki/ajantasa/2014/20141354
",
"language": "fi",
"value": null
}

requirements

  • Kuvaus: Palvelun käyttöön liittyvät vaatimukset, ehdot tai rajoitukset. Vaatimukset voivat sisältää esimerkiksi kohderyhmän määrittelyä, maksuttomuutta, alueellisia rajoituksia tai muita ehtoja. Kukin vaatimus on kielikohtainen tekstikenttä.
  • Tyyppi: object[] -Lista vaatimustekstejä

language

Kuvaus: Vaatimuksen kieli.
Tyyppi: string
Mahdolliset arvot: "fi", "sv", "en" jne.
Esimerkkiarvo: "fi"

value

Kuvaus: Vaatimuksen sisältö tekstimuodossa.
Tyyppi: string | null
Esimerkkiarvo:

"Palvelu on asiakkaalle maksuton ja tarkoitettu lähisuhdeväkivaltaa kokeville tai sen uhan alla eläville iästä, sukupuolesta ja asuinkunnasta riippumatta."

type

Kuvaus: Vaatimuksen tyyppi
Tyyppi: string | null
Esimerkkiarvo: null

organizations

  • Kuvaus: Palveluun liittyvät organisaatiot ja niiden roolit. Kukin organisaatio voi olla vastuussa palvelusta tai tuottaa sen. Lisäksi voidaan antaa lisätietoa palvelun tuottamisesta.
  • Tyyppi: object[] -Lista vaatimustekstejä

organization

  • Kuvaus: Organisaation tunnistetiedot.
  • Tyyppi: object | null
  • Rakenne:
  • id: string – Organisaation yksilöivä tunniste (UUID)
  • name: string – Organisaation nimi
  • Esimerkki:

{
"id": "3e8356bd-377f-4cad-97b1-a027bd4bbf25",
"name": "Etelä-Karjalan hyvinvointialue"
}

roleType

  • Kuvaus: Organisaation rooli palvelussa.
  • Tyyppi: string
  • Mahdolliset arvot:
  • "Responsible" – Vastuutaho
  • "Producer" – Palvelun tuottaja
  • Esimerkkiarvo: "Producer"

provisionType

  • Kuvaus: Palvelun tuottamisen tapa.
  • Tyyppi: string | null
  • Mahdolliset arvot:
  • "SelfProducedServices" – Organisaatio tuottaa palvelun itse
  • "ProcuredServices" – Palvelu on hankittu ulkopuoliselta tuottajalta
  • "Other" – Muu tuotantotapa
  • Esimerkkiarvo: "SelfProducedServices"

additionalInformation

  • Kuvaus: Vapaamuotoista lisätietoa palvelun tuottamisesta, kielikohtaisesti.
  • Tyyppi: object[]
  • Rakenne:
  • value: string – Lisätiedon teksti
  • language: string – Kielikoodi
  • id: string | null – Lisätiedon tunniste
  • ownerReferenceId: string | null – Viittaus omistajaan
  • Esimerkki:

{
"value": "Turvakotia ylläpitää Eksote. Toimintaa koordinoi ja rahoittaa Terveyden ja hyvinvoinnin laitos THL.",
"language": "fi",
"id": null,
"ownerReferenceId": null
}

serviceDescriptions

  • Kuvaus: Palvelun kuvaustekstit eri kielillä ja eri käyttötarkoituksiin. Kukin kuvaus sisältää tekstin, sen tyypin ja kielikoodin. Tyyppi määrittää, mihin tarkoitukseen kuvaus on tarkoitettu (esim. tiivistelmä, käyttöohje, tarkempi kuvaus).
  • Tyyppi: object[] – Lista kuvausobjekteja

language

  • Kuvaus: Kuvaustekstin kieli.
  • Tyyppi: string
  • Mahdolliset arvot: "fi", "sv", "en" jne.
  • Esimerkkiarvo: "fi"

type

  • Kuvaus: Kuvaustekstin tyyppi, joka määrittää sen käyttötarkoituksen.
  • Tyyppi: string
  • Mahdolliset arvot:
  • "Summary" – Lyhyt yhteenveto palvelusta
  • "Description" – Tarkempi kuvaus palvelun sisällöstä
  • "UserInstruction" – Käyttöohje tai toimintaohje asiakkaalle
  • "ChargeTypeAdditionalInfo" – Lisätietoa maksullisuudesta
  • "ProcessingTime" – Käsittelyaika
  • "DeadLine" – Viimeinen hakupäivä tai määräaika
  • "ValidityTime" – Palvelun voimassaoloaika
  • Esimerkkiarvo: "UserInstruction"

value

  • Kuvaus: Kuvaustekstin sisältö.
  • Tyyppi: string | null
  • Esimerkkiarvo:

"Soita tai tule suoraan turvakodille"

keywords

  • Kuvaus: Palveluun liittyvät avainsanat, jotka kuvaavat sen sisältöä, aihepiiriä tai käyttötarkoitusta. Avainsanoja käytetään esimerkiksi haussa, luokittelussa tai käyttöliittymässä palvelun tunnistamiseen. Kukin avainsana on kielikohtainen.
  • Tyyppi: object[] – Lista avainsanaobjekteja

language

  • Kuvaus: Avainsanan kieli.
  • Tyyppi: string
  • Mahdolliset arvot: "fi", "sv", "en" jne.
  • Esimerkkiarvo: "fi"

value

  • Kuvaus: Avainsanan tekstisisältö.
  • Tyyppi: string
  • Esimerkkiarvo:

”perheväkivalta”

type

  • Kuvaus: Avainsanan tyyppi
  • Tyyppi: string | null
  • Esimerkkiarvo: null

serviceNames

  • Kuvaus: Palvelun viralliset ja vaihtoehtoiset nimet eri kielillä. Nimi voi olla pääasiallinen nimi tai vaihtoehtoinen nimi, jota käytetään esimerkiksi markkinoinnissa tai arkikielessä.
  • Tyyppi: object[] – Lista nimiobjekteja

language

  • Kuvaus: Nimen kieli.
  • Tyyppi: string
  • Mahdolliset arvot: "fi", "sv", "en" jne.
  • Esimerkkiarvo: "fi"

type

  • Kuvaus: Nimen tyyppi.
  • Tyyppi: string
  • Mahdolliset arvot:
  • "Name" – Virallinen tai ensisijainen nimi
  • "AlternativeName" – Vaihtoehtoinen nimi
  • Esimerkkiarvo: "AlternativeName"

value

  • Kuvaus: Nimen tekstisisältö.
  • Tyyppi: string
  • Esimerkkiarvo:

"Perheasiain neuvottelukeskus"

areas

  • Kuvaus: Palvelun maantieteellinen kattavuus. Kenttä sisältää alueellisia tietoja, kuten kuntia, joilla palvelu on saatavilla. Kukin alue voi olla tyyppiä ”Municipality” ja sisältää kuntakohtaiset tiedot eri kielillä.
  • Tyyppi: object[] – Lista alueobjekteja

type

  • Kuvaus: Alueen tyyppi.
  • Tyyppi: string
  • Mahdolliset arvot:
  • "Municipality" – Kunta
  • (Mahdollisesti muita arvoja, kuten "Region", "PostalCodeArea")
  • Esimerkkiarvo: "Municipality"

code

  • Kuvaus: Alueen yksilöivä koodi (usein null pääalueella, mutta käytössä kuntien kohdalla).
  • Tyyppi: string | null
  • Esimerkkiarvo: null

names

  • Kuvaus: Alueen nimi eri kielillä
  • Tyyppi: object[]
  • Esimerkkiarvo: []

municipalities

  • Kuvaus: Kunnat, joilla palvelu on saatavilla.
  • Tyyppi: object[]

code

  • Kuvaus: Kunnan yksilöivä koodi
  • Tyyppi: string
  • Esimerkkiarvo: "405"

name

  • Kuvaus: Kunnan nimi eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
  • language: string – Kielikoodi
  • value: string – Kunnan nimi kyseisellä kielellä
  • Esimerkki:

{
"language": "fi",
"value": "Lappeenranta"
}

generalDescriptionId

  • Kuvaus: Viittaus palvelun pohjakuvaukseen, joka on yhteinen usealle palvelulle. Pohjakuvaus sisältää yleistä tietoa palvelutyypistä, sen tarkoituksesta ja sisällöstä.
  • Tyyppi: string (UUID)
  • Esimerkkiarvo: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

generalDescription

  • Kuvaus: Pohjakuvauksen varsinainen sisältö (jos ladattu mukaan). Sisältää rakenteellisesti samanlaista tietoa kuin yksittäinen palveluobjekti, mutta kuvaa palvelutyyppiä yleisellä tasolla.
  • Tyyppi: object | null
  • Esimerkkiarvo: null (jos ei ladattu)

serviceChannels

  • Kuvaus: Palvelukanavat, joiden kautta palvelu on saatavilla. Kukin kanava sisältää kuvauksen, aukioloajat ja mahdolliset lisätiedot. Palvelukanavat voivat olla esimerkiksi puhelinpalveluita, asiointipisteitä, verkkosivuja tai sähköisiä asiointikanavia.
  • Tyyppi: object[] -Lista palvelukanavaobjekteja

serviceChargeType

  • Kuvaus: Palvelukanavan maksullisuustyyppi.
  • Tyyppi: string
  • Esimerkkiarvo: "FreeOfCharge"

description

  • Kuvaus: Palvelukanavan kuvaus eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
  • value: string – Kuvausteksti
  • type: string – Kuvaustyypin tunniste
  • language: string – Kielikoodi
  • ownerReferenceId: string – Viittaus omistavaan objektiin
  • orderNumber: number – Järjestysnumero
  • inherited: boolean – Onko kuvaus peritty
  • Esimerkki:

{
"value": "Palvelu on saatavilla puhelimitse arkisin klo 8–16.",
"type": "Description",
"language": "fi",
"ownerReferenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"orderNumber": 0,
"inherited": true
}

serviceHours

  • Kuvaus: Palvelukanavan aukioloajat ja niihin liittyvät lisätiedot.
  • Tyyppi: object[]
🔸 serviceHourType
  • Kuvaus: Aukioloajan tyyppi (esim. normaali, poikkeava).
  • Tyyppi: string
🔸 validFrom, validTo
  • Kuvaus: Aukioloajan voimassaoloaika.
  • Tyyppi: datetime
  • Esimerkkiarvo: "2025-10-09T10:36:53.609Z"
🔸 isClosed, isAlwaysOpen, isReservation, validForNow
  • Kuvaus: Boolean-arvot, jotka kuvaavat onko palvelu suljettu, aina avoinna, vaatiiko ajanvarausta ja onko voimassa nyt.
  • Tyyppi: boolean
🔸 additionalInformation
  • Kuvaus: Aukioloaikaan liittyvä lisätieto eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
  • value: string
  • language: string
  • id: string
  • ownerReferenceId: string
🔸 openingHour
  • Kuvaus: Päivittäiset aukioloajat.
  • Tyyppi: object[]
  • Rakenne:
  • dayFrom, dayTo: string – Viikonpäivät (esim. "Monday")
  • from, to: string – Kellonajat (esim. "08:00", "16:00")
  • order: number
  • ownerReferenceId: string

serviceChannelLinks

  • Kuvaus: Linkit palvelukanaviin, joiden kautta palvelu on saatavilla. Kukin linkki sisältää viittauksen palvelukanavaobjektiin, mahdolliset yhteystiedot ja kuvauksen.
  • Tyyppi: object[] -Lista palvelukanavalinkkejä

serviceChannel

  • Kuvaus: Palvelukanava, johon linkki viittaa. Sisältää kanavan tunnisteen ja nimen.
  • Tyyppi: object
  • Rakenne:
  • id: string – Palvelukanavan yksilöivä tunniste (UUID)
  • name: string – Palvelukanavan nimi
  • Esimerkki:

{
"id": "513c24f5-e723-4cc8-82c5-6c6c87d083f6",
"name": "Sosiaalipäivystys"
}

contactDetails

  • Kuvaus: Palvelukanavan yhteystiedot, kuten puhelinnumerot, sähköpostit, osoitteet ja verkkosivut.
  • Tyyppi: object | null
  • Rakenne:
  • emails: string[]
  • phoneNumbers: string[]
  • addresses: object[]
  • webPages: object[] (sisältää url, value, language)
  • Esimerkki:

{

"webPages": [

{
"url": "https://sote.kainuu.fi/palvelut/paivystyspalvelut",
"value": "Kainuun sote, päivystyspalvelut",
"language": "fi"
}
]
}

description

  • Kuvaus: Palvelukanavan kuvaus eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
  • language: string
  • value: string
  • Esimerkki:

{
"language": "fi",
"value": "Palvelukanava tarjoaa kiireellistä sosiaalipalvelua ympäri vuorokauden."
}

code

  • Kuvaus: Mahdollinen koodi palvelukanavalinkille.
  • Tyyppi: string | null
  • Esimerkkiarvo: null

Organisaatio-objektin attribuutit

id

  • Kuvaus: Organisaation yksilöivä tunniste.
  • Tyyppi: UUID
  • Esimerkkiarvo: "900c1121-8146-48ef-9c21-0ef5cf0fae84"

organizationType

  • Kuvaus: Organisaation tyyppi.
  • Tyyppi: string
  • Mahdolliset arvot: "Municipality", "RegionalOrganization", "Company", "State", "Organization"
  • Esimerkkiarvo: "RegionalOrganization"

businessCode

  • Kuvaus: Organisaation Y-tunnus.
  • Tyyppi: string | null
  • Esimerkkiarvo: "1958694-5"

organizationRootId

  • Kuvaus: Organisaation juuritunniste (sama kuin id jos kyseessä pääorganisaatio).
  • Tyyppi: UUID
  • Esimerkkiarvo: "900c1121-8146-48ef-9c21-0ef5cf0fae84"

municipality

  • Kuvaus: Organisaation sijaintikunta.
  • Tyyppi: object | null
  • Rakenne:
    • code: string – Kuntakoodi (esim. "091")
    • name: object[] – Kunnan nimi eri kielillä
  • Esimerkkiarvo:

{
"code": "091",
"name": [
{ "language": "fi", "value": "Helsinki" },
{ "language": "sv", "value": "Helsingfors" },
{ "language": "en", "value": "Helsinki" }
]
}

organizationDescriptions

  • Kuvaus: Organisaation kuvaustekstit eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
    • language: string
    • type: string – "Summary" tai "Description"
    • value: string | null

organizationNames

  • Kuvaus: Organisaation viralliset ja vaihtoehtoiset nimet.
  • Tyyppi: object[]
  • Rakenne:
    • language: string
    • type: string – "Name" tai "AlternativeName"
    • value: string

displayNameType

  • Kuvaus: Näytettävä nimi eri kielillä
  • Tyyppi: object[]

emails

  • Kuvaus: Organisaation sähköpostiosoitteet.
  • Tyyppi: object[]
  • Rakenne:
    • language: string
    • value: string
    • orderNumber: number

phoneNumbers

  • Kuvaus: Organisaation puhelinnumerot.
  • Tyyppi: object[]
  • Rakenne:
    • number: string
    • prefixNumber: string
    • language: string
    • serviceChargeType: string
    • additionalInformation: string | null

webPages

  • Kuvaus: Organisaation verkkosivut.
  • Tyyppi: object[]
  • Rakenne:
    • url: string
    • value: string
    • language: string

addresses

  • Kuvaus: Organisaation osoitteet (käynti- ja postiosoitteet).
  • Tyyppi: object[]
  • Rakenne:
    • type: "Visiting" tai "Postal"
    • subType: "Street" tai "PostOfficeBox"
    • streetAddress / postOfficeBoxAddress: object
    • postalCode: string
    • postOffice: object[]
    • municipality: object
    • latitude, longitude: string
    • coordinateState: string

Servicechannel-objektin attribuutit

id

  • Kuvaus: Palvelukanavan yksilöivä tunniste.
  • Tyyppi: string (GUID)

organizationId

  • Kuvaus: Tunniste organisaatiolle, joka tarjoaa palvelukanavan.
  • Tyyppi: string (GUID)

serviceChannelType

  • Kuvaus: Palvelukanavan tyyppi.
  • Tyyppi: string
  • Mahdolliset arvot: Phone, WebPage, EChannel, ServiceLocation, PrintableForm

sourceId

  • Kuvaus: Ulkoisen järjestelmän tunniste, jos käytössä.
  • Tyyppi: string | null

serviceChannelName

  • Kuvaus: Palvelukanavan virallinen nimi.
  • Tyyppi: string | null

alternativeName

  • Kuvaus: Vaihtoehtoinen nimi.
  • Tyyppi: string | null

areaType

  • Kuvaus: Palvelukanavan alueellinen kattavuus.
  • Tyyppi: string
  • Mahdolliset arvot: esim. LimitedType, Nationwide

serviceChannelDescriptions

  • Kuvaus: Palvelukanavan kuvaustekstit eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
  • language: string (fi, sv, en, jne.)
  • type: string (Summary, Description)
  • value: string

serviceChannelNames

  • Kuvaus: Palvelukanavan nimet eri kielillä.
  • Tyyppi: object[]
  • Rakenne:
  • language: string
  • type: string (Name, ShortName)
  • value: string

areas

  • Kuvaus: Alueet, joilla palvelu on saatavilla.
  • Tyyppi: object[]
  • Rakenne:
  • type: string (Municipality, Province, jne.)
  • municipalities: object[]
  • code: string
  • name: object (kieliversiot)

serviceHours

  • Kuvaus: Palvelukanavan aukioloajat.
  • Tyyppi: object[]
  • Rakenne:
  • serviceHourType: string (DaysOfTheWeek, SpecialDays, OverMidnight)
  • openingHour: object[]
  • dayFrom, dayTo: string
  • from, to: string (kellonajat)
  • isClosed, isAlwaysOpen, isReservation: boolean
  • additionalInformation: object[] – Kieliversiot

languages

  • Kuvaus: Palvelukanavan tarjoamisen kielet.
  • Tyyppi: string[]
  • Esimerkkiarvo: ["fi", "sv", "en"]

webPages

  • Kuvaus: Verkkosivujen URL-osoitteet.
  • Tyyppi: object[]
  • Rakenne:
  • url: string
  • language: string
  • value: string | null

phoneNumbers

  • Kuvaus: Palvelukanavan puhelinnumerot.
  • Tyyppi: object[]
  • Rakenne:
  • type: string (Phone, Fax, Sms)
  • number: string
  • prefixNumber: string
  • language: string
  • serviceChargeType: string (Chargeable, FreeOfCharge)
  • additionalInformation: string | null

supportEmails

  • Kuvaus: Tukisähköpostiosoitteet.
  • Tyyppi: object[]
  • Rakenne:
  • language: string
  • value: string

supportPhones

  • Kuvaus: Tukipuhelinnumerot.
  • Tyyppi: object[]
  • Rakenne kuten phoneNumbers

addresses

  • Kuvaus: Organisaation osoitteet (käynti- ja postiosoitteet).
  • Tyyppi: object[]
  • Rakenne:
  • type: "Visiting" tai "Postal"
  • subType: "Street" tai "PostOfficeBox"
  • streetAddress / postOfficeBoxAddress: object
  • postalCode: string
  • postOffice: object[]
  • municipality: object
  • latitude, longitude: string
  • coordinateState: string

deliveryAddresses

  • Kuvaus: Toimitusosoitteet, jos palvelu toimitetaan fyysisesti.
  • Tyyppi: object[]
  • Rakenne kuten addresses

channelUrls

  • Kuvaus: Linkit sähköisiin asiointikanaviin.
  • Tyyppi: object[]
  • Rakenne:
  • url: string
  • language: string
  • value: string | null

services

  • Kuvaus: Palvelut, joihin kanava liittyy.
  • Tyyppi: object[]
  • Rakenne:
  • service: object
  • id: string
  • muut metatiedot (TBD)

serviceCollections

  • Kuvaus: Palvelukokoelmat, joihin kanava kuuluu.
  • Tyyppi: object[]
  • TBD

ontologyTerms

  • Kuvaus: Ontologiset termit (YSO, JUPO jne.).
  • Tyyppi: object[]
  • Rakenne:
  • ontologyType: string
  • uri: string
  • name: object

organization

  • Kuvaus: Organisaation tiedot.
  • Tyyppi: object
  • Rakenne: (TBD)
  • id, organizationType, businessCode
  • organizationNames, organizationDescriptions
  • emails, phoneNumbers, webPages, addresses

publishingStatus

  • Kuvaus: Julkaisun tila.
  • Tyyppi: string
  • Mahdolliset arvot: Published, Draft, Deleted

modified

  • Kuvaus: Viimeisin muokkauspäivämäärä.
  • Tyyppi: string (ISO 8601 -muoto)

Liity uutiskirjeen tilaajaksi

Uutiskirjeen tilaajana saat kerran kuukaudessa ajankohtaista tietoa yhtiössämme käynnissä olevista projekteista sekä muista ajankohtaisista asioista.

Tilaa uutiskirje