POI import format

Use of the POI import format

Frequently, partners and customers provide us with POI information to import in the RouteYou databases and environment. The POI import format describes the fields (name, mandatory or not, their meaning).

Physical format

• Please use UTF8 encoding (if not, inform us which encoding you use)
• CSV (flat table)
• XML
• If you have another format, contact us

Fields

We defined a flat-table structure and also created fields from that point of view. In a hierarchical XML-structure, it could be done in a more efficient way. In the flat structure, each record contains all the fields (but they could be empty).

Mandatory fields

This is the minimum we need.

1. location_id_customer: ID (can be set of chars) given by the customer to identify a location. If possible, use rather location_location_id_rty (see further)
2. location_coord_x: X-coord (pref. should be longitude in decimal WGS-84 coordinates)
3. location_coord_y: Y-coord (pref. should be latitude in decimal WGS-84 coordinates)
4. location_type_name_customer: Type of location described by its name (pref a name of the referene list of RouteYou (see Location type list). Subtypes should be translated to a new type (e.g. Church-Cathedral, use language as indicated by field 'language'). If a type does not exist in the RouteYou Location Type List, please indicate and check if if could be mapped to an existing Location Type.
5. text: Txt description of the location (editorial)

Optional fields

Meta info

6. language: 2 CHAR ISO language code, identifying the used language for the relevant attributes in this record. In case two descriptions are available in a different language, a new record has to be used (most used codes : EN, NL, FR)
7. owner_id_customer: Id or code described by the customer who owns the text information
8. owner_id_rty: Id or code described by the customer who owns the text information, but the user_id as known/registered on RouteYou
9. owner_displayname: Display name of owner (how should owner appear when mentioned on RouteYou or in web services)
10. owner_email: Email of the owner (used by RouteYou, because this is how the user/owner is identified)

Location info

11. location_action: Options
12. DELETE=indicates that the complete location_object (including its entity and its attributes) shoud be deleted. The location is identified by an ID or by the attributes. This actions will be rarely carried out on the core database, only if the location is an orphan-location) CREATE=indicates that the location_ and it's attributes are created and that the location did not exist before (or was not delivered before) EDIT=indicates that the location exists already (was delivered before) but that the attributes should be changed)
13. location_id_rty: ID given by RouteYou to identify a location
14. location_coord_system_name: Description of the coordinate system which is used WGS84 (Pref. WGS84), LambertBEL72, Rijksdriekhoek ,….
15. location_coord_system_id_rty: RouteYou id describing the coordinate systems: 1=WGS84, 2=NLD_Rijksdriehoek, 3=BEL_Lambert_72 (Ask for the official list by RouteYou,….)
16. location_name_rty: Name of the location, as given by RouteYou
17. location_display_name: Name used for Display purposes of the location
18. location_address: Use this only in case the address is not available as individual address components, this field can be used to store a complete address string. Preferable, the address is structured as [Streetname],[Hsnr],[ZIP],[Municipality],[State (if used)],[Country]. Please, make rather use of the structured, individual address fields, rather than this address string.
19. location_address_street: streetname of the addres
20. location_address_hsnr: hsnr of the addres
21. location_address_postbox: postbox of the addres (if available)
22. location_address_zip: zip code (postal code) of the address
23. location_address_sub_municipality: sub_municipality (village) of the address (if existing)
24. location_address_municipality: municipality of the address
25. location_address_state: if relevant, state (of country is spli tin states, e.g. US) of the address
26. location_address_country: country of the address (pref. Full name)
27. location_type_name_rty: Type of location described by its as used by RouteYou (use language as indicated by field 'language')
28. location_type_displayname_customer: Name (short) to be displayed when this type is used
29. location_type_id_customer: ID or code used by customer to indicate the type
30. location_type_id_rty: ID or code used by RouteYou to indicate the type

Text (description) info

30. text_action: Options
31. DELETE=indicates that the object with the given ID or identified on base of its attrubutes, has to be removed CREATE=indicates that the object and it's attribus are created and that the object did not exist before (or was not delivered before) EDIT=indicates that the object exists already (was delivered before) but that the attributes should be changed)
32. text_id_customer: ID (can be set of chars) given by the customer to identify a text
33. text_id_rty: ID given by RouteYou to identify a text
34. text_type_id_customer: ID or code indication of type of text (default it is assumed that this is a standard editorial text, but it could also be introduction, summary, ….)
35. text_type_id_rty: ID used by RouteYou to indicate type of text
36. text_source_name: Description of source of the text information
37. text_source_url: URL indicating where the text is taken from.
38. text_source_id_customer: ID used by the customer to indicate the source
39. text_source_id_rty: ID used by RouteYou to indicate the source
40. text_copyright_id_customer: Code or number given by customer to indicate copyright
41. text_copyright_id_rty: Code or number given by RouteYou to indicate copyright
42. text_copyright_name: Name (short) to be displayed when this type of copyright is used
43. text_copyright_url: Url linking to the description of the copyright
44. text_bc_min_radius: Min distance from which there is no 'BroadCasting' anymore of this information Unit (m) (default: 0 m). If value > 0, the BroadCasting area is a doughnut.
45. text_bc_max_radius: Max distance from which there is no 'BroadCasting' anymore of this information Unit (m) (default: 100 m)
46. text_bc_left_bearing: If the heading direction of the receiver is locationnting right of the left_bearing and left of the right_bearing, the information should be displayed.
47. text_bc_right_bearing: If the heading direction of the receiver is locationnting right of the left_bearing and left of the right_bearing, the information should be displayed.
48. text_info_url: Extra url to get more info about the described item (in general, the source_url will be used for that)

Media info

• media_action: Options
• DELETE=indicates that the object with the given ID or identified on base of its attrubutes, has to be removed CREATE=indicates that the object and it's attribus are created and that the object did not exist before (or was not delivered before) EDIT=indicates that the object exists already (was delivered before) but that the attributes should be changed)
• media_id_customer: ID (can be set of chars) given by the customer to identify a media
• media_id_rty: ID given by RouteYou to identify a media
• media_type_id_customer: Id or code given by the customer to indicate type of media
• media_type_id_rty: Id or code given by rty to indicate type of media (1=picture, 2=video, 3=sound)
• media_filename: Filename of the picture, video... (in case delivered via e.g. DVD)
• media_description: Description used to display as extra information about the media (e.g. positioned below the media or as mouse over, or to select in list)
• media_source_name: Description of source of the media information
• media_source_url:URL indicating where the info is taken from.
• media_source_id_customer: Copyright code of picture used by the provider
• media_source_id_rty: Copyright code of picture used by RouteYou
• media_source_caption: Caption to be shown when picture is shown (very short descrption)
• media_copyright_id_customer: Code or number given by customer to indicate type of copyright
• media_copyright_id_rty: Code or number given by RouteYou to indicate type of copyright
• media_copyright_name: Name (short) to be displayed when this type of copyright is used
• media_copyright_url: Url linking to the description of this type of copyright

Styling

• icon_theme: color used for the type icon. (Possibilities: 'gray', 'red', 'orange', 'yellow', 'green', 'cyan', 'blue', 'purple', 'magenta', 'pink')

Meta information about your data

Please provide a translation list between the POI_types you use and the types used by RouteYou. Here is the list of RouteYou.

Alternatives

Using your Web services to import the POIs

RouteYou can also import POIs from web services that you provide. Please inform us about the following:

• How do we detect the type of POI
• Please provide us with a translation table between your types and the RouteYou types
• How do we detect if a POI should be removed?

Back to RouteYou