Gränssnitt

Filtransport v3 har ett JSON-baserat gränssnitt över HTTP med TLS.

Vid testning av HTTP-gränssnitt (som Filtransport) används ofta cURL. Exempel på cURL anrop mot Filtransport finns i menyn under Testa filtransport.

Dokumentation

Gränssnittet för filtransport-v3.yaml är beskrivet med hjälp av OpenAPI version 3.0.3. Det finns många olika verktyg för att visualisera filen eller generera kod utifrån den.

För mer information om OpenAPI, se OpenAPI-specifikationen.

Förklaring av gränssnitt

Vissa delar av dokumentationen förtydligas nedan, de kan ändras fortlöpande.

Felkoder

Följande felkoder kan uppstå vid misslyckade anrop:

Felkoder
Felkod Beskrivning
Client.OgiltigInParameter En eller flera paramterar i URL-anropet är inkorrekta.
Client.HTTPfel Någon del i anropet är felaktigt, t.ex. att operation POST används när det bör vara GET.
Client.EjUppdrag Angiven kund är ej behörig för angivet uppdrag
Client.EjFilHant Angiven kund är ej registrerad som fillämnare eller filhämtare för angivet uppdrag
Server Ett internt fel har uppstått. Försök igen senare eller kontakta kundtjänst.