API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger...

23
Eidgenössisches Justiz- und Polizeidepartement EJPD Staatssekretariat für Migration Abteilung Einreise API-Schnittstellenspezifikation V1.4 vom 25.05.2016 1/23 API-Schnittstellenspezifikation Version * 1.4 Datum * 25.05.2016 Status genehmigt Ergebnisbezeichnung Schnittstellenspezifikation Autor M. Germann, ISC-EJPD; B. Erni, SEM Eigentümer SEM Verteiler Meldepflichtige Fluggesellschaften, Internet SEM (ohne Kontaktangaben) * Diese Angaben sind bei Veränderung auch in allen Fusszeilen anzupassen Änderungskontrolle, Prüfung, Genehmigung Version Datum Beschreibung, Bemerkung Name, Rolle, OE/OU 0.1 01.02.2011 Erstversion des Dokumentes Matthias Germann 0.2 08.02.2011 Reihenfolge Ausstellerstaat / Ablaufda- tum des Reisedokuments im CSV Format korrigiert Matthias Germann 0.3 09.02.2011 Ergänzungen des SEM Barbara Erni 0.4 17.02.2011 Ergänzungen aus Review Matthias Germann 0.5 28.03.2011 Anpassung Dokumenttypen und Län- dercodes Matthias Germann 0.6 09.05.2011 Flugnummer (Länge) angepasst Barbara Erni 0.7 06.07.2011 Kapitel 4.2 Fussnote zum Format 05B eingefügt. Barbara Erni 1.0 Aug. 2011 Veröffentlichung Barbara Erni 1.1 25.01.2012/ 08.03.2012 Formelle Überarbeitung, Anpassung Länge der Dokumentennummer, Fussnoten 1, 3 und 5 neu hinzugefügt oder angepasst. Barbara Erni 1.2 02.04.2015 Ergänzung zum UNA Header und eini- gen kleineren Korrekturen. Erweiterung für die Übermittlung des endgültigen Reiseziels. Matthias Germann 1.3 30.11.2015 Aktualisierung von Abschnitt 3.5 Kon- taktangaben und einige kleine Korrek- turen. Ariane Studer 1.4 25.05.2016 Löschung des Formats 05B in den Ab- schnitten 4.2 UN/EDIFACT PAXLST und 4.2.5 UNH Message Header und kleine Korrekturen. Ariane Studer

Transcript of API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger...

Page 1: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration

Abteilung Einreise

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 1/23

API-Schnittstellenspezifikation

Version * 1.4

Datum * 25.05.2016

Status genehmigt

Ergebnisbezeichnung Schnittstellenspezifikation

Autor M. Germann, ISC-EJPD; B. Erni, SEM

Eigentümer SEM

Verteiler Meldepflichtige Fluggesellschaften, Internet SEM (ohne Kontaktangaben)

* Diese Angaben sind bei Veränderung auch in allen Fusszeilen anzupassen

Änderungskontrolle, Prüfung, Genehmigung

Version Datum Beschreibung, Bemerkung Name, Rolle, OE/OU

0.1 01.02.2011 Erstversion des Dokumentes Matthias Germann

0.2 08.02.2011 Reihenfolge Ausstellerstaat / Ablaufda-tum des Reisedokuments im CSV Format korrigiert

Matthias Germann

0.3 09.02.2011 Ergänzungen des SEM Barbara Erni

0.4 17.02.2011 Ergänzungen aus Review Matthias Germann

0.5 28.03.2011 Anpassung Dokumenttypen und Län-dercodes

Matthias Germann

0.6 09.05.2011 Flugnummer (Länge) angepasst Barbara Erni

0.7 06.07.2011 Kapitel 4.2 Fussnote zum Format 05B eingefügt.

Barbara Erni

1.0 Aug. 2011 Veröffentlichung Barbara Erni

1.1 25.01.2012/08.03.2012

Formelle Überarbeitung, Anpassung Länge der Dokumentennummer, Fussnoten 1, 3 und 5 neu hinzugefügt oder angepasst.

Barbara Erni

1.2 02.04.2015 Ergänzung zum UNA Header und eini-gen kleineren Korrekturen.

Erweiterung für die Übermittlung des endgültigen Reiseziels.

Matthias Germann

1.3 30.11.2015 Aktualisierung von Abschnitt 3.5 Kon-taktangaben und einige kleine Korrek-turen.

Ariane Studer

1.4 25.05.2016 Löschung des Formats 05B in den Ab-schnitten 4.2 UN/EDIFACT PAXLST und 4.2.5 UNH Message Header

und kleine Korrekturen.

Ariane Studer

Page 2: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 2/23

Definitionen, Akronyme und Abkürzungen

Begriff / Abkürzung Bedeutung

API Advance Passenger Information

API-Meldung Passagierliste für einen Flug (PAXLST)

SEM Staatssekretariat für Migration

BIT Staatssekretariat für Informatik und Telekommunikation

SITA Société Internationale de Télécommunications Aéronautiques

Referenzen

Ref. Titel, Quelle

ISO9735 United Nations Directories for Electronic Data Interchange for Administration, Commerce and Transport. UN/EDIFACT Syntax Rules (ISO 9735 latest version)

ICAO9303 International Civil Aviation Organisation. Doc 9309: Machine Readable Travel Documents, ICAO, 2006

PAXLST United Nations Directories for Electronic Data Interchange for Administration, Commerce and Transport. UN/EDIFACT Message Type PAXLST, Version D, Release 02B, United Nations, Genf 13.02.2003.

Page 3: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 3/23

Inhaltsverzeichnis

1 Einleitung ........................................................................................................................ 5

2 Übermittlungsarten und Formate ..................................................................................... 5

2.1 SITA Type B ........................................................................................................ 5 2.2 API-Webupload ................................................................................................... 6 2.2.1 Web-Browser ....................................................................................................... 6 2.2.2 Account ............................................................................................................... 7

3 Organisatorisches ........................................................................................................... 8

3.1 Annahme nur der ersten API-Meldung ................................................................. 8 3.2 Empfangsbestätigung .......................................................................................... 8 3.3 Testen der Datenübermittlung ............................................................................. 8 3.4 Datenübermittlung im Ausnahmefall .................................................................... 8 3.5 Kontaktangaben .................................................................................................. 9

4 Format Spezifikationen ................................................................................................... 9

