enee xml message exchange - uic · pdf file3 xlm messages description 3.1 xml update request...

ENEE XML MESSAGE EXCHANGE

Document history Version Description Date V 0.1 Message exchange for Freight data 2005-09-02 V 0.2 Including Passenger data 2005-10-04 V 0.3 Modification of the tag ‘OriginDestination’ 2006-04-03 V 0.4 Modification longueur

SIGLE_UNICODE_FSS de 10AN à 150AN

2006-08-29

ENEE MESSAGE EXCHANGE

Septembre 2005 - 2 -

CCoonntteenntt Content ...................................................................................................................................- 2 - 1 Introduction ....................................................................................................................- 4 -

1.1 Main Data coming from ENEE environment:........................................................- 4 - 1.2 Main Data coming from railways Informatics system: ..........................................- 4 - 1.3 Organisation of the Update ....................................................................................- 4 -

2 Messages ........................................................................................................................- 5 - 2.1 XML messages flow...............................................................................................- 5 -

2.1.1 XML messages Exchange model ...................................................................- 5 - 2.1.2 Railway Informatics system to UIC ...............................................................- 5 - 2.1.3 UIC to Railways IT system ............................................................................- 5 -

2.2 CSV messages flow................................................................................................- 6 - 2.2.1 CVS messages Exchange model ....................................................................- 6 - 2.2.2 List of the reference table...............................................................................- 6 -

3 XLM messages description ............................................................................................- 6 - 3.1 XML Update Request.............................................................................................- 6 -

3.1.1 Message Header (mandatory).........................................................................- 7 - 3.1.2 Location (optional) .........................................................................................- 7 -

3.1.2.1 Location General Information (optional) ...................................................- 7 - 3.1.2.2 International sorting points (optional)........................................................- 8 - 3.1.2.3 Border points (optional) .............................................................................- 8 - 3.1.2.4 Location Identification Name Trans (optional)..........................................- 8 - 3.1.2.5 Location Additional Information (Mandatory)..........................................- 9 - 3.1.2.6 Location Passenger Information (Optional) ...............................................- 9 -

3.2 XML Ack .............................................................................................................- 10 - 3.2.1 Message Header: ..........................................................................................- 10 - 3.2.2 Application Error Description (optional) .....................................................- 11 - 3.2.3 Technical Error Description (optional) ........................................................- 11 - 3.2.4 Accepted (mandatory) ..................................................................................- 11 -

3.3 XML Update Daily Report...................................................................................- 13 - 3.4 XML Initialisation Delivery.................................................................................- 13 -

4 CSV message description.............................................................................................- 13 - 4.1 Table T_INTERV_FERR (Railway body)...........................................................- 14 - 4.2 Table T_TRAD_INTERV_FERR (Translation of railway body)........................- 15 - 4.3 Table T_TYPE_INTERV_FERR (Railway body types) .....................................- 15 - 4.4 Table T_PAYS (country) .....................................................................................- 16 - 4.5 Table T_TRAD_PAYS (translation country) ......................................................- 16 - 4.6 Table T_PT_FRONTIERE (Border point)...........................................................- 17 - 4.7 Table T_TYPE_PT_FRONT (Border point types) ..............................................- 18 - 4.8 Table T_TYPE_LIMIT (Limit type)....................................................................- 18 -



4.9 Table T_CAT_ETAB (Location category) ..........................................................- 19 - 4.10 Table T_TRAD_CAT_ETAB (Location category translation)............................- 19 - 4.11 Table T_NN_PAYS_IF (Relationship between country and railway).................- 20 -

5 File naming, file transport ............................................................................................- 21 - 5.1 File naming...........................................................................................................- 21 - 5.2 File transport ........................................................................................................- 21 -

ANNEX A Codes and texts error list ...................................................................................- 22 - ANNEX B XML schema .....................................................................................................- 24 - ANNEX C XML schema ...................................................................................................- 25 -



11 IInnttrroodduuccttiioonn This document describes the update data exchanges flow between a fret, passenger or infrastructure Informatics system and ENEE Database environment.

11..11 MMaaiinn DDaattaa ccoommiinngg ff rroomm EENNEEEE eennvvii rroonnmmeenntt:: • Freight, passenger and infrastructure locations from UIC members; • Sorting points; • Border stations; • Complementary data; • Reference data.

11..22 MMaaiinn DDaattaa ccoommiinngg ff rroomm rraaii llwwaayyss IInnffoorrmmaattiiccss ssyysstteemm:: • Freight, passenger and infrastructure locations; • Sorting points; • Border stations.

11..33 OOrrggaanniissaattiioonn ooff tthhee UUppddaattee General principle: freight, passenger and infrastructure data are physically managed in the same database but a given station may be deleted from the passenger sector of the database and continue to figure in the freight sector (see Location Additional Information). It should be possible for different people, depending on the sector involved, to input and update the database at any time.

