Ohjelmointirajapinta mahdollistaa sekä aineistojen noudon, että aineistojen tuonnin Netvisoriin. Rajapinnan tarjoamat resurssit on jaettu ylätason kategorioihin.
Yhteistä kaikille tapahtumille on:

  • Päivämäärät ovat ANSI–muodossa
  • Maakoodit ovat aina ISO 3166 –muodossa
  • Liitteet ovat aina Base64 -enkoodattuna XML-sanomaan
  • Tyhjiä elementtejä ei tarvitse kirjoittaa XML-sanomaan, esimerkiksi päivityspyynnössä tyhjä elementti tulkitaan rajapinnassa käskyksi päivittää arvo tyhjäksi
  • Pakollisia kenttiä ei tule jättää tyhjäksi
  • Elementtien täytyy olla DTD:n mukaisessa järjestyksessä

Skandinaavisten kirjainten (Ä, ä, Ö, ö tai Å, å) saamiseksi käyttöliittymään on sanoman oltava UTF-8-enkoodatussa muodossa, mutta xml deklaraatiota ei kuitenkaan tarvita. Netvisorin palvelinpuoli tekee sisällölle tarvittavat esikäsittelyt, jolloin aineiston tulee aina alkaa <root>.

Lähetä yksi kutsu kerrallaan ja odota vastausta ennen seuraavan kutsun lähetystä. Päällekkäiset kutsut samaan asiakasympäristöön aiheuttavat erilaisia virhetilanteita asiakkaiden ympäristössä.
Kutsujen aikakatkaisuksi suosittelemme vähintään 360 000 ms. Näin vältät turhat virhetilanteet.
Tee isot haut ja tietojen siirrot virka-ajan ulkopuolella, jollei niiden siirtoon virka-aikana ole erityistä tarvetta. Tietojen siirron aiheellinen tiheys eroaa resurssi- ja käyttötapauskohtaisesti. Monissa tapauksissa siirto kerran vuorokaudessa tai kuukaudessa riittää. Voit nopeuttaa siirtoja myös sopivilla rajauksilla käyttäen resurssien parametreja.

Tulkintaohje

Ohessa on kuvattu integraatiorajapinnan eri merkintöjen tarkoitus ja tulkinnat.
Eri sanomien XML-rakenne on kuvattu taulukkomuotoisesti niistä kohdista sanomia kun se on mahdollista ja loogista. XML:n rakenteellisuudesta johtuen kuvauksissa on jouduttu käyttämään esimerkiksi viittauksia ohjeistuksen eri kohtiin, jotta kokonaisuus on pysynyt selkeänä.

Rakennekuvausten perusrakenne on seuraava
Kutsu:

  • Perustiedot
    • Käytettävä resurssi
    • GET - yleinsä datan noutoa Netvisorista
    • POST - yleinsä datan tuontia Netvisoriin
  • Parametrit
    • Yleinsä QueryString:ssä määritettäviä, erotetaan varsinaisesta resurssista ? merkillä ja tämän jälkeen & merkillä
    • Kaikilla ei ole
  • XML-rakenne dataa tuotaessa (POST)
    • Kuvattu XML:n rakenne sekä esim. elementtien määrät ja pakollisuus

Vastaus:
Jokaiseen kutsuun vastataan XML-vastauksella, jonka rakenne vastaa suurilta osin kutsua. Sanoman yleisrakenteen voi katsoa täältä. Vastaus GET-tyyppisiin noutosanomiin sisältää resurssikohtaisen data rakenteen, joka on kuvattu kussakin resurssikuvauksessa erikseen. POST-tyyppisiin tuontisanomiin tulee sanomasta riippuen Replies-elementti, jonka sisällä on esim. InsertedDataIdentifier-elementti sisältäen lisätyn asian ID-arvon.



Oliko tästä vastauksesta apua? Kyllä Ei

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.