4.1 Allgemein ............................................................................................................. 9 4.1.1 Erlaubte Zeichen ................................................................................................. 9 4.1.2 Dokumenttypen ................................................................................................. 10 4.2 UN/EDIFACT PAXLST ...................................................................................... 10 4.2.1 Segmentierte API-Meldungen ............................................................................ 10 4.2.2 Übersicht PAXLST Meldung .............................................................................. 11 4.2.3 UNA Service String Advice ................................................................................ 12 4.2.4 UNB Interchange Header .................................................................................. 12 4.2.5 UNH Message Header ....................................................................................... 13 4.2.6 BGM Begin of Message ..................................................................................... 14 4.2.7 NAD Name and address (Reporting party) ........................................................ 14 4.2.8 COM Communication contact (Reporting party) ................................................. 14 4.2.9 TDT Transport information ................................................................................. 14 4.2.10 LOC Place/location identification (Flight itinerary) ......................................... 15 4.2.11 DTM Date/time/period (Flight itinerary) .......................................................... 15 4.2.12 NAD Name and address (Traveler) ............................................................... 16 4.2.13 ATT Attribute (Traveler Gender) .................................................................... 16 4.2.14 DTM Date/time/period (Traveler Date of Birth) .............................................. 16 4.2.15 LOC Place/location identification (Traveler itinerary) ..................................... 17 4.2.16 NAT Nationality ............................................................................................. 17 4.2.17 DOC Document/message details (Travel Document) .................................... 17 4.2.18 DTM Date/time/period (Travel Document) ..................................................... 18 4.2.19 LOC Place/location identification (Travel Document) ..................................... 18 4.2.20 CNT Control total .......................................................................................... 18 4.2.21 UNT Message Trailer .................................................................................... 19 4.2.22 UNZ Interchange Trailer ................................................................................ 19 4.3 CSV ................................................................................................................... 19

5 Anhang ......................................................................................................................... 21

5.1 Beispiel Meldung UN/EDIFACT ohne Segmentierung ....................................... 21 5.2 Beispiel Meldung UN/EDIFACT mit Segmentierung........................................... 21 5.2.1 Teilmeldung 1/3 ................................................................................................. 21 5.2.2 Teilmeldung 2/3 ................................................................................................. 22 5.2.3 Teilmeldung 3/3 ................................................................................................. 23 5.3 Beispiel Meldung CSV ....................................................................................... 23

Page 4: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 4/23

Abbildungsverzeichnis

Abbildung 1 Übermittlung via SITA Netzwerk ......................................................................... 6 Abbildung 2: Übermittlung via API-Webupload....................................................................... 6

Tabellenverzeichnis