Depending on the way in which a location is organised: - either a sole manager should be appointed to update the freight, passenger and infra

sectors, - or a manager should be appointed for each sector (freight, passenger and infra).



22 MMeessssaaggeess

22..11 XXMMLL mmeessssaaggeess ff llooww

2.1.1 XML messages Exchange model

2.1.2 Railway Informatics system to UIC A Railway Informatics system send to UIC database an XML Update Request message: • Every day; • Or when they are changes on their own database.

2.1.3 UIC to Railways IT system Update occurs in ENEE database with: • ENEE web interface on the UIC web site http://www.uic.asso.fr/enee/; • XML Update Request message; • FGE message (until the June 2005). UIC send an Update Daily Report containing the updated data to Railway Informatics system. When UIC receives a XML Update Request, UIC sends back an XML Ack to validate or invalidate the XML Update Request.

Railways system s

UIC

Message Update_Request

Message Ack

Message Update_Daily Report



22..22 CCSSVV mmeessssaaggeess ff llooww When there are changes on one ENEE database reference table UIC sends a CSV file with the full content of this table, and all the tables from the list below 2.2.2.

2.2.1 CVS messages Exchange model

2.2.2 List of the reference table • table T_INTERV_FERR • table T_TRAD_INTERV_FERR • table T_TYPE_INTERV_FERR • table T_PAYS • table T_TRAD_PAYS • table T_PT_FRONTIERE • table T_TYPE_PT_FRONT • table T_TYPE_LIMIT • table T_CAT_ETAB • table T_TRAD_CAT_ETAB • table T_NN_PAYS_IF

33 XXLLMM mmeessssaaggeess ddeessccrriippttiioonn

33..11 XXMMLL UUppddaattee RReeqquueesstt According to the agreement between UIC and a railway organization Update Request can be: • Daily, in that case the XML message contains the mandatory Message Header element

and depending if there is an update or not 0 to n Location element; • Weekly same rules apply for XML message 0 to n Location element; • Only when an update occurs.

Railways system UIC

Message All CSV files



The processing of the Update Request message is automatic in the UIC system. For the details of the Update Request XML schema see Annex B

3.1.1 Message Header (mandatory) Description of fields Size and

type of fields

M (mandatory)/ O (optional)

Remarks

Message Header Type 3 AN M UPD, ACK, UPR Version 4 AN M Version number of the message type From 4 N M Sender of the message – RU Code To 4 N M Receiver of the message – RU Code

or UIC code :3011 Message ID 5 N M Unique identifier of the message

corresponds to the numerical counter in the file name.

Timestamp Date

M Date and time of the message creation. YYYY-MM-DDTHH:MM:SS

RefToMessageId 5 N

O refers to a specific message not present in the Update Request message

3.1.2 Location (optional) 3.1.2.1 Location General Information (optional) Description of fields Size and

type of fields


Remarks

Railway Undertaking Identification

4 N M RICS code ( company code) – At the moment 00 + the old RU code on 2 positions is still used in the database

LocationCode 5 N M Code of the location Self-Check digit 1 N M UIC leaflet 913 Location Name 35 AN M Location main name Country 2 AN M ISO country code 3166 LocationCategoryCode 2 AN M Uses current code values -

00: inland station 01: border station 05: town or city offices 06: travel organisations 09: other

Language 2 AN O Language ISO code 639-1988



ValidityPeriod From Date O Opening date of the location YYYY-MM-DD

ValidityPeriod To Date O Closing date of the location YYYY-MM-DD

ContainerHandling

Boolean O True / False

Nuts 5 AN O NUTS = EUROSTAT nomenclature of territorial units for European statistics

FreeText 255 AN O Comments

3.1.2.2 International sorting points (optional) Description of fields Size and

type of fields


Remarks


4 N M RICS code ( company code)

LocationSortingPointCode 5 AN M Code of the sorting point PrincipalSortingPoint Boolean O True / False ValidityPeriod From Date O Opening date of the sorting point

YYYY-MM-DD ValidityPeriod To Date O Closing day of the sorting point

YYYY-MM-DD FreeText 255 AN O Comments

3.1.2.3 Border points (optional) Description of fields Size and

type of fields


Remarks


4 N M RICS code ( company code)

LocationFrontierPointCode 4N M Code of the frontier point ValidityPeriod From Date O Opening date of the frontier point

YYYY-MM-DD ValidityPeriod To Date O Closing day of the frontier point

YYYY-MM-DD FreeText 255 AN O Comments

3.1.2.4 Location Identification Name Trans (optional) Description of fields Size and

type of fields


Remarks

SequenceNumber 2 N M Language 2 AN M Language ISO code 639-1988



LocationName 35 AN M Location name in the language 3.1.2.5 Location Additional Information (Mandatory) Description of fields Size and

type of fields


Remarks

