Tällä sivulla on kuvattuna rajapinnan käyttäjän näkökulmasta vaadittuja muutoksia, joita on tehtävä Metsänhoidon suositusten rajapintaa käyttävissä sovelluksissa, kun siirrytään rajapinnan versiosta 1 käyttämään rajapinnan versiota 2.
Yleisiä muutoksia
Rajapintavastaukset tulevat aina taulukkona (järjestetty luettelo, jossa nolla tai useampi alkio) riippumatta siitä, onko haettu yhtä vai useampaa tietuetta rajapinnasta. Näin ollen rajapinnan uudessa versiossa voi hakea useita tietueita yhdellä kyselyllä. Huom: mikäli tietuetta tietyllä tunnisteella ei löydy rajapinnasta, rajapinta ei palauta enää virhettä vaan vastauksena on joko tyhjä taulukko tai taulukko, jossa on vain osa haetuista tietueista.
Alla esiteltyjä tietorakenteen muutoksia on kuvattu JSONPath-syntaksilla(ulkoinen linkki). Ko. syntaksissa JSON-muotoisen rajapintavastauksen "juuri" (root) on esitetty $-merkillä ja rajapintavastauksen taulukon n:nteen elementtiin viitataan [n]-notaatiolla.
Toimenpiteen kuvaus – tietorakenteen muutokset
URL-osoite metsänhoidon suosituksiin: muuttunut sijainti tietorakenteessa
v1: $.canonical.url
v2: $[n].url
Pääkuvan kuvateksti: muuttunut sijainti tietorakenteessa
v1: $.caption
v2: $[n].image.caption
Pääkuvan media: muuttunut sijainti tietorakenteessa
v1: $.media[0]
v2: $[n].image.media
Päätöksenteko-sisältöviittaukset: muuttunut nimi tietorakenteessa
v1: $.goodPractices
v2: $[n].decisionMakingDescriptions
Toteutus-sisältöviittaukset: muuttunut nimi tietorakenteessa
v1: $.realisations
v2: $[n].realisationDescriptions
Sisällön metatiedot: poistunut kokonaan tietorakenteesta
v1: $.meta
v2: poistunut; metatiedot ovat mm. Metsänhoidon suositusten hakukoneoptimointia varten eivätkä näin ollen tarkoituksenmukaisia rajapinnassa.
Päätöksenteko – tietorakenteen muutokset
Rajapintapäätepisteen nimi muuttunut
v1: /v1/good-practices
v2: /v2/decision-making-descriptions
Pääkuvan kuvateksti: muuttunut sijainti tietorakenteessa
v1: $.caption
v2: $[n].image.caption
Pääkuvan media: muuttunut sijainti tietorakenteessa
v1: $.media[0]
v2: $[n].image.media
Toteutus – tietorakenteen muutokset
Rajapintapäätepisteen nimi muuttunut
v1: /v1/realisations
v2: /v2/realisation-descriptions
Pääkuvan kuvateksti: muuttunut sijainti tietorakenteessa
v1: $.caption
v2: $[n].image.caption
Pääkuvan media: muuttunut sijainti tietorakenteessa
v1: $.media[0]
v2: $[n].image.media
Toimenpiteen hakeminen työlajikoodilla
API versio 1:
Rajapintakutsu: /v1/operation-descriptions/890?by=operationTypeCode
API versio 2:
Rajapinnan uudessa versiossa toimenpiteillä on search-niminen päätepiste, josta toimenpiteitä voi hakea metsästandardikoodilla forestInformationStandard-nimisellä parametrilla (katso rajapinnan dokumentaatio(ulkoinen linkki)).
Rajapintakutsu: /v2/operation-descriptions/search?forestInformationStandard[SilvicultureTypeType]=890&langcode=fi
Huomaa, että rajapinnan uudessa versiossa on määritettävä koodiston nimi, jonka koodilla tuloksia halutaan hakea. Yhdistekoodiston nimeä (esimerkkitapauksessa OperationTypeType) ei voi käyttää, vaan on käytettävä varsinaista koodistonimeä.