Teknisk information
Det är möjligt att integrera en organisations egna rapporteringssystem med ECCAIRS 2.
Det går att göra antingen,
- genom en ”ren” API-lösning, där integrationen byggs mot tjänstens rest-API, där händelserapporter kan skickas in som JSON-meddelanden, eller
- genom att överföra E5X-filer automatiskt via en API-metod.
Oavsett vilken lösning som är aktuell, måste det system som organisationen använder vara kompatibel och redo för den så kallade ADREP-taxonomi som används i ECCAIRS 2. Taxonomin består av fält, attribut och värdelistor som skapar ett mer standardiserat sätt att rapportera händelser.
Läs mer om ECCAIRS Taxonomi. (För att se den senaste taxonomin i sin helhet, klicka vidare på knappen Taxonomy Browser).
Det är även möjligt att hämta den senaste taxonomin via API, vilket gör att det system som används alltid har den senaste versionen med uppdaterade värdelistor och attribut.
Organisationer eller systemleverantörer som har frågor kring API-lösning för integration mellan det egna rapporteringssystemet och ECCAIRS 2 kan kontakta oss för mer information och API-dokumentation.
Integration mot utvecklingsmiljö
Innan organisationen övergår till en integrationslösning går det att skapa en integration till en utvecklingsmiljö (sandbox) för att testa API:erna mot ECCAIRS 2. För att skapa en sådan integration följ dessa steg;
- Beställ konto hos oss genom att kontakta oss på eccairs2@transportstyrelsen.se, ange då;
- Organisationsnamn
- En administratör (namn) / kontaktperson
- E-post till administratör / kontaktperson
- IP adress (som ska vitlistas)
- Därefter får ni tillgång till sandbox-miljön där ni kan utveckla integrationen
- När ni är klar med utvecklingsfasen kontaktar ni oss igen så ger vi er tillgång till en testmiljö, där vi testar tillsammans och bedömer om ni är redo att gå till produktion.
Frågor och svar
I huvudsak behövs 3 endpoints användas:
- POST /occurrences/create - Används för att skapa en rapport.
- PUT /occurrences/edit - Används för att uppdatera en rapport. Rapporten kan skickas in igen i sin helhet, eller bara med uppdaterade värden.
- PUT /occurrences/attachments/{e2id} - Används för att lägga till bilagor till rapport.
- ResponsibleEntityID - Anger vilket lands myndighet man skickar rapporten till. För att skicka till Transportstyrelsen, ange ID=30, vilket gäller i både UAT och PROD. I Sandbox används ID=1 för att skicka till ”EASA” som är den enda myndigheten med tillgång till Sandbox.
- VersionType - Anger en systemteknisk status på rapporten och måste skickas med vid uppdatering av rapporter (EDIT-endpointen). Man kan ange DRAFT eller MINOR. Rekommenderat är att alltid använda MINOR, då DRAFT kommer återkalla rapporten till ett utkast i version 0.0 och blir då ej synlig hos Transportstyrelsen.
- SaveAsVersion - Anger teknisk status på rapporten och kan, men behöver inte, användas vid skapande av rapporter (CREATE-endpointen). Man kan ange DRAFT eller MINOR. Rekommenderat är att alltid använda MINOR, enligt samma logik som VersionType ovan. Skickas inget in sätts MINOR som default.
- Status - Anger teknisk status på rapporten och kan, men behöver inte, användas vid skapande av rapporter (CREATE-endpointen). Man kan ange DRAFT eller SENT. Rekommenderat är att alltid använda SENT, enligt samma logik som VersionType ovan. Skickas inget in sätts SENT som default.
- Type - Anger typ av rapport och ska alltid sättas till REPORT.
Eftersom flera entiteter kan skapas av samma typ av objekt (Exempelvis flera Aircraft eller Airspace) så måste de skiljas åt med ett ID. ID-numret måste vara unikt per rapport och vid uppdateringar av rapporten måste man hänvisa till respektive ID-nummer för att inte skapa en ny entitet (vilket i så fall blir en kopia med samma data).
Antingen sätter man själv ID-nummer på respektive entitet eller låter systemet tilldela ID-nummer med genom att skicka in "ID": "#id_number#". Det senare alternativet medför att man måste hämta och spara tilldelat ID-nummer för ev. uppdatering av rapport, vilket gör att det första alternativet förmodligen är att föredra.
De värden som ska/kan skickas in på respektive attribut hittas i taxonomin. Där finns förklaringar på datatyp, värdelistor, giltiga storlekar på värden med mera. Hela taxonomin med alla dess värdelistor går att ladda ned i XML- eller CSV/XSD-fil.