Gauge Decimal O 0.760, 1.050, 1.435, 1.520, 1.524, 1.602, 1.668

BogieChange Y /N O LocationIdentificationFreightName 150 AN O Use in the Daily report

XML message, UIC can only give this information.

LocationIdentificationPassengerName 150 AN O Use in the Daily report XML message, UIC can only give this information.

PropertyFootnoteCode 5 AN O Code characterizing the network owner of the location. Use in the Daily report XML message, UIC can only give this information.

Infrastructure Boolean M True / False Infrastructure location1

Passenger Boolean M True / False Passenger location2

Fret Boolean M True / False Freight location3

3.1.2.6 Location Passenger Information (Optional) Description of fields Size and

type of fields


Remarks

ValidityPeriod From Date O Opening date of the location, YYYY-MM-DD

1 To open or close an existing location for infrastructure domain. 2 To open or close an existing location for passenger domain. 3 To open or close an existing location for freight domain.



ValidityPeriod To Date O Closing day of the location YYYY-MM-DD

LocationPassengerName 17 AN O Name 17 characters in capitals

PassengerLocationTariffZone 9 N O Tariff zone to which location belongs (RU code + location code)

PassengerLocationSeatReservation Code

7 N O Seat reservation code (2N country code + 5N code)

OriginDestination Boolean O True / False TariffZone Boolean O True / False SalesPoint Boolean O True / False CrossingPoint Boolean O True / False MeritsTimetable Boolean O True / False4 TCV Boolean O True / False International

common tariff for the passenger transport

Attributes with a value of True or False (OriginDestination, tariff zone, sales outlet, etc.) are used to extract specific lists of locations.

33..22 XXMMLL AAcckk The XML Ack is an acknowledgement that receives the system after sending his own data information with XML Update request message. This acknowledgment delivers two types of errors: • Error on the message structure: Application error (see annex A); • Error on the message data: Technical error (see annex A). The processing of the Ack message is automatic in the UIC system. For the details of the Ack XML schema see Annex C.

3.2.1 Message Header: Description of fields Size and

type of fields


Remarks

Message Header Type 3 AN M UPD, ACK, UPR Version 4 AN M Version number of the message type From 4 N M Sender of the message To 4 N M Receiver of the message

4 If it is a passenger location the Boolean must be true.



Message ID 5 N M Unique identifier of the message corresponds to the numerical counter in the file name.

Timestamp Date M Date and time of the message creation. YYYY-MM-DDTHH:MM:SS

RefToMessageId N

O refers to a specific message

3.2.2 Application Error Description (optional) Description of fields Size and

type of fields


Remarks

LocationCode 5 N M Code of the location ApplicationErrorConditionCode 3 N M See annex A FreeFormDescription 150 AN O See annex A CopyOfBadDataElement 150 AN O

3.2.3 Technical Error Description (optional) Description of fields Size and

type of fields


Remarks

LocationCode 5 N M Code of the location TechnicalErrorConditionCode 3 N M See annex A FreeFormDescription 150 AN O See annex A CopyOfBadDataElement 150 AN O

3.2.4 Accepted (mandatory) Description of fields Size and

type of fields


Remarks

Accepted Boolean M True / False • If the element Accepted is true the XML Update Request message is correct and the data

contained are inserted in the ENEE database.



• If the element Accepted is false the XML Update Request message is not correct and all the data are rejected. If the XML Update Request message contain no Location element is considered false also.



33..33 XXMMLL UUppddaattee DDaaii llyy RReeppoorrtt According to the agreement between UIC and a railway organization Update Daily Report can be: • Daily, in that case the XML message contains the mandatory element Message Header

and depending if there is an update or not 0 to n Location element; • Weekly, monthly same rules apply for XML message 0 to n location element. The processing of the Update Daily Report message is automatic in the UIC system. For the elements details see chapter XML Update Request. For the details of the Update Daily Report XML schema see Annex B

33..44 XXMMLL IInnii ttiiaall iissaattiioonn DDeell iivveerryy The XML Initialisation delivery message occurs on the demand of the railway organization. This demand can be made by mail [email protected] or by phone with the ENEE Database administrator. XML Initialisation Delivery message can deliver: • All the locations of the ENEE Database; • All the locations of a specific Railway. For the elements details see chapter XML Update Request. For the details of the Update Daily Report XML schema see Annex B.

44 CCSSVV mmeessssaaggee ddeessccrriippttiioonn In order to identify the content of a transmitted file, the data ‘TYPE_LIGNE’ will have a specific 2 digit number per reference table (see the list below). • 10 Railway body (table T_INTERV_FERR) • 31 Railway body Translation (table T_TRAD_INTERV_FERR) • 43 Railway body types (table T_TYPE_INTERV_FERR) • 22 Country (table T_PAYS) • 35 Country translation (table T_TRAD_PAYS) • 24 Border point (table T_PT_FRONTIERE) • 45 Border point types (table T_TYPE_PT_FRONT) • 44 Limit type (table T_TYPE_LIMITE) • 01 Location category (table T_CAT_ETAB) • 29 Location category translation (table T_TRAD_CAT_ETAB) • 21 Relationship between country and railway (table T_NN_PAYS_IF)