Tabelle 1: Übermittlungsarten und Formate ........................................................................... 5 Tabelle 2: Erlaubte Zeichen ................................................................................................... 9 Tabelle 3: Dokumenttypen ................................................................................................... 10 Tabelle 4: UNA Service String Advice .................................................................................. 12 Tabelle 5: UNB Interchange Header .................................................................................... 13 Tabelle 6: UNH Message Header ........................................................................................ 14 Tabelle 7: BGM Begin of Message ....................................................................................... 14 Tabelle 8: NAD Name and address (Reporting party) .......................................................... 14 Tabelle 9: COM Communication contact (Reporting party) .................................................. 14 Tabelle 10: TDT Transport information ................................................................................ 15 Tabelle 11: LOC Place/location identification (Flight itinerary) .............................................. 15 Tabelle 12: DTM Date/time/period (Flight itinerar ................................................................. 15 Tabelle 13: NAD Name and address (Traveler) ................................................................... 16 Tabelle 14: ATT Attribute (Traveler Gender) ........................................................................ 16 Tabelle 15: DTM Date/time/period (Traveler Date of Birth)................................................... 17 Tabelle 16: LOC Place/location identification (Traveler itinerary) ......................................... 17 Tabelle 17: NAT Nationality ................................................................................................. 17 Tabelle 18: DOC Document/message details (Travel Document) ........................................ 18 Tabelle 19: DTM Date/time/period (Travel Document) ......................................................... 18 Tabelle 20: LOC Place/location identification (Travel Document) ......................................... 18 Tabelle 21: Control total ....................................................................................................... 18 Tabelle 22: UNT Message trailer ......................................................................................... 19 Tabelle 23: UNZ Message trailer ......................................................................................... 19 Tabelle 24 CSV 1. Zeile ....................................................................................................... 19 Tabelle 25 CSV 2. Zeile und folgende (Passagierdaten) ...................................................... 20

Page 5: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 5/23

1 Einleitung

Gemäss Art. 104 des Bundesgesetzes über die Ausländerinnen und Ausländer (AuG; SR 142.20) bestimmt das Staatssekretariat für Migration (SEM) nach Anhörung der Fluggesell-schaften, bei welchen Flügen diese verpflichtet sind, unmittelbar nach dem Abflug Perso-nendaten der beförderten Passagiere auf elektronischem Weg zu melden. Dieses Dokument beschreibt die Schnittstelle des schweizerischen API-Systems, über die die Passagierlisten der Fluggesellschaften an das SEM gesendet werden. Es dient für beide Seiten als verbindliche Grundlage zur Schaffung der notwendigen Infrastrukturen. Massge-bend sind neben dieser Schnittstellenspezifikation die Bestimmungen in der Verfügung, mit der die Meldepflicht angeordnet wird. Das Dokument besteht im Wesentlichen aus drei Abschnitten. In Kapitel 2 werden die Über-mittlungsarten und das Format allgemein beschrieben. Kapitel 3 enthält wichtige organisato-rische Hinweise und in Kapitel 4 wird das Format, in dem das SEM die Passagierliste erwar-tet, genauer spezifiziert. Im Anhang dieses Dokument finden sich verschiedene Beispielmel-dungen.

Die Nutzung der Schnittstelle des schweizerischen API-Systems erfolgt auf eigene Gefahr.

Das SEM und das Informatik Service Center ISC-EJPD lehnen jede Haftung für Schäden ab,

die direkt oder indirekt durch bei der Verwendung des schweizerischen API-Systems hervor-

gerufen wurden.

2 Übermittlungsarten und Formate

Die API-Meldungen können über das SITA Netzwerk (Type B Messaging) oder, falls eine

Fluggesellschaft nicht mit SITA zusammenarbeitet, über den API-Webupload (File Upload

via Internet) an das SEM übermittelt werden. Als Meldungsformat kann UN/EDIFACT PAX-

LST und CSV verwendet werden. Die folgende Tabelle fasst die Übermittlungsarten und un-

terstützten Meldungsformate zusammen:

Übermittlungsart Unterstützte Meldungsformate

SITA Type B UN/EDIFACT PAXLST

API-Webupload CSV1

Tabelle 1: Übermittlungsarten und Formate

2.1 SITA Type B

Bei der Übermittlung via SITA Netzwerk wird die API-Meldung von der Fluggesellschaft an

das Messaging System von SITA gesendet (Type B Meldung). Das Messaging System leitet

die Meldung über eine SITA-Datenleitung an das SEM weiter.

1 Wünscht eine Fluggesellschaft die Verwendung des XML-Formats, so muss sie frühzeitig mit dem

SEM Kontakt aufnehmen. Das SEM stellt anschliessend eine detaillierte Beschreibung des Formats

zur Verfügung.

Page 6: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 6/23

Abbildung 1 Übermittlung via SITA Netzwerk

Für die Übermittlung via SITA Type B Messaging wird das UN/EDIFACT PAXLST Meldungs-

format unterstützt.

2.2 API-Webupload

Für Fluggesellschaften, welche die Übermittlung via SITA Netzwerk nicht nutzen können,

wird mit dem API-Webupload eine alternative Übermittlungsart zur Verfügung gestellt. Der

API-Webupload ist eine Webapplikation, welche via Internet erreichbar ist. Für den Zugriff

auf die Applikation wird ein Web-Browser verwendet.

Die Fluggesellschaften müssen sich beim API-Webupload mittels Benutzername und Pass-

wort authentisieren2. Danach kann die Datei, welche die API-Meldung enthält, hochgeladen

werden. Die Verbindung zwischen dem PC der Fluggesellschaft und dem Webserver beim

SEM wird mit SSL verschlüsselt (HTTPS).

Abbildung 2: Übermittlung via API-Webupload

Für die Übermittlung via API-Webupload wird das CSV Meldungsformat unterstützt.

2.2.1 Web-Browser

Der API-Webupload wurde für die folgenden Web-Browser getestet:

Microsoft Internet Explorer 7 (IE7)

Microsoft Internet Explorer 8 (IE8)

2 Benutzername und Passwort werden der Fluggesellschaft pro Abflugort vom SEM bei der Aufnahme

der Meldepflicht mitgeteilt.

Page 7: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 7/23

Mozilla Firefox 3 (FF3)

Das korrekte Funktionieren des API-Webupload mit anderen Web-Browsern kann nicht ga-

rantiert werden.

Der API-Webupload verwendet ein von der AdminPKI des BIT (Bundesamt für Informatik und

Telekommunikation) ausgestelltes HTTPS Serverzertifikat. Die Root Zertifikate der AdminPKI

sind seit dem 22.05.2008 im Microsoft Internet Explorer integriert. Bei der Verwendung eines

anderen Web-Browsers ist es notwendig, die Root Zertifikate der AdminPKI manuell zu in-

stallieren. Andernfalls wird der Web-Browser beim Aufruf des API-Webupload eine Sicher-

heits-Warnung anzeigen. Weitere Informationen zur Installation der Root Zertifikate der Ad-

minPKI sind unter der folgenden Adresse abrufbar:

http://www.bit.admin.ch/adminpki/00247/index.html?lang=de

2.2.2 Account

Das Passwort für den API-Webupload Account muss nach dem ersten Login geändert wer-

den. Danach muss das Passwort spätestens alle 60 Tage geändert werden. Die Pass-

wortänderung erfolgt in der API-Webupload Applikation (Menüpunkt „Change Password“).

Für das Passwort gelten die folgenden Regeln:

Passwortlänge: 8 bis 50 Zeichen

Trivial-Passwörter wie Benutzer-ID, Name, Vorname, Geburtsdatum usw. dürfen

nicht verwendet werden

Zusammensetzung der Passwörter:

- Grossbuchstaben: A-Z

- Kleinbuchstaben: a-z

- Zahlen:0-9

- Sonderzeichen: ( ) [ ] { } ? ! $ % & / = * + ~ . ; : < > - _

Mindestens drei dieser Zeichen-Kategorien müssen im Passwort verwendet werden

Ein bereits verwendetes Passwort darf nicht wieder verwendet werden

Die Fluggesellschaft ist für die sorgfältige Aufbewahrung des Passwortes verantwortlich.

Ein API-Webupload Account wird nach 5 erfolglosen Login-Versuchen in Folge für 30 Minu-

ten gesperrt. Für eine manuelle Entsperrung vor Ablauf der 30 Minuten oder das Zurücksetz-

ten des Passwortes muss das Helpdesk des Informatik Service Center ISC-EJPD kontaktiert

werden.

Page 8: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 8/23

3 Organisatorisches

3.1 Annahme nur der ersten API-Meldung3

Für jeden meldepflichtigen Flug4 wird nur eine API-Meldung entgegengenommen. Jede wei-

tere übermittelte API-Meldung zu einem Flug, zu dem bereits eine API-Meldung empfangen

wurde, erhält den Status „mehrfach übermittelt“ und wird vom API System nicht verarbeitet.

Massgeblich für das SEM ist somit immer die erste API-Meldung. Diese muss daher alle Da-

ten im korrekten Format enthalten. Eine Nachbesserungsmöglichkeit ist nicht vorgesehen.

Seitens des SEM erfolgt keine Erinnerung zur Übermittlung einer fehlenden API-Meldung.

Hinweis: Falls die übersandten API-Meldungen nicht den Vorgaben entsprechen oder nicht

rechtzeitig geliefert werden, so begeht die Fluggesellschaft eine Meldepflichtverletzung, die

gemäss Art. 122b AuG strafbar ist.

3.2 Empfangsbestätigung

Das API-System bestätigt, falls gewünscht, den Empfang der (ersten) API-Meldung. Diese

Bestätigung trifft nur eine Aussage darüber, dass Daten empfangen wurden und nicht, ob

diese fehlerfrei ausgewertet werden konnten.

Beim Webupload wird diese Bestätigung nach der erfolgreichen Datenübermittlung ange-

zeigt.

Der Empfang der via SITA übermittelten Daten wird mit einem automatisch generierten E-

Mail (no reply) bestätigt. Ist eine solche Empfangsbestätigung gewünscht, muss die Flugge-

sellschaft beim SEM eine entsprechende E-Mail-Adresse hinterlegen (eine E-Mail-Adresse

pro Abflugort). Wenn eine Fluggesellschaft eine Änderung der Adresse wünscht, so ist diese

Änderung rechtzeitig, d.h. mindestens 14 Tage vor Inkrafttreten (der neuen Adresse) mit

dem SEM abzustimmen.

3.3 Testen der Datenübermittlung

Die SEM bietet eine Möglichkeit die Korrektheit des Austauschformates vorab zu testen. Der

Test muss dem SEM im Vorfeld angekündigt werden, da Vorbereitungen durch das SEM zu

treffen sind.

3.4 Datenübermittlung im Ausnahmefall

Die API-Meldung ist via SITA oder, falls eine Fluggesellschaft nicht mit SITA zusammenar-

beitet, via Webupload zu übermitteln. Sollte die Datenübermittlung auf diesem Weg ausnah-

meweise nicht möglich sein (z.B. bei Systemausfall), so können die Daten via Fax übermittelt

werden. Die Faxnummer wird bei der Aufnahme der Meldepflicht kommuniziert.

3 Eine Ausnahme ist bei so genannten Sektoren- oder Dreiecksflügen vorgesehen. In diesem Fall kann die Flug-

gesellschaft pro Sektor (Leg) eine Meldung übermitteln. 4 Ein Flug wird dabei eindeutig durch Flugnummer, Ankunftsdatum des Fluges und die Strecke gekennzeichnet.

Page 9: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 9/23

3.5 Kontaktangaben5

Das SEM (Sektion Grundlagen Grenze) ist für fachliche Fragen unter der folgenden E-Mail Adresse erreichbar:

[email protected]

4 Format Spezifikationen

4.1 Allgemein

4.1.1 Erlaubte Zeichen

Die Meldungen dürfen nur in einem der folgenden Zeichensätze geliefert werden:

US-ASCII

ISO-8859-1

UTF-8

Zudem dürfen nur die folgenden Zeichen verwendet werden:

Zeichen Beispiel

Grossbuchstaben A-Z

Kleinbuchstaben a-z

Zahlen 0-9

Leerzeichen (Space)

Punkt .

Komma ,

Einfache Klammern ( )

Schrägstrich /

Einfaches Anführungszeichen '

Pluszeichen +

Minuszeichen -

Doppelpunkt :

Stern *

Semikolon ;

Gleichzeichen =

Kleiner / Grösser Zeichen < >

Fragezeichen ?

Ausrufezeichen !

Prozent Zeichen %

Und Zeichen &

Tabelle 2: Erlaubte Zeichen

5 Die Schnittstellenspezifikation ist auf der Internet-Seite des SEM ohne Kontaktangaben verfügbar.

Die Kontaktangaben sind beim SEM erhältlich.

Page 10: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 10/23

Andere Zeichen bedürfen der Zustimmung durch das SEM. Namen, welche andere Zeichen

enthalten, müssen gemäss ICAO 9303 [ICAO9303] auf diese Zeichen umgeschrieben wer-

den.

4.1.2 Dokumenttypen

Der Code für den Reisedokument-Typ muss grundsätzlich aus der MRZ des Reisedoku-

ments übernommen werden (siehe auch [ICAO9303]). Der Code kann aus zwei Stellen be-

stehen, jeweils an erster Stelle sind folgende Buchstaben zu verwenden:

Bezeichnung Code Dokumenttyp (1. Stelle)

Pass P

Visum V

Identitätskarte I, A oder C (die Verwendung von ID wird empfohlen)

Schengen-Aufenthaltstitel A, C oder I (die Verwendung von AR wird empfohlen)

Tabelle 3: Dokumenttypen

4.2 UN/EDIFACT PAXLST

API-Meldungen im EDIFACT Format werden im folgenden Meldungsformat erwartet:

Message-Type: PAXLST

Version: D

Release: 02B

Control Agency UN

Grundsätzlich gilt die Spezifikation [PAXLST]. Um die gesetzlichen Anforderungen an das

API-System zu erfüllen, werden hier über die Spezifikation [PAXLST] hinaus gehende Vor-

gaben gemacht. Dies betrifft insbesondere die Definition ob Attribute optional oder zwingend

sind. Die hier festgelegten Präzisierungen gelten vorrangig gegenüber der Spezifikation

[PAXLST]. Attribute, welche in der Spezifikation [PAXLST] aufgeführt sind, aber für das SEM

nicht relevant sind, werden in diesem Dokument nicht beschrieben.

4.2.1 Segmentierte API-Meldungen

Bei der Übermittlung via SITA Type B Messaging besteht eine Grössenbeschränkung6 für die

Meldungen. Falls die Maximalgrösse überschritten wird, muss eine API-Meldung auf mehre-

re Teilmeldungen aufgeteilt werden (segmentierte API-Meldung). Für segmentierte API-

Meldungen gelten die folgenden Regeln:

1. Jede Teilmeldung muss einen kompletten Satz der folgenden Header- und Trailer-

Segmente enthalten:

UNH Message Header

UNB Interchange Header

BGM Begin of Message

UNT Message Trailer

UNZ Interchange Trailer

2. Jede Teilmeldung muss die kompletten Kopfdaten zum Flug enthalten (Segment

Group 1 bis 3).

3. Die folgenden Elemente müssen für alle Teilmeldungen einer segmentierten API-

Meldung gleich sein:

Date und Time Element im UNB Interchange Header Segment

Interchange Control Reference im UNB Interchange Header Segment

6 Die aktuelle Maximalgrösse einer Type B Meldung muss bei SITA nachgefragt werden.

Page 11: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 11/23

Common Access Reference im UNH Message Header Segment

Means of Transport Journey Identifier im TDT Transport information Segment

4. Die Teilmeldungen einer segmentierten API-Meldung müssen im Sequence of Trans-

fers Element des UNH Message Header Segments aufsteigend nummeriert werden

(01, 02, 03,…).

5. Die erste Teilmeldung einer segmentierten API-Meldung ist im First and last Transfer

Element des UNH Message Header Segments mit einem ‚C’ zu kennzeichnen. Die

letzte Teilmeldung ist mit einem ‚F’ zu kennzeichnen. Für die anderen Teilmeldungen

wird das First and last Transfer Element weggelassen.

6. Im CNT Control total muss bei allen Teilmeldungen die totale Anzahl Passagiere des

Fluges angegeben werden (nicht die Anzahl Passagiere in der Teilmeldung)

7. Die Daten zu einem Passagier dürfen nicht auf mehrere Teilmeldungen aufgeteilt

werden.

8. Die Teilmeldungen einer segmentierten API-Meldung müssen innerhalb von 15 Minu-

ten nach dem Erhalt der ersten Teilmeldung eintreffen. Teilmeldungen dürfen nicht

mehrfach gesendet werden.

9. Eine API-Meldung gilt erst als eingereicht, wenn alle Teilmeldungen eingetroffen sind.

4.2.2 Übersicht PAXLST Meldung

Die folgende Tabelle gibt einen Überblick über die Struktur einer PAXLST Meldung:

Name S7 R8 Bemerkungen

├─ UNA Service String Advice C 1

├─ UNB Interchange Header M 1

├─ UNH Message Header M 1

├─ BGM Begin of Message M 1

├─ Segment Group 1

M

1

│ ├─ NAD Name and address (Reporting party) M 1

│ └─ COM Communication contact (Reporting party)

│ C 9 Ein Vorkommen pro Kommunikati-

onsnummer

├─ Segment Group 2

M

1

│ ├─ TDT Transport information M 1

│ │

│ └─ Segment Group 3

M

2

Je ein Vorkommen für Abflug und

Ankunft

│ ├─ LOC Place/location identification (Flight itinerary) M 1

│ └─ DTM Date/time/period (Flight itinerary) M 1

├─ Segment Group 4

C

999 Ein Vorkommen pro Passagier

│ ├─ NAD Name and address (Traveler) M 1

│ ├─ ATT Attribute (Traveler Gender) M 1

│ ├─ DTM Date/time/period (Traveler Date of Birth) M 1

│ ├─ LOC Place/location identification (Traveler itinerary)

│ │

│ │

M 2 Je ein Vorkommen für ursprüngli-

cher Abreiseort und endgültiges

Reiseziel

│ ├─ NAT Nationality M 8 Ein Vorkommen pro Nationalität

7 M=muss C= optional 8 Maximale Anzahl Vorkommen

Page 12: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 12/23

Name S7 R8 Bemerkungen

│ │

│ └─ Segment Group 5

M

2

Ein Vorkommen pro Reisedokument

(1. Pass / 2. Visa).

│ ├─ DOC Document/message details (Travel Document) M 1

│ ├─ DTM Date/time/period (Travel Document) C 1

│ └─ LOC Place/location identification (Travel Document) M 1

├─ CNT Control total M 1

├─ UNT Message Trailer

└─ UNZ Interchange Trailer M 1

4.2.3 UNA Service String Advice

Das UNA Segment definiert die Trennsymbole eine Meldung. Es ist das erste Segment der

Meldung (vor dem UNB Segment). Ein Leerzeichen (Space) darf nur für den Repetition Se-

parator (Position 050) verwendet werden. Dasselbe Trennzeichen darf nicht an mehr als ei-

ner Stelle im UNA Segment verwendet werden. Falls das UNA Segment weggelassen wird,

werden die in der Tabelle aufgeführten Default-Werte verwendet.

Beispiel: UNA:+.? '

Pos Name Default

010 Subelement separator : (Doppelpunkt)

020 Element separator + (Pluszeichen)

030 Decimal notation . (Punkt)

040 Release indicator ? (Fragezeichen)

050 Repetition separator (Leerzeichen / Space)

060 Segment terminator ' (einfaches Anführungszeichen)

Tabelle 4: UNA Service String Advice

Es wird dringend empfohlen, den UNA Service String Advice anzugeben und möglichst die

Default-Werte für die Trennsymbole gemäss der vorangehenden Tabelle zu verwenden.

Falls die Default-Werte nicht verwendet werden können, dürfen die Zeichen, welche in der

Tabelle als Default-Werte definiert sind, nicht an einer anderen Stelle im UNA Header ver-

wendet werden, als an der Stelle für die sie als Default-Wert definiert sind.

4.2.4 UNB Interchange Header

Beispiel:

UNB+UNOA:4+LUFTHANSA:ZZ+HDQCH2X:ZZ+110126:1409+ICR123456789++APIS'

Pos Tag Name S R Form. Bemerkungen

010 S001 SYNTAX IDENTIFIER M 1

0001 Syntax identifier M 1 a4 =UNOA (UN/ECE level A)

0002 Syntax version number M 1 an1 =4 (Version 4 ISO 9735:1998)

020 S002 INTERCHANGE SENDER M 1

0004 Interchange sender identification M 1 an..35 Name der absendenden Fluggesellschaft

0007 Identification code qualifier C 1 an..4 =ZZ (falls vorhanden)

030 S003 INTERCHANGE RECIPIENT M 1

0010 Interchange recipient identification M 1 an..35 =HDQCH2X (Name des Empfängers)

Page 13: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 13/23

Pos Tag Name S R Form. Bemerkungen

0007 Identification code qualifier C 1 an..4 =ZZ (falls vorhanden)

040 S004 DATE AND TIME OF PREPARA-TION

M 1

0017 Date M 1 n6 YYMMDD (Datum der Erstellung)

Falls eine API-Meldung aus mehreren Teil-meldungen besteht (segmentierte API-Meldung), ist bei allen Teilmeldungen der-selbe Wert anzugeben.

0019 Time M 1 n4 HHMM (Uhrzeit der Erstellung)

Falls eine API-Meldung aus mehreren Teil-meldungen besteht (segmentierte API-Meldung), ist bei allen Teilmeldungen der-selbe Wert anzugeben.

050 0020 Interchange control reference M 1 an..14 Eindeutige Referenz der API-Meldung beim Absender. Falls eine API-Meldung aus meh-reren Teilmeldungen besteht (segmentierte API-Meldung), ist bei allen Teilmeldungen dieselbe Referenz zu verwenden.

060 S005 RECIPIENT REFERENCE / PASS-WORD DETAILS

C 1 Nicht verwendet

070 0026 Application Reference M an..14 =APIS

Tabelle 5: UNB Interchange Header

4.2.5 UNH Message Header

Beispiel nicht segmentierte API-Meldung: UNH+MRN123456789+PAXLST:D:02B:UN:IATA'

Beispiel segmentierte API-Meldung:

Teilmeldung 1/3: UNH+00102052460024+PAXLST:D:02B:UN:IATA+123456789+01:C'

Teilmeldung 2/3: UNH+00102052460025+PAXLST:D:02B:UN:IATA+123456789+02'

Teilmeldung 3/3: UNH+00102052460026+PAXLST:D:02B:UN:IATA+123456789+03:F'

Pos Tag Name S R Form. Bemerkungen

010 0062 Message reference number M 1 an..14 Eindeutige Referenz der Meldung beim Ab-sender.

020 S009 MESSAGE IDENTIFIER M 1

0065 Message type M 1 an..6 =PAXLST

0052 Message version number M 1 an..3 =D

0054 Message release number M 1 an..3 =02B

0051 Controlling agency, coded M 1 an..3 =UN

0057 Association assigned code C 1 an..6 =IATA

030 0068 Common access reference C 1 an..35 Wird verwendet, falls eine API-Meldung aus mehreren Teilmeldungen besteht (segmen-tierte API-Meldung).

Muss für alle Teilmeldungen einer segmen-tierten API-Meldung denselben Wert enthal-ten.

040 S010 STATUS OF THE TRANSFER C 1

0070 Sequence of transfers C 1 n..2 Wird verwendet, falls eine API-Meldung aus mehreren Teilmeldungen besteht (segmen-tierte API-Meldung).

Page 14: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 14/23

Pos Tag Name S R Form. Bemerkungen Die einzelnen Teilmeldungen werden aufstei-gend nummeriert (01,02,03)

0073 First and last transfer C 1 a1 Wird verwendet, falls eine API-Meldung aus mehreren Teilmeldungen besteht (segmen-tierte API-Meldung).

Bei der ersten Teilmeldung muss der Wert 'C' gesetzt werden, bei der letzten Teilmeldung der Wert 'F'. Bei den anderen Teilmeldungen wird kein Wert gesetzt.

Tabelle 6: UNH Message Header

4.2.6 BGM Begin of Message

Beispiel: BGM+745'

Pos Tag Name S R Form. Bemerkungen

010 C002 DOCUMENT/MESSAGE NAME M 1

1001 Document Name Code M 1 an..3 =745 (Passenger list)

Tabelle 7: BGM Begin of Message

4.2.7 NAD Name and address (Reporting party)

Im NAD-Segment (Reporting Party) wird der Ersteller der API-Meldung angegeben

Beispiel: NAD+MS+++LUFTHANSA HELPDESK DME'

Pos Tag Name S R Form. Bemerkungen

010 3035 PARTY FUNCTION CODE QUALI-FIER

M 1 an..3 =MS (Document/message issuer/sender)

020 C082 PARTY IDENTIFICATION DETAILS C 1 Nicht verwendet

030 C058 NAME AND ADDRESS C 1 Nicht verwendet

040 C080 PARTY NAME M 1

3036 Party name M 1 an..35 Name des Erstellers der API-Meldung

Tabelle 8: NAD Name and address (Reporting party)

4.2.8 COM Communication contact (Reporting party)

Im COM Communication contact (Reporting party) Segment werden die Kommunikations-

Nummern (Telefon, Fax) des Erstellers der API-Meldung angegeben. Das Segment kann

mehrmals vorkommen, um mehrere Kommunikations-Nummern anzugeben.

Beispiel: COM+022 222 222222:TE'

Pos Tag Name S R Form. Bemerkungen

010 C076 COMMUNICATION CONTACT M 1

3148 Communication address identifier M 1 an..512

Telefon oder Fax Nummer

3155 Communication address code quali-fier

M 1 an..3 TE=Telefon FX=Telefax

Tabelle 9: COM Communication contact (Reporting party)

4.2.9 TDT Transport information

Beispiel: TDT+20+LH123+++LH'

Pos Tag Name S R Form. Bemerkungen

Page 15: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 15/23

Pos Tag Name S R Form. Bemerkungen

010 8051 TRANSPORT STAGE CODE QUALIFIER

M 1 an..3 =20 (Main-carriage transport)

020 8028 MEANS OF TRANSPORT JOUR-NEY IDENTIFIER

M 1 an..17

[0-9A-Z]{2,3}[0-9]{1,4}

Flug-Nummer (z.B. LH123). Falls die Flug-gesellschaft keinen IATA Code hat, wird der ICAO Code verwendet.

030 C220 MODE OF TRANSPORT C 1 Nicht verwendet

040 C001 TRANSPORT MEANS C 1 Nicht verwendet

050 C040 CARRIER M 1

3127 Carrier identifier M 1 an..17 [0-9A-Z]{2,3}

Fluggesellschaft-Code (IATA). Falls die Fluggesellschaft keinen IATA Code hat, wird der ICAO Code verwendet.

Tabelle 10: TDT Transport information

4.2.10 LOC Place/location identification (Flight itinerary)

Im LOC Place/location identification (Flight itinerary) Segment wird der Abflug- bzw. An-

kunftsflughafen angegeben.

Beispiel Abflug: LOC+125+DME'

Beispiel Ankunft: LOC+87+ZRH'

Pos Tag Name S R Form. Bemerkungen

010 3227 LOCATION FUNCTION CODE QUALIFIER

M 1 an..3 125=Abflug 87 =Ankunft

020 C517 LOCATION IDENTIFICATION M 1

3225 Location name code M 1 an..3 [A-Z]{3}

IATA Flughafen Code

Tabelle 11: LOC Place/location identification (Flight itinerary)

4.2.11 DTM Date/time/period (Flight itinerary)

Im DTM Date/time/period (Flight itinerary) Segment wird der Abflug- bzw. Ankunfts-Zeitpunkt

des Fluges angegeben (Datum und Uhrzeit).

Beispiel Abflug (STD): DTM+189:1101261430:201'

Beispiel Ankunft (STA): DTM+232:1101261730:201'

Pos Tag Name S R Form. Bemerkungen

010 C507 DATE/TIME/PERIOD M 1

2005 Date or time or period function code qualifier

M 1 an..3 189=Abflug (STD) 232=Ankunft (STA)

2380 Date or time or period text M 1 an..35 YYMMDDHHmm

Datum und Zeit des Abfluges oder der An-kunft

2379 Date or time or period format code M 1 an..3 =201 (YYMMDDHHmm)

Tabelle 12: DTM Date/time/period (Flight itinerar

Page 16: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 16/23

4.2.12 NAD Name and address (Traveler)

Im DTM Date/time/period (Flight itinerary) Segment wird der Name des Passagiers angege-

ben.

Beispiel: NAD+FL+++MUELLER:MARIA URSULA'

Pos Tag Name S R Form. Bemerkungen

010 3035 PARTY FUNCTION CODE QUALI-FIER

M 1 an..3 =FL (Passenger), DDU (in transit pass-enger)

020 C082 PARTY IDENTIFICATION DETAILS C 1 Nicht verwendet

030 C058 NAME AND ADDRESS C 1 Nicht verwendet

040 C080 PARTY NAME M 1

3036 Name and address description M 1 an..35 [A-Z\- ]{1,35}

Familienname (Surname). Mehrere Namen durch Leerzeichen (Space) getrennt

3036 Name and address description M 1 an..35 [A-Z\- ]{1,35}

Vornamen (Given Name). Mehrere Vorna-men durch Leerzeichen (Space) getrennt

Tabelle 13: NAD Name and address (Traveler)

4.2.13 ATT Attribute (Traveler Gender)

Im ATT Attribute (Traveler Gender) Segment wird das Geschlecht des Passagiers angege-

ben.

Beispiel: ATT+2++F'

Pos Tag Name S R Form. Bemerkungen

010 9017 ATTRIBUTE FUNCTION CODE QUALIFIER

M 1 an..3 =2 (Person)

020 C955 ATTRIBUTE TYPE C 1 Nicht verwendet

030 C956 ATTRIBUTE DETAIL M 1

9019 Attribute description code M 1 an..1 M=Male (männlich) F=Female (weiblich) U=Unidentified (unbekannt)

Tabelle 14: ATT Attribute (Traveler Gender)

4.2.14 DTM Date/time/period (Traveler Date of Birth)

Im DTM Date/time/period (Traveler Date of Birth) Segment wird das Geburtsdatum des Pas-

sagiers angegeben.

Beispiel: DTM+329:830326'

Pos Tag Name S R Form. Bemerkungen

010 C507 DATE/TIME/PERIOD M 1

2005 Date or time or period function code qualifier

M 1 an..3 =329 (Birth date/time)

2380 Date or time or period text M 1 n6 YYMMDD

Page 17: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 17/23

Pos Tag Name S R Form. Bemerkungen Geburtsdatum des Passagiers. Falls der Tag oder der Monat nicht bekannt sind, ist 00 anzugeben (z.B. 830000 falls nur das Geburtsjahr 1983 bekannt ist).

Tabelle 15: DTM Date/time/period (Traveler Date of Birth)

4.2.15 LOC Place/location identification (Traveler itinerary)

Im LOC Place/location identification (Traveler itinerary) Segment werden die Stationen der

Reiseroute des Passagiers angegeben. Der ursprüngliche Abreiseort (Port of embarkation)

und das endgültige Reiseziel (Port of disembarkation) müssen angegeben werden.

Beispiel: LOC+178+LED'

LOC+179+FRA'

Pos Tag Name S R Form. Bemerkungen

010 3227 LOCATION FUNCTION CODE QUALIFIER

M 1 an..3 178 = Port of embarkation 179 = Port of disembarkation

020 C517 LOCATION IDENTIFICATION M 1

3225 Location name code M 1 an..3 [A-Z]{3}

IATA Flughafen Code

Tabelle 16: LOC Place/location identification (Traveler itinerary)

4.2.16 NAT Nationality

Im NAT Nationality Segment wird die Nationalität des Passagiers angegeben. Es können bis

zu 8 Nationalitäten angegeben werden.

Beispiel: NAT+2+CHE'

Pos Tag Name S R Form. Bemerkungen

010 3493 NATIONALITY CODE QUALIFIER M 1 an..3 =2 (Current nationality)

020 C042 NATIONALITY DETAILS M 1

3293 Nationality name code M 1 an..3 [A-Z]{1,3}

Ländercode ISO 3166-1-alpha-3 mit Modifi-kationen gemäss [ICAO9303]

Tabelle 17: NAT Nationality

4.2.17 DOC Document/message details (Travel Document)

Im DOC Document/message details (Travel Document) werden die Daten zum Reisedoku-

ment des Passagiers.

Beispiel: DOC+P+XX123456789'

Pos Tag Name S R Form. Bemerkungen

010 C002 DOCUMENT/MESSAGE NAME M 1

1001 Document name code M 1 an..3 Dokumenttyp gemäss Kapitel 14.1.2 Doku-menttypen

020 C503 DOCUMENT/MESSAGE DETAILS M 1

1004 Document identifier M 1 an..20 [0-9A-Z]{1,20}

Page 18: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 18/23

Pos Tag Name S R Form. Bemerkungen Dokument ID (z.B. Passnummer)

Tabelle 18: DOC Document/message details (Travel Document)

4.2.18 DTM Date/time/period (Travel Document)

Im DTM Date/time/period (Travel Document) Segment wird das Ablaufdatum des Reisedo-

kuments angegeben.

Beispiel: DTM+36:150430'

Pos Tag Name S R Form. Bemerkungen

010 C507 DATE/TIME/PERIOD M 1

2005 Date or time or period function code qualifier

M 1 an..3 =36 (Expiry date)

2380 Date or time or period text M 1 n6 YYMMDD

Ablaufdatum des Reisedokuments.

Tabelle 19: DTM Date/time/period (Travel Document)

4.2.19 LOC Place/location identification (Travel Document)

Im LOC Place/location identification (Travel Document) Segment wird das Land angegeben,

welches das Reisedokument ausgestellt hat.

Beispiel: LOC+91+CHE'

Pos Tag Name S R Form. Bemerkungen

010 3227 LOCATION FUNCTION CODE QUALIFIER

M 1 an..3 =91 (Place of document issue)

020 C517 LOCATION IDENTIFICATION M 1

3225 Location name code M 1 an..3 [A-Z]{1,3}

Ländercode ISO 3166-1-alpha-3 mit Modi-fikationen gemäss [ICAO9303]

Tabelle 20: LOC Place/location identification (Travel Document)

4.2.20 CNT Control total

Im CNT Control total Segment wird die Anzahl Passagiere des Fluges angegeben.

Beispiel: CNT+42:1'

Pos Tag Name S R Form. Bemerkungen

010 C270 CONTROL M 1

6069 Control total type code qualifier M 1 an..3 =42 (Total number of passengers)

6066 Control total quantity M 1 n..18 Anzahl Passagiere des Fluges. Falls eine API-Meldung aus mehreren Teilmeldun-gen besteht (segmentierte API-Meldung), ist das Total über alle Teilmeldungen an-zugeben.

Tabelle 21: Control total

Page 19: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 19/23

4.2.21 UNT Message Trailer

Beispiel: UNT+19+MRN123456789'

Pos Tag Name S R Form. Bemerkungen

010 0074 Number of segments in a Message M 1 n..10 Anzahl Segmente im Meldungs-Body inklu-sive der UNH Header und UNT Trailer Segmente. Die UNA-, UNB-, UNG-, UNE- und UNZ-Segmente werden nicht gezählt

020 0062 Message reference number M 1 an..14 Eindeutige Referenz der Meldung beim Absender. Gleicher Wert wie im UNH Mes-sage Header (Tag 0062)

Tabelle 22: UNT Message trailer

4.2.22 UNZ Interchange Trailer

Beispiel: UNZ+1+ICR123456789'

Pos Tag Name S R Form. Bemerkungen

010 0036 Interchange Control Count M 1 n..6 =1

020 0020 Message reference number M 1 an..14 Eindeutige Referenz der API-Meldung beim Absender. Gleicher Wert wie im UNB Inter-change Header(Tag 0020)

Tabelle 23: UNZ Message trailer

4.3 CSV

Die Flug- und Passagierdaten werden in einer CSV Datei zusammengefasst. Die Datensätze

werden zeilenweise angeordnet. Die Felder werden durch ein Spaltentrennsymbol getrennt.

Zeilentrennsymbol: <CR><LF>

Spaltentrennsymbol: ; (Semikolon)

Die spezifizierte Reihenfolge der Felder muss eingehalten werden. Die erste Zeile enthält die

Angaben zum Flug, die zweite und die danach folgenden Zeilen die Passagierdaten. Die Da-

tei darf keine weiteren Zeilen enthalten (keine Kopfzeilen).

1. Zeile (Flugdaten):

Nr Feld Format Opt. Beispiel Hinweis

1 Fluggesellschaft [0-9A-Z]{2,3} N LH IATA-Code. Falls die Fluggesellschaft

keinen IATA Code hat, wird der ICAO

Code verwendet.

2 Flugnummer [0-9A-Z]{2,3}

[0-9]{1,4}

N LH123 Flug-Nummer. Falls die Fluggesell-

schaft keinen IATA Code hat, wird der

ICAO Code verwendet.

3 Abflug Flughafen [A-Z]{3} N DME IATA Flughafen Code

4 Abflugdatum YYMMDD N 101026 Scheduled Date of Departure (STD)

5 Abflugzeit HHmm N 1018 Scheduled Time of Departure (STD)

6 Ankunft Flughafen [A-Z]{3} N ZRH IATA Flughafen Code

7 Ankunftsdatum YYMMDD N 101026 Scheduled Date of Arrival (STA)

8 Ankunftszeit HHmm N 1220 Scheduled Time of Arrival (STA)

9 Anzahl Passagiere [0-9]{1,3} N 12

Tabelle 24 CSV 1. Zeile

2. Zeile und folgende (Passagierdaten):

Page 20: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 20/23

Nr Feld Format Op

t.

Beispiel Hinweis

1 Nachname [A-Z\- ]{1,35} N MEIER Familienname (Surname). Mehre-

re Namen durch Leerzeichen

(Space) getrennt

2 Vornamen [A-Z\- ]{1,35} N JAN ULF Vornamen (Given Name). Mehre-

re Vornamen durch Leerzeichen

(Space) getrennt

3 Geschlecht M|F|U N M M=Male (männlich)

F=Female (weiblich)

U=Unidentified (unbekannt)

4 Geburtsdatum YYMMDD N 830520 Falls der Tag oder der Monat nicht

bekannt sind, ist 00 anzugeben

(z.B. 830000 falls nur das Ge-

burtsjahr 1983 bekannt ist).

5 Nationalitäten [A-Z]{3}

([A-Z]{3}){0,7}

N CHE Ländercode ISO 3166-1-alpha-3

mit Modifikationen gemäss [I-

CAO9303]. Mehrere Nationalitäten

werden durch Leerzeichen

(Space) getrennt. Maximal 8 Nati-

onalitäten.

6 Ursprünglicher

Abreiseort

[A-Z]{3} N LED IATA Flughafen Code

Port of embarkation

7 Endgültiges Rei-

seziel

[A-Z]{3} N FRA IATA Flughafen Code

Port of disembarkation

Reisedokument 1

8 Dokumenttyp

Reisedokument 1

[A-Z]{1,2} N P Dokumenttyp gemäss Kapitel

4.1.2 Dokumenttypen

9 Dokument-ID

Reisedokument 1

[0-9A-Z]{1,20} N AB1234 Dokument ID (z.B. Pass Nummer)

10 Austellerstaat

Reisedokument 1

[A-Z]{3} N CHE Ländercode ISO 3166-1-alpha-3

mit Modifikationen gemäss [I-

CAO9303].

11 Ablaufdatum

Reisedokument 1

YYMMDD J 150720

Reisedokument 29

12 Dokumenttyp

Reisedokument 2

[A-Z]{1,2} J V Dokumenttyp gemäss Kapitel

4.1.2 Dokumenttypen

13 Dokument-ID

Reisedokument 2

[0-9A-Z]{1,20} J AB321 Dokument ID (z.B. Pass Nummer)

14 Austellerstaat

Reisedokument 2

[A-Z]{3} J CHE Ländercode ISO 3166-1-alpha-3

mit Modifikationen gemäss [I-

CAO9303].

15 Ablaufdatum

Reisedokument 2

YYMMDD J 150720

Tabelle 25 CSV 2. Zeile und folgende (Passagierdaten)

9 Die Spalten zum Reisedokument 2 werden nur verwendet, falls der Passagier zwei Reisedokumente

hat (z.B. Pass und Visa bzw. Aufenthaltstitel). In diesem Fall ist als Reisedokument 1 der Pass und als

Reisedokument 2 das Visa bzw. der Aufenthaltstitel anzugeben

Page 21: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 21/23

5 Anhang

5.1 Beispiel Meldung UN/EDIFACT ohne Segmentierung

UNA:+.? '

UNB+UNOA:4+LUFTHANSA:ZZ+HDQCH2X:ZZ+110126:1409+123456789++APIS'

UNH+00102052460024+PAXLST:D:02B:UN:IATA'

BGM+745'

NAD+MS+++LUFTHANSA HELPDESK DME'

COM+044 222 222222:TE'

TDT+20+LH123+++LH'

LOC+125+DME'

DTM+189:1101261430:201'

LOC+87+ZRH'

DTM+232:1101261730:201'

NAD+FL+++MUELLER:MARIA URSULA'

ATT+2++F'

DTM+329:830326'

LOC+178+DME'

LOC+179+ZRH'

NAT+2+CHE'

DOC+P+XX123456789'

DTM+36:150430'

LOC+91+CHE'

NAD+FL+++MEIER:JAN'

ATT+2++M'

DTM+329:720521'

LOC+178+DME'

NAT+2+CHE'

DOC+P+AA445566'

DTM+36:130101'

LOC+91+CHE'

NAD+FL+++PORIZKOVA:SERGEI'

ATT+2++M'

DTM+329:720412'

LOC+178+LED'

LOC+179+FRA'

NAT+2+RUS'

DOC+P+789456'

DTM+36:120901'

LOC+91+RUS'

DOC+V+88994422'

DTM+36:110501'

LOC+91+CHE'

CNT+42:3'

UNT+40+00102052460024'

UNZ+1+123456789'

5.2 Beispiel Meldung UN/EDIFACT mit Segmentierung

5.2.1 Teilmeldung 1/3

UNA:+.? '

Page 22: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 22/23

UNB+UNOA:4+LUFTHANSA:ZZ+HDQCH2X:ZZ+110126:1409+987654321++APIS'

UNH+00102052460024+PAXLST:D:02B:UN:IATA+123456789+01:C'

BGM+745'

NAD+MS+++LUFTHANSA HELPDESK DME'

COM+044 222 222222:TE'

TDT+20+LH123+++LH'

LOC+125+DME'

DTM+189:1101261430:201'

LOC+87+ZRH'

DTM+232:1101261730:201'

NAD+FL+++MUELLER:MARIA URSULA'

ATT+2++F'

DTM+329:830326'

LOC+178+DME'

LOC+179+ZRH'

NAT+2+D'

DOC+P+XX123456789'

DTM+36:150430'

LOC+91+D'

NAD+FL+++MEIER:JAN'

ATT+2++M'

DTM+329:720521'

LOC+178+DME'

LOC+179+ZRH'

NAT+2+CHE'

DOC+P+AA445566'

DTM+36:130101'

LOC+91+CHE'

CNT+42:5'

UNT+29+00102052460024'

UNZ+1+987654321'

5.2.2 Teilmeldung 2/3

UNA:+.? '

UNB+UNOA:4+LUFTHANSA:ZZ+HDQCH2X:ZZ+110126:1409+987654321++APIS'

UNH+00102052460025+PAXLST:D:02B:UN:IATA+123456789+02'

BGM+745'

NAD+MS+++LUFTHANSA HELPDESK DME'

COM+044 222 222222:TE'

TDT+20+LH123+++LH'

LOC+125+DME'

DTM+189:1101261430:201'

LOC+87+ZRH'

DTM+232:1101261730:201'

NAD+FL+++MEIER:HANS MARTIN'

ATT+2++M'

DTM+329:720821'

LOC+178+DME'

LOC+179+DME'

NAT+2+CHE'

DOC+P+BB334455'

DTM+36:151001'

LOC+91+CHE'

Page 23: API -Schnittstellenspezifikation · PDF fileAdvance Eidgenössisches JustizPassenger Information, API - und Polizeidepartement EJPD API-Schni tstel ensp zifika ion Staatssekretariat

Advance Passenger Information, API Eidgenössisches Justiz- und Polizeidepartement EJPD

Staatssekretariat für Migration API-Schnittstellenspezifikation

API-Schnittstellenspezifikation V1.4 vom 25.05.2016 23/23

NAD+FL+++PORIZKOVA:IVANA

ATT+2++F'

DTM+329:700412'

LOC+178+LED'

LOC+179+FRA'

NAT+2+RUS'

DOC+P+78945678'

DTM+36:121001'

LOC+91+RUS'

DOC+V+88994420'

DTM+36:110501'

LOC+91+CHE'

CNT+42:5'

UNT+32+00102052460025'

UNZ+1+987654321'

5.2.3 Teilmeldung 3/3

UNA:+.? '

UNB+UNOA:4+LUFTHANSA:ZZ+HDQCH2X:ZZ+110126:1409+987654321++APIS'

UNH+00102052460026+PAXLST:D:02B:UN:IATA+123456789+03:F'

BGM+745'

NAD+MS+++LUFTHANSA HELPDESK DME'

COM+044 222 222222:TE'

TDT+20+LH123+++LH'

LOC+125+DME'

DTM+189:1101261430:201'

LOC+87+ZRH'

DTM+232:1101261730:201'

NAD+FL+++PORIZKOVA:SERGEI'

ATT+2++M'

DTM+329:720412'

LOC+178+LED'

LOC+179+FRA'

NAT+2+RUS'

DOC+P+789456'

DTM+36:120901'

LOC+91+RUS'

DOC+V+88994422'

DTM+36:110501'

LOC+91+CHE'

CNT+42:5'

UNT+23+00102052460025'

UNZ+1+987654321'

5.3 Beispiel Meldung CSV

LH;LH123;DME;101026;1018;ZRH;101026;1220;3

MEIER;JAN ULF;M;720429;D;DME;ZRH;P;12345678;D;130101

MUELLER;ERIKA;F;730325;CHE;DME;ZRH;P;XX55432;CHE;120501

PORIZKOVA;SERGEI;M;720412;RUS;LED;FRA;P;789456;RUS;120901;V;88994422;CHE;110501