Allmänna instruktioner om resurser : Netvisor

Allmänt
Tolkningsanvisning
Meddelandesvar

Allmänt

Programgränssnittet tillåter såväl hämtning av data från Netvisor som import av data till Netvisor. Resurserna som erbjuds i gränssnittet är indelade i kategorier på toppnivå.
Gemensamt för alla transaktioner är:

Datumen är i ANSI-format
Landskoder är alltid i ISO 3166-format
Bilagor är alltid Base64-kodade i ett XML-meddelande
Tomma element behöver inte skrivas i ett XML-meddelande, exempelvis tolkas ett tomt element i begäran om uppdatering som en order att uppdatera värdet till tomt
Lämna inte obligatoriska fält tomma
Elementen måste vara i ordning enligt DTD

För att inkludera de skandinaviska bokstäverna (Ä, ä, Ö, ö eller Å, å) i gränssnittet måste meddelandet vara i ISO/IEC 8859-15-kodat format, men en xml-deklaration krävs dock inte. Netvisors serversida gör nödvändig förbearbetning av innehållet, i så fall ska materialet alltid börja med <root>.

Utför stora sökningar och dataöverföringar utanför kontorstid, om det inte finns ett särskilt behov av att överföra dem under kontorstid. Lämplig frekvens för dataöverföring varierar beroende på resurs och användningsfall. I många fall räcker det med en överföring en gång per dag eller en månad. Du kan också påskynda överföringar genom att begränsa dem med hjälp av resursparametrar.

Tolkningsanvisning

Här beskrivs syftet och tolkningarna av olika markeringar i integrationsgränssnittet.
XML-strukturen för olika meddelanden beskrivs i tabellform på alla punkter i meddelandena där det är möjligt och logiskt. På grund av XML-strukturen har vi exempelvis varit tvungna att använda hänvisningar till olika punkter i anvisningarna för att bevara en tydlig helhet.

Strukturbeskrivningarnas grundstruktur är följande:
Anrop:

Basuppgifter
- Resurs som används
- GET – vanligen hämtning av data från Netvisor
- POST – vanligen import av data till Netvisor
Parametrar
- Konfigureras vanligen i QueryString, åtskiljs från den egentliga resursen med ett ?-tecken följt av ett &-tecken
- Alla resurser har inte
XML-struktur vid import av data (POST)
- Beskriven XML-struktur samt exempelvis elementens antal och obligatoriska egenskap

Svar:
Varje anrop besvaras med ett XML-svar, vars struktur till stor del motsvarar anropet. Den allmänna strukturen för meddelandet ser du i avsnittet nedan. Svaret på hämtningsmeddelanden av GET-typ inkluderar en resursspecifik datastruktur som beskrivs separat i respektive resursbeskrivning. Beroende på meddelandet inkluderar importmeddelanden av POST-typ ett Replies-element i svaret, som innehåller exempelvis ett InsertedDataIdentifier-element som innehåller det tillagda objektets ID-värde.

Meddelandesvar

Varje gränssnittsanrop besvaras med ett standardiserat meddelandesvar. I meddelanden av GET-typ innehåller svaret de begärda uppgifterna (<resursspecifikt element>) och i svar av POST-typ finns möjligen ett fallspecifikt svar (Replies).
Svarsmeddelandets allmänna struktur:
Element: Root (1 förekomst)¨
Element: Root/ResponseStatus (1 förekomst)

Element	Form	Beskrivning	Exempel	Ytterligare information
Status	Teckensträng	Indikerar om ett fel inträffade under bearbetningen av anropet	OK	FAILED
Status	Teckensträng	Felkonstant och felbeskrivning		Detta element endast i FAILED-läge. Se Hantera räkenskapsperioder
TimeStamp	Datum	Svarets tidstämpel	01.01.2018 12:00:00

Svarstypen är relaterad till datatrafikens riktning:
1. Vid hämtning av data från Netvisor
Hämtade data utgör ett separat element i meddelandet:
Element: Root/ResponseStatus/<resursspecifikt element>
2. Vid import av data till Netvisor
Svaret innehåller Replies-elementet och inom detta från fall till fall data:
Element: Root/ResponseStatus (0–1 förekomst)

Element	Form	Beskrivning	Exempel	Ytterligare information
InsertedDataIdentifier	Teckensträng
ELLER
Reply	Teckensträng

Följande element förekommer 0 gånger.

Hjälpte det här svaret? Ja Nej