44..11 TTaabbllee TT__IINNTTEERRVV__FFEERRRR ((RRaaii llwwaayy bbooddyy)) A railway body is clearly defined in Leaflet 920-1 and covers: • Railway Undertakings: under the terms of EU Directive 91/440, this includes "any private

or public undertaking whose main business is to provide rail transport services for goods and/or passengers with a requirement that the undertaking should ensure traction"; .

• Infrastructure Managers: under the terms of Directive 91/440, this includes "any public

body or undertaking responsible in particular for establishing and maintaining railway infrastructure, as well as for operating the control and safety systems";

• Railway Companies: these correspond to what was formerly referred to simply as

"railways", in other words a single legal entity combining the functions of railway undertaking and infrastructure manager as defined above;

• Other transport bodies: these are bodies belonging to one or more international

organisations and applying conventions that require information to be exchanged in any form;

Description of fields Size and

type of fields


Remarks

TYPE_LIGNE 2 N M 10 CODE_IF 4 N M Railway code TYPE_IF 2 AN M 1 : Integrated Enterprise

2 : Infrastructure manager 3 : Railway Undertaking 4 : Other

CODE_PAYS_SIEGE 2 AN M Country code SIGLE_UNICODE_FSS 150 AN M Initials of the railway NOM_UNICODE_FSS 150 AN O Name of the railway in

the country language COMMENTAIRE 255 AN O comments Examples:TYPE_LIGNE;CODE_IF;TYPE_IF;CODE_PAYS_SIEGE;SIGLE_UNICODE_FSS;NOM_IF_UNICODE_FSS;COMMENTAIRE; 10;10;1;FI;VR;VR-YHTYMA OY;; 10;20;1;RU;RZD;ROSSIYSKIE ZHELEZNYE DOROGI;; 10;21;1;BY;BC;BELARUSSKAYA CHYGUNKA;; 10;22;1;UA;UZ;UKRZAINSKI ZALIZNYTSI;; 10;23;1;MD;CFM;CALEA FERATA DIN MOLDOVA;; 10;27;1;KZ;KZH;KAZAKHSTAN TEMIR ZHOLY;; 10;31;1;MN;MTZ;MONGOLIN TUMYR ZAM;; 10;32;1;VN;DSVN;DUONG SAT VIET NAM;;



44..22 TTaabbllee TT__TTRRAADD__IINNTTEERRVV__FFEERRRR ((TTrraannssllaattiioonn ooff rraaii llwwaayy bbooddyy))

Table used to list the name of the railways body in different language. Description of fields Size and

type of fields


Remarks

TYPE_LIGNE 2 N M 31 CODE_IF 4 N M Railway code CODE_LANGUE 2 AN M FR; DE; EN NOM_IF 150 AN M Railway name wording in

the language indicated (in CODE_LANGUE)

NOM_IF_R 150 AN O Railway name wording in capital letter in the language indicated (in CODE_LANGUE)

COMMENTAIRE 255 AN O comments Examples TYPE_LIGNE;CODEIF;CODE_LANGUE;NOM_IF;NOM_IF_R;COMMENTAIRE; 31;10;DE;VR Gruppe AG;VR GRUPPE AG;; 31;20;DE;Russische Eisenbahnen;RUSSISCHE EISENBAHNEN;; 31;24;FR;Chemins de fer Lituaniens;CHEMINS DE FER LITUANIENS;; 31;26;FR;Chemins de fer d'Estonie;CHEMINS DE FER D'ESTONIE;; 1;28;EN;Georgian Railways;GEORGIAN RAILWAYS;; 31;29;EN;Uzbekistan Railways;UZBEKISTAN RAILWAYS;;

44..33 TTaabbllee TT__TTYYPPEE__IINNTTEERRVV__FFEERRRR ((RRaaii llwwaayy bbooddyy ttyyppeess)) Table used to list different types of railway body. Description of fields Size and

type of fields


Remarks

TYPE_LIGNE 2 N M 43 CODE_TYPE_IF 2 N M 1 : Integrated Enterprise

2 : Infrastructure manager 3 : Railway Undertaking 4 : Other

COMMENTAIRE 255 AN O comments Examples:



TYPE_LIGNE;CODE_TYPE_IF;COMMENTAIRE; 43;1;Entreprise intégrée; 43;2;Gestionnaire d'infrastructure; 43;3;Entreprise ferroviaire; 43;4;Autre que EI, GI ou EF;

44..44 TTaabbllee TT__PPAAYYSS ((ccoouunnttrryy)) Table used to a country in the geographical and political sense of the word. Country codes are created under the ISO standard. Description of fields Size and

