{ "openapi": "3.0.1", "info": { "title": "EDA API", "version": "0.5.0-preview", "x-audience": "public" }, "servers": [ { "url": "https://api.eda.admin.ch", "description": "Production server" }, { "url": "https://int.api.eda.admin.ch", "description": "Test server" } ], "paths": { "/orders": { "get": { "tags": [ "orders" ], "description": "Contracts awarded", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/order" } }, "nextLink": { "type": "string" } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } } }, "/cdcc/lang/{lang}": { "get": { "tags": [ "cdcc" ], "description": "Foreign representations in Switzerland", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/cdcc" } } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } }, "parameters": [ { "name": "lang", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "de", "fr", "it", "en" ] } } ] }, "/cdcc": { "get": { "tags": [ "cdcc" ], "description": "Foreign representations in Switzerland", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/cdcc" } }, "nextLink": { "type": "string" } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } } }, "/reisehinweise/id/{id}": { "get": { "tags": [ "reisehinweise" ], "description": "Reisehinweise", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/reisehinweis" } } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } } }, "/reisehinweise": { "get": { "tags": [ "reisehinweise" ], "description": "Reisehinweise", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/reisehinweis" } }, "nextLink": { "type": "string" } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } } }, "/reisehinweise_focus": { "get": { "tags": [ "reisehinweise" ], "description": "Reisehinweise Fokus", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/reisehinweise_focus" } }, "nextLink": { "type": "string" } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } } }, "/reisehinweise_focus/language/{language}": { "get": { "tags": [ "reisehinweise" ], "description": "Reisehinweise Fokus by language", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/reisehinweise_focus" } } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } }, "parameters": [ { "name": "language", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "de", "fr", "it" ] } } ] }, "/reisehinweise_allgemeine_informationen": { "get": { "tags": [ "reisehinweise" ], "description": "Länderunabhängige Reiseinformationen", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/reisehinweise_allgemeine_informationen" } }, "nextLink": { "type": "string" } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } } }, "/reisehinweise_allgemeine_informationen/language/{language}": { "get": { "tags": [ "reisehinweise" ], "description": "Länderunabhängige Reiseinformationen by language", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/reisehinweise_allgemeine_informationen" } } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } }, "parameters": [ { "name": "language", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "de", "fr", "it" ] } } ] }, "/vis/id/{id}": { "get": { "tags": [ "vis" ], "description": "Swiss representations abroad", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/vis" } } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } } }, "/vis": { "get": { "tags": [ "vis" ], "description": "Swiss representations abroad", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/vis" } }, "nextLink": { "type": "string" } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } } }, "/country_sites/id/{id}": { "get": { "tags": [ "livingdocs" ], "description": "Used on country sites", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/country_sites_data" } } } } } } }, "400": { "description": "BadRequest" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "NotFound" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "components": { "schemas": { "order": { "type": "object", "required": [ "id", "description", "partner", "country", "currency", "budget", "start", "end", "psp" ], "properties": { "id": { "type": "string", "description": "Opaque identifier, used for navigation.", "example": "1" }, "description": { "type": "string", "description": "Auftrags Kurzbeschreibung", "example": "Kommunikationstraining - Grundausbildung Volées 2025" }, "partner": { "type": "string", "description": "Auftragspartner", "example": "Caritas Schweiz, 6006 Luzern" }, "country": { "type": "string", "description": "Land, in dem der Auftrag ausgeführt wird", "example": "Switzerland" }, "currency": { "type": "string", "description": "Währung des Auftrags", "example": "CHF" }, "budget": { "type": "string", "description": "Budget des Auftrags", "example": "4,700,755.92" }, "start": { "type": "string", "description": "Startdatum des Auftrags", "example": "01.01.2025" }, "end": { "type": "string", "description": "Enddatum des Auftrags", "example": "31.12.2025" }, "psp": { "type": "string", "description": "PSP-Nummer des Auftrags", "example": "81081204" } } }, "cdcc": { "type": "object", "required": [ "id", "iso_code", "language", "representations", "html" ], "properties": { "id": { "type": "string", "example": "AD-de" }, "iso_code": { "type": "string", "example": "AD" }, "language": { "type": "string", "example": "de" }, "html": { "type": "object", "required": [ "representations" ], "properties": { "representations": { "type": "array", "items": { "$ref": "#/components/schemas/cdcc_html" } } } }, "representations": { "type": "array", "items": { "type": "object", "required": [ "art", "zustaendige_bezirke", "sektionen" ], "properties": { "art": { "type": "string", "example": "Botschaft" }, "zustaendige_bezirke": { "type": "string", "example": "toute la Suisse" }, "sektionen": { "type": "array", "items": { "type": "object", "required": [ "art", "oeffnungszeiten", "geografische_adresse", "post_adresse", "emails", "telefonnummern", "faxnummern", "homepages" ], "properties": { "art": { "type": "string", "example": "Chancellerie" }, "oeffnungszeiten": { "type": "string", "nullable": true, "example": "08h00 à 17h30" }, "geografische_adresse": { "$ref": "#/components/schemas/cdcc_address" }, "post_adresse": { "nullable": true, "$ref": "#/components/schemas/cdcc_address" }, "emails": { "type": "array", "items": { "type": "string" } }, "telefonnummern": { "type": "array", "items": { "type": "string" } }, "faxnummern": { "type": "array", "items": { "type": "string" } }, "homepages": { "type": "array", "items": { "type": "string" } } } } } } } } } }, "cdcc_address": { "type": "object", "required": [ "strasse", "zusatz", "postfach", "ort", "iso_code", "postleitzahl", "land" ], "properties": { "strasse": { "type": "string", "nullable": true, "example": "Rue de Varembé 3" }, "zusatz": { "type": "string", "nullable": true }, "postfach": { "type": "string", "nullable": true }, "ort": { "type": "string", "nullable": true, "example": "Genève" }, "iso_code": { "type": "string", "nullable": true, "example": "CH" }, "postleitzahl": { "type": "string", "nullable": true, "example": "1202" }, "land": { "type": "string", "nullable": true, "example": "Schweizerische Eidgenossenschaft" } } }, "cdcc_html": { "type": "object", "required": [ "title", "sections" ], "properties": { "title": { "type": "string", "example": "

Botschaft Andorra la Vella

" }, "sections": { "type": "array", "items": { "$ref": "#/components/schemas/cdcc_html_section" } } } }, "cdcc_html_section": { "type": "object", "required": [ "title", "html" ], "properties": { "title": { "type": "string", "example": "Chancellerie" }, "html": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/cdcc_html_detail" } } } }, "cdcc_html_detail": { "type": "object", "required": [ "title", "html" ], "properties": { "title": { "type": "string", "example": "Adresse géographique" }, "html": { "type": "string", "example": "Carrer Prat de la Creu 62-64
500 Andorra la Vella
Fürstentum Andorra" } } }, "reisehinweis": { "type": "object", "required": [ "id", "iso_code", "language", "update_information", "disclaimer_of_liability", "advice_against", "has_travel_advice", "general_assessment", "chapters", "published_at", "valid_on" ], "properties": { "id": { "type": "string", "description": "Opaque identifier, used for navigation.", "example": "AL-de" }, "iso_code": { "type": "string", "description": "two-letter ISO code of the country to which the travel advice applies.", "example": "AL" }, "language": { "type": "string", "enum": [ "de", "fr", "it" ], "description": "Language of the texts", "example": "de" }, "published_at": { "type": "string", "pattern": "^\\d{2}.\\d{2}.\\d{4}$", "description": "Date in Swiss format on which the travel advice was published.", "example": "23.11.2023" }, "valid_on": { "type": "string", "pattern": "^\\d{2}.\\d{2}.\\d{4}$", "description": "Date in Swiss format on which the travel advice is valid.", "example": "17.05.2024" }, "advice_against": { "type": "string", "enum": [ "none", "tourists", "general" ], "description": "Indicates whether there is a travel warning. none: no warning, tourists: warning for tourists and general: general warning.", "example": "none" }, "has_travel_advice": { "type": "boolean", "description": "Indicates whether travel advice is published for this country.", "example": true }, "update_information": { "type": "object", "required": [ "meta", "html" ], "properties": { "meta": { "type": "object", "required": [ "html" ], "properties": { "html": { "type": "string", "example": "Gültig am: 17.05.2024 | Publiziert am: 23.11.2023 | E-Mail Benachrichtigung einrichten" } } }, "html": { "type": "string", "example": "

Diese Reisehinweise sind überprüft und mit redaktionellen Änderungen publiziert worden. Die Einschätzung der Lage ist unverändert gültig.

" } }, "description": "Information on updates to the travel advice" }, "general_assessment": { "type": "object", "required": [ "html" ], "properties": { "html": { "type": "string", "example": "

Reisen nach Albanien gelten grundsätzlich als sicher.

Dennoch kommen Proteste und Kundgebungen in der Hauptstadt und anderen grossen Städten vor

" } }, "description": "General assessment of the country" }, "chapters": { "type": "array", "items": { "type": "object", "required": [ "title", "htmlTitle", "anchorUrl", "html" ], "properties": { "title": { "type": "string", "nullable": true, "description": "Title of the chapter", "example": "Verkehr und Infrastruktur" }, "htmlTitle": { "type": "string", "nullable": true, "description": "Title of the chapter with html formatting", "example": "

Verkehr und Infrastruktur

" }, "anchorUrl": { "type": "string", "nullable": true, "description": "Anchor URL for the chapter, used for linking", "example": "#verkehr_und_infrastruktur" }, "html": { "type": "string", "description": "HTML Content of the chapter", "example": "" } } }, "description": "Chapters of the travel advice" }, "disclaimer_of_liability": { "type": "object", "required": [ "html" ], "properties": { "html": { "type": "string", "description": "HTML formated disclaimer of liability for the travel advice", "example": "Das EDA übernimmt keine Gewähr für die Vollständigkeit der Reisehinweise und für die Richtigkeit des Inhalts von verlinkten externen Internetseiten." } } } } }, "reisehinweise_focus": { "type": "object", "required": [ "id", "language", "title", "html", "published_at" ], "properties": { "id": { "type": "string", "description": "Opaque identifier, used for navigation.", "example": "de" }, "language": { "type": "string", "enum": [ "de", "fr", "it" ], "description": "Language of the texts", "example": "de" }, "title": { "type": "string", "description": "Title of the focus", "example": "Maritime Risiken und Piraterie" }, "html": { "type": "string", "description": "HTML content of the focus", "example": "

In verschiedenen Regionen der Welt ist die maritime Piraterie verbreitet.

" }, "published_at": { "type": "string", "pattern": "^\\d{2}.\\d{2}.\\d{4}$", "description": "Date in Swiss format on which the focus topics were published.", "example": "23.11.2023" } } }, "reisehinweise_allgemeine_informationen": { "type": "object", "required": [ "id", "language", "title", "html", "published_at" ], "properties": { "id": { "type": "string", "description": "Opaque identifier, used for navigation.", "example": "de" }, "language": { "type": "string", "enum": [ "de", "fr", "it" ], "description": "Language of the texts", "example": "de" }, "title": { "type": "string", "description": "Title of the information", "example": "Tipps während der Reise" }, "html": { "type": "string", "description": "HTML content of the informationen", "example": "

Für Reisende empfiehlt es sich, ein paar Grundregeln zu kennen und sie zu beachten.

" }, "published_at": { "type": "string", "pattern": "^\\d{2}.\\d{2}.\\d{4}$", "description": "Date in Swiss format on which the allgemeine informationen were published.", "example": "23.11.2023" } } }, "vis": { "type": "object", "required": [ "id", "iso_code", "language", "country_name", "representations" ], "properties": { "id": { "type": "string", "description": "Opaque identifier, used for navigation.", "example": "JP-de" }, "iso_code": { "type": "string", "description": "Two-letter ISO code of the country for which the representations represent.", "example": "JP" }, "language": { "type": "string", "enum": [ "de", "fr", "it", "en" ], "description": "Language of the texts, e.g. the organisations.", "example": "de" }, "country_name": { "type": "string", "description": "Vollständiger Name des Landes.", "example": "Japan" }, "representations": { "type": "array", "items": { "$ref": "#/components/schemas/representation" }, "description": "List of the representations for the country specified by the iso_code." } } }, "representation": { "type": "object", "required": [ "type", "location", "iso_code", "country_name", "code", "responsible_code", "has_consular_services", "consular_district", "organisation", "address", "postal_address", "designations", "html" ], "properties": { "type": { "type": "string", "description": "Typ der Vertretung, z.B. Botschaft, Konsulat, Generalkonsulat", "example": "Botschaft" }, "location": { "type": "string", "description": "Ort, in dem sich die Vertretung befindet", "example": "Barcelona" }, "iso_code": { "type": "string", "description": "Zwei-Buchstaben ISO-Code des Landes in dem sich die Vertretung befindet. Sie ist aber für das in vis definierten iso_code auch zuständig.", "example": "ES" }, "country_name": { "type": "string", "description": "Vollständiger Name des Landes, in dem sich die Vertretung befindet.", "example": "Spanien" }, "code": { "type": "string", "nullable": true, "description": "Code identifier der Vertretung um responsible_code zu referenzieren. Kann sich mit der Zeit ändern.", "example": "MAD" }, "responsible_code": { "type": "string", "nullable": true, "description": "Wenn angegeben, dann ist dies der code der Vertretung, die für diese Vertretung zuständig ist.", "example": "BAR" }, "has_consular_services": { "type": "boolean", "description": "Gibt an, ob die Vertretung konsularische Dienstleistungen anbietet.", "example": false }, "consular_district": { "type": "string", "description": "Gibt an, ob die Vertretung nur für einen bestimmten konsularischen Bezirk zuständig ist.", "example": "Aragón, Catalonia, Valencia Community, Balearic Islands, Region of Murcia, Principality of Andorra" }, "organisation": { "type": "string", "description": "Name der Organisation, die die Vertretung betreibt.", "example": "Embajada de Suiza" }, "address": { "type": "string", "description": "Address of the representation", "example": "Rua Alameda Príncipe Real 59\\nMiramar\\nLuanda\\nAngola" }, "postal_address": { "type": "string", "nullable": true, "description": "Postal address of the representation", "example": "Embaixada da Suíça\\nCaixa Postal 3163\\nCorreio central\\nLuanda\\nAngola" }, "designations": { "type": "array", "items": { "type": "object", "required": [ "name", "designation", "phone", "fax", "email", "website" ], "properties": { "name": { "type": "string", "description": "Official designation indicating the purpose or department", "example": "Zentrale" }, "designation": { "type": "string", "enum": [ "zentrale", "konsularische-dienstleistungen", "visa" ], "description": "Kind of the designation", "example": "zentrale" }, "phone": { "type": "array", "items": { "type": "string", "example": "+27 12 452 0660" } }, "fax": { "type": "array", "items": { "type": "string", "example": "+41 555123124" } }, "email": { "type": "array", "items": { "type": "string", "example": "pretoria@eda.admin.ch" } }, "website": { "type": "array", "items": { "type": "string", "format": "uri", "example": "http://www.eda.admin.ch/luanda" } } } } }, "html": { "type": "object", "required": [ "sections" ], "properties": { "sections": { "type": "array", "items": { "type": "object", "required": [ "title", "html" ], "properties": { "title": { "type": "string", "nullable": true, "description": "HTML formatted section title", "example": "Organisation" }, "html": { "type": "string", "nullable": true, "description": "HTML content", "example": "Embaixada da Suíça na República de Angola" } } } } } } } }, "country_sites_data": { "type": "object", "required": [ "id", "code", "language", "location", "html" ], "properties": { "id": { "type": "string", "description": "Opaque identifier, used for navigation.", "example": "LON-de" }, "code": { "type": "string", "description": "Code of the representation", "example": "LON" }, "language": { "type": "string", "description": "Language of the texts", "example": "de" }, "location": { "type": "string", "description": "Location of the representation", "example": "London" }, "html": { "type": "object", "required": [ "organisation", "map_link", "addresses", "designations" ], "properties": { "organisation": { "type": "string", "description": "Name of the organisation", "example": "Embassy of Switzerland in the United Kingdom" }, "organisation": { "type": "string", "description": "Link to the map", "example": "Map" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/country_sites_address" } }, "designations": { "type": "array", "items": { "$ref": "#/components/schemas/country_sites_designation" } } } } } }, "country_sites_address": { "type": "object", "required": [ "title", "html" ], "properties": { "title": { "type": "string", "description": "HTML formatted title for the address section", "example": "Standort" }, "html": { "type": "string", "description": "HTML formatted address", "example": "16-18 Montagu Place
London W1H 2BQ
United Kingdom" } } }, "country_sites_designation": { "type": "object", "required": [ "title", "telephone", "opening_hours_telephone", "contacts", "opening_hours" ], "properties": { "title": { "type": "string", "description": "HTML formatted title for the designation section", "example": "

Zentrale

" }, "telephone": { "type": "string", "description": "HTML formatted telephone numbers", "example": "+44 20 7616 6000 (Telefon)" }, "opening_hours_telephone": { "type": "array", "items": { "$ref": "#/components/schemas/country_sites_opening_hours" }, "description": "Opening hours for telephone services" }, "contacts": { "type": "string", "description": "HTML formatted contact information (fax, email, website)", "example": "+44 20 7724 7001 (Fax)
london@eda.admin.ch" }, "opening_hours": { "type": "array", "items": { "$ref": "#/components/schemas/country_sites_opening_hours" }, "description": "General opening hours" } } }, "country_sites_opening_hours": { "type": "object", "required": [ "title", "html" ], "properties": { "title": { "type": "string", "description": "Title for the opening hours section", "example": "Öffnungszeiten Zentrale" }, "html": { "type": "string", "description": "HTML formatted opening hours" } } } } } }