type of fields


Remarks

TYPE_LIGNE 2 N M 22 CODE_PAYS_ISO 2 AN M ISO country code 3166 CODE_PAYS_UIC 2 N O UIC country code Examples: TYPE_LIGNE;CODE_PAYS_ISO;CODE_PAYS_UIC; 22;AL;41; 22;AM;58; 22;AT;81; 22;AZ;57; 22;BA;89; 22;BE;88; 22;BG;52; 22;BY;21; 22;CH;85;

44..55 TTaabbllee TT__TTRRAADD__PPAAYYSS ((ttrraannssllaattiioonn ccoouunnttrryy)) Table used to have Name of country in different language. Description of fields Size and

type of fields


Remarks

TYPE_LIGNE 2 N M 35 CODE_LANGUE 2 AN M FR; DE; EN CODE_PAYS_ISO 2 AN M ISO country code 3166 NOM_PAYS 250 AN M Country name wording in

the language indicated (in CODE_LANGUE)



NOM_PAYS_R 250 AN O Country name wording in capital letter in the language indicated (in CODE_LANGUE)

Examples: TYPE_LIGNE;CODE_LANGUE;CODE_PAYS_ISO;NOM_PAYS;NOM_PAYS_R; 35;DE;FI;Finnland;FINNLAND; 35;DE;RU;Russland;RUSSLAND; 35;DE;BY;Weissrussland;WEISSRUSSLAND; 35;DE;UA;Ukraine;UKRAINE; 35;DE;MD;Moldavien;MOLDAVIEN; 35;DE;LT;Litauen;LITAUEN; 35;DE;EE;Estland;ESTLAND;

44..66 TTaabbllee TT__PPTT__FFRROONNTTIIEERREE ((BBoorrddeerr ppooiinntt)) Table used to list of the geographical border points between two countries. It can have a range of different uses: - tariff/pricing - accounting - Operational. A border point is allocated by UIC Description of fields Size and

type of fields


Remarks

TYPE_LIGNE 2 N M 24 CODE_PT_FRONT 4 N M Border point code. CODE_TYPE_PT_FRONT 2 AN O 2 : Terrestrial border point

3 : Harbours except ferry 4 : Ferry harbours

CODE_TYPE_LIMITE 2 AN O 0 : Geographical 3 : Between infrastructures of the same country 3 : For tariff usage

IND_FRET Boolean O Fret border point True / False

IND_VOY Boolean O Passenger border point True / False

IND_INFR Boolean O Infrastructure border point True / False

NOM_PRINC_A 35 AN M Name in pays A NOM_PRINC_B 35 AN O Name in pays B



DATE_DEB_APP Date O Beginning dates of registration DDMMYYYY

DATE_FIN_APP Date O Ending date of registration DDMMYYYY

CODE_PAYS_ISO_A 2 AN O Side A ISO country code 3166

CODE_PAYS_ISO_B 2 AN O Side B ISO country code 3166

CODE_IF_B 4 N O Side B railway code CODE_IF_A 4 N O Side A railway code

44..77 TTaabbllee TT__TTYYPPEE__PPTT__FFRROONNTT ((BBoorrddeerr ppooiinntt ttyyppeess)) Table used to list the different type of frontier border point. Description of fields Size and

type of fields


Remarks

TYPE_LIGNE 2 N M 45 CODE_TYPE_PT_FRONT 2 N M 2 : Terrestrial border point

3 : Harbours except ferry 4 : Ferry harbours

COMMENTAIRE 255 AN O comments Examples: TYPE_LIGNE;CODE_TYPE_PT_FRONT;COMMENTAIRE; 45;1;Réservé 1; 45;2;Point frontière terrestre; 45;3;Port sauf ferry; 45;4;Port ferry; 45;5;Réservé 5;

44..88 TTaabbllee TT__TTYYPPEE__LLIIMMIITT ((LLiimmii tt ttyyppee)) Table used to list limit related to a frontier border point.

Description of fields Size and

type of fields


Remarks

TYPE_LIGNE 2 N M 44



CODE_TYPE_LIMITE 2 N M 0 : Geographical 3 : Between infrastructures of the same country 3 : For tariff usage

COMMENTAIRE 255 AN O comments Examples: TYPE_LIGNE;CODE_TYPE_LIMITE;COMMENTAIRE; 44;0;Géographique; 44;1;Entre infrastructures d'un même pays; 44;3;Pour usage tarifaire;

44..99 TTaabbllee TT__CCAATT__EETTAABB ((LLooccaattiioonn ccaatteeggoorryy)) Table used to list the location category code. Description of fields Size and

type of fields


Remarks

TYPE_LIGNE 2 N M 01 CODE_CAT_ETABL 2 N M 00 : Inland station

01 : Frontier station 05 : Town office 06 : Travel agency 09 : Other stations

COMMENTAIRE 255 AN O comments Examples: TYPE_LIGNE;CODE_CAT_ETABL;COMMENTAIRE; 01;00;; 01;01;; 01;05;; 01;06;; 01;09;;

44..1100 TTaabbllee TT__TTRRAADD__CCAATT__EETTAABB ((LLooccaattiioonn ccaatteeggoorryy ttrraannssllaattiioonn))

Table used to list the location categories in different language.



Description of fields Size and type of fields


Remarks

TYPE_LIGNE 2 N M 29 CODE_CAT_ETABL 2 N M 00 : Inland station

01 : Frontier station 05 : Town office 06 : Travel agency 09 : Other stations

CODE_LANGUE 2 AN O ISO country code 3166 LIB_CATEG 255 AN O Category wording in the

language indicated (in CODE_LANGUE)

LIB_CATEG_R 255 AN O Category wording in capital letter in the language indicated wording in capital letter in the language indicated (in CODE_LANGUE)

Examples: TYPE_LIGNE;CODE_CAT_ETABL;CODE_LANGUE;LIB_CATEG;LIB_CATEG_R; 29;00;FR;Gare intérieure;GARE INTERIEURE; 29;01;FR;Gare frontière;GARE FRONTIERE; 29;05;FR;Bureau de ville;BUREAU DE VILLE; 29;06;FR;Organisme de voyage;ORGANISME DE VOYAGE; 29;09;FR;Autres établissements;AUTRES ETABLISSEMENTS; 29;00;DE;Binnenbahnhof;BINNENBAHNHOF; 29;01;DE;Grenzbahnhof;GRENZBAHNHOF; 29;05;DE;Stadtbüro;STADTBURO; 29;06;DE;Reiseunternehmen;REISEUNTERNEHMEN; 29;09;DE;Andere Dienststellen;ANDERE DIENSTSTELLEN; 29;00;EN;Inland station;INLAND STATION; 29;01;EN;Frontier station;FRONTIER STATION; 29;05;EN;Town office;TOWN OFFICE; 29;06;EN;Travel agency;TRAVEL AGENCY; 29;09;EN;Other stations;OTHER STATIONS;

44..1111 TTaabbllee TT__NNNN__PPAAYYSS__IIFF ((RReellaattiioonnsshhiipp bbeettwweeeenn ccoouunnttrryy aanndd rraaii llwwaayy))

Table used to associate a country and a railway company. Description of fields Size and

type of fields


Remarks

TYPE_LIGNE 2 N M 21



CODE_PAYS_ISO 2 AN M ISO country code 3166 CODE_IF 4 N M Railway code Examples: TYPE_LIGNE;CODE_PAYS_ISO;CODE_IF; 21;FR;87; 21;FI;10; 21;RU;20; 21;BY;21; 21;MK;65; 21;SI;79; 21;HR;78; 21;YU;72; 21;SK;56; 21;HU;55; 21;CZ;54;

55 FFii llee nnaammiinngg,, ff ii llee ttrraannssppoorrtt

55..11 FFii llee nnaammiinngg The file names received or send should respect the HOSA file name convention as follow: [{P/T}] [70] [nnnnn] T : Test P : Production 70 : Application Number nnnnn : Incremental counter. Example : P7020123 then P7020124 then P7020125, etc… The value of the incremental counter in the file name shall be identical at « MessageID » contain in the XML file.

55..22 FFii llee ttrraannssppoorrtt To exchange file it can be by: • The HOSA VPN; • Normal IP FTP. A user name and a password will be given by the UIC system administrator to the railway organization, who will allow him to put his XML file on a UIC system folder. On the other hand a specific folder will be needed on the railway organization system that will permit UIC to put his XML files. Different folder can be used for the different XML file that UIC has to send (Initialisation Delivery, Ack, Update Daily Report).



On the beginning of the exchange a period of test will be needed, UIC will realize the exchange of file on his development environment. When the test will reach satisfaction on both sides, UIC will migrate to his production environment.

AANNNNEEXX AA CCooddeess aanndd tteexxttss eerrrroorr ll iisstt This list can be updated according to the needs.

100 Tag not proper error (must be open and closed) 101 Missing MessageType error (Mandatory field) 102 Bad MessageType error (Expected = UPR, INR) 103 Missing Version error (Mandatory field) 104 Bad Version error (Expected = 1.01) 105 Missing From error (Mandatory field) 106 Bad From error (Expected = 4N) 107 Missing To error (Mandatory field) 108 Bad To error (Expected = 4N) 110 Missing MessageId error (Mandatory field) 111 Bad MessageId error (Expected = 5N) 112 Missing Timestamp error (Mandatory field) 113 Bad Timestamp error (Expected = YYYY-MM-DDTHH:MM:SS) 114 Bad Timestamp time separator error (Expected = YYYY-MM-DDTHH:MM:SS) 115 Bad RefToMessageId error (Expected = 5N) 201 Missing RailwayUndertakingIdentification error (Mandatory field) 202 Bad RailwayUndertakingIdentification error (Expected = valid 2N RU code) 203 Missing LocationCode error (Mandatory field) 204 Bad LocationCode error (Expected = 5N) 205 Missing Autocontrol error (Mandatory field) 206 Bad Autocontrol error (Expected = 1N) 207 Missing LocationName error (Mandatory field) 208 Bad LocationName error (Expected = 35AN) 209 Missing Country error (Mandatory field) 210 Bad Country error (Expected = 2AN) 211 Missing LocationCategoryCode error (Mandatory field) 212 Bad LocationCategoryCode error (Expected = 00, 01, 05, 06, 09) custumer 213 Bad Language error (Expected = 2AN) 214 Missing ValidityPeriod_From error (Mandatory field) 215 Bad ValidityPeriod_From error (Expected = CCYY-MM-SS) 216 Bad ValidityPeriod_To error (Expected = CCYY-MM-SS) 217 Bad ContainerHandling error (Expected = true, false) 218 Bad NUTS error (Expected = 4AN) 300 Missing RailwayUndertakingIdentification error (Mandatory field) 301 Bad RailwayUndertakingIdentification error (Expected = valid 4N RU code)



302 Missing LocationSortingPointCode error (Mandatory field) 303 Bad LocationSortingPointCode error (Expected = 5AN) 304 Bad PrincipalSortingPoint error (Expected = true, false) 305 Bad ValidityPeriod_From error (Expected = CCYY-MM-SS) 306 Bad ValidityPeriod_To error (Expected = CCYY-MM-SS) 400 Missing LocationFrontierPointCode error (Mandatory field) 401 Bad LocationFrontierPointCode error (Expected = 4N) 402 Bad ValidityPeriod_From error (Expected = CCYY-MM-SS) 403 Bad ValidityPeriod_To error (Expected = CCYY-MM-SS) 500 Missing SequenceNumber error (Mandatory field) 501 Bad SequenceNumber error (Expected = numeric) 502 Missing Language error (Mandatory field) 503 Bad Language error (Expected = 2AN) 504 Missing LocationName error (Mandatory field) 505 Bad LocationName error (Expected = 35AN) 600 Bad Gauge error (Expected = 0.760, 1.050, 1.435, 1.520, 1.524, 1.602, 1.668) 601 Bad BogieChange error (Expected = true, false) 602 Bad LocationIdentificationFreightName error (Expected = 250AN) 603 Bad LocationIdentificationPassengerName error (Expected = 250AN) 604 Missing Infrastructure error (Mandatory field) 605 Bad Infrastructure error (Expected = true, false) 606 Missing Passenger error (Mandatory field) 607 Bad Passenger error (Expected = true, false) 700 Bad From error (Expected = valid 4N RU code) 701 Bad To error (Expected = valid 4N RU code) 702 Bad To error. Recipient must be 3011 (Expected = 3011 in the communicationc flow: Railways to UIC) 703 MessageId exists already error (This MessageID exists already from the corresponding RU) 720 RailwayUndertakingIdentification not allowed error (Expected = RU code in MessageHeader's From) 721 Bad Autocontrol value error (Expected = Value calculated according to UIC leaflet 913) 722 LocationName not in upper case error 723 LocationName with special chars error 724 Bad Country error (Expected = ISO 3166-2) 725 Country not allowed error (Expected = Country code for MessageHeader's From) 726 Bad Language error (Expected = ISO 3166-2) 727 Warning: closure of a location which is open for CIM/DIUM purposes. 728 ValidityPeriod_To before ValidityPeriod_From error 740 RailwayUndertakingIdentification not allowed error (Expected = RU code in MessageHeader's From) 741 Warning: LocationSortingPointCode does not exist (Does not exist in T_LOTISSEMENT. It will be created automatically by the application.)



742 ValidityPeriod_To before ValidityPeriod_From error 760 LocationFrontierPoint Code does not exist error (Does not exist in T_PT_FRONTIERE. Please apply for it by the 920-2 border point administrator.) 761 ValidityPeriod_To before ValidityPeriod_From error 780 Bad Language error (Expected = ISO 3166-2) 781 LocationName not in upper case error 782 LocationName with special chars error 800 LocationIdentificationFreightName not in upper case error 801 LocationIdentificationFreightName with special chars error 802 LocationIdentificationPassengerName not in upper case error 803 LocationIdentificationPassengerName with special chars error

AANNNNEEXX BB XXMMLL sscchheemmaa XML schema for the Update Request, Update Daily Report and the Initialization Delivery. <xs:element name="LocationList"> <xs:complexType> <xs:sequence> <xs:element ref="MessageHeader"/> <xs:element name="Location" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="LocationGeneralInformation"> <xs:complexType> <xs:sequence> <xs:element ref="RailwayUndertakingIdentification"/> <xs:element ref="LocationCode"/> <xs:element ref="Autocontrol"/> <xs:element ref="LocationName"/> <xs:element ref="Country"/> <xs:element ref="LocationCategoryCode"/> <xs:element ref="Language" minOccurs="0"/> <xs:element ref="ValidityPeriod" minOccurs="0"/> <xs:element ref="ContainerHandling" minOccurs="0"/> <xs:element ref="NUTS" minOccurs="0"/> <xs:element ref="FreeText" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="LocationSortingPointList" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element ref="RailwayUndertakingIdentification"/> <xs:element ref="LocationSortingPointCode"/> <xs:element ref="PrincipalSortingPoint" minOccurs="0"/> <xs:element ref="ValidityPeriod" minOccurs="0"/> <xs:element ref="FreeText" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="LocationFrontierPointList" minOccurs="0" maxOccurs="2"> <xs:complexType> <xs:sequence>



<xs:element ref="LocationFrontierPointCode"/> <xs:element ref="ValidityPeriod" minOccurs="0"/> <xs:element ref="FreeText" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="LocationIdentificationNameTranslation" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element ref="SequenceNumber"/> <xs:element ref="Language"/> <xs:element ref="LocationName"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="LocationAdditionalInformation"> <xs:complexType> <xs:sequence> <xs:element ref="Gauge" minOccurs="0"/> <xs:element ref="BogieChange" minOccurs="0"/> <xs:element ref="LocationIdentificationFreightName" minOccurs="0"/> <xs:element ref="LocationIdentificationPassengerName" minOccurs="0"/> <xs:element ref="PropertyFootnoteCode" minOccurs="0"/> <xs:element ref="Infrastructure"/> <xs:element ref="Passenger"/> <xs:element ref="Freight"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="LocationPassengerInformation" minOccurs="0"> <xs:complexType> <xs:sequence> <xs:element ref="ValidityPeriod" minOccurs="0"/> <xs:element name="LocationPassengerName" minOccurs="0"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:minLength value="0"/> <xs:maxLength value="17"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element ref="PassengerLocationTariffZone" minOccurs="0"/> <xs:element name="PassengerLocationSeatReservationCode" type="Code" minOccurs="0"/> <xs:element ref="OriginDestination" minOccurs="0"/> <xs:element ref="TariffZone" minOccurs="0"/> <xs:element ref="SalesPoint" minOccurs="0"/> <xs:element ref="CrossingPoint" minOccurs="0"/> <xs:element ref="MeritsTimetable" minOccurs="0"/> <xs:element ref="TCV" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element>

AANNNNEEXX CC XXMMLL sscchheemmaa XML schema for the Ack message.

<?xml version="1.0" encoding="UTF-8"?>   <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"> <xs:include schemaLocation="catalogue.xsd"/> <xs:element name="LocationListAck"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element ref="MessageHeader"/> <xs:choice minOccurs="0" maxOccurs="unbounded"> <xs:element ref="ApplicationErrorDescription"/> <xs:element ref="TechnicalErrorDescription"/> </xs:choice> <xs:element ref="Accepted"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="TechnicalErrorDescription" type="SchemaError"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> </xs:element> <xs:element name="ApplicationErrorDescription" type="ApplicationError"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> </xs:element> <xs:complexType name="SchemaError"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> <xs:sequence> <xs:element ref="LocationCode"/> <xs:element name="TechnicalErrorConditionCode"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:minLength value="3"/> <xs:maxLength value="3"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element name="FreeFormDescription" minOccurs="0"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:minLength value="1"/> <xs:maxLength value="150"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element name="CopyOfBadDataElement" minOccurs="0"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:minLength value="0"/> <xs:maxLength value="150"/> </xs:restriction> </xs:simpleType> </xs:element> </xs:sequence> </xs:complexType>



<xs:complexType name="ApplicationError"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> <xs:sequence> <xs:element ref="LocationCode"/> <xs:element name="ApplicationErrorConditionCode"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:minLength value="3"/> <xs:maxLength value="3"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element name="FreeFormDescription" minOccurs="0"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:minLength value="1"/> <xs:maxLength value="150"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element name="CopyOfBadDataElement" minOccurs="0"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> <xs:simpleType> <xs:restriction base="xs:string"> <xs:minLength value="1"/> <xs:maxLength value="150"/> </xs:restriction> </xs:simpleType> </xs:element> </xs:sequence> </xs:complexType> <xs:element name="Accepted" type="xs:boolean"> <xs:annotation> <xs:documentation>ENEE, April 2004</xs:documentation> </xs:annotation> </xs:element> </xs:schema>

*************************************

enee xml message exchange - uic · pdf file3 xlm messages description 3.1 xml update request...

Documents