Specifikace exportního formátu CSV

Forma přenosu dat

Soubor data.csv, který obsahuje textové informace o inzerátech (viz. níže) a fotografie jsou v ZIP archivu odeslány na sjednanou FTP adresu do přiděleného adresáře. Fotografie jsou formátu jpg, gif, nebo png s maximální velikostí 200kB.

Ukázková data a soubory s číselníky

Ukázkový soubor data.csv naleznete zde
Číselníky, které jsou popsané v následujících odstavcích:
sections.cfg
values.cfg
attrs.cfg

Struktura data.csv

Soubor je v text/plain formátu, s koncem radku CR,LF nebo jen LF. Obsahuje hlavičku a dále data jednotlivých inzerátu ve formátu csv. Jako oddelovač je použit znak '|'.

Hlavička

Má následující strukturu:

#win nebo #iso druh kodování následujícího textu (windows1250 nebo iso-8859-2)
#format: attrname1|attrname2| ... | attrnameN pořadí attributů v datech inzerátu

Pokud je uvedena operace "zrušení", je povinná pouze položka clientID.

Data jednotlivých inzerátu

inzerat1_attr1|inzerat1_attr2|...|inzerat1_attrN
inzerat2_attr1|inzerat2_attr2|...|inzerat2_attrN
...
inzeratM_attr1|inzeratM_attr2|...|inzeratN_attrN

Attributy inzerátu

Záznam inzerátu obsahuje povinné pevné, povinné měnitelné a nepovinné attributy.

Povinné pevné attributy

op ............... id operace
1 - přidání nového inzerátu
2 - změna stávajícího inzerátu
3 - zrušení stávajícího inzerátu

clientID ........ id inzerátu na straně klienta
čiselná hodnota unikátní pro každý inzerát

Attributes ..... speciální vlastnosti inzerátu (jedná se o bitové pole)
0 - klasicky
1 - Top5
2 - Nabídka na HP
3 - Top5 + Nabídka na HP
8 - Exkluzivní
9 - Top5 + Exkluzivní
10 - Nabídka na HP + Exkluzivní
11 - Top5 + Nabídka na HP + Exkluzivní

Section ........ id sekce
id je z číselníku, který je v souboru sections.cfg

Title ............ titulek
max 100 znaků

Expire .......... datum vypršení platnosti inzerátu
ve formátu yyyymmdd

URL ............. url inzerátu
max 200 znaků

Description ... Popis inzerátu

Povinné měnitelné attributy

Seznam a popis těchto attributů se nachází v konfiguračním souboru attrs.cfg. Měnitelnost těchto attributů spočívá v tvom, že inzeráty v různých sekcich můžou obsahovat různou podmnožinu těchto attributů. Které attributy daná sekce obsahuje se nachází v konfiguracnim souboru sections.cfg.

Nepovinné attributy

Makléři

Jedná se o attributy Makler_Jmeno, Makler_Telefon a Makler_Email.

Fotografie

Jedná se o attributy Photo0 az Photo4, představující fotografie inzerátu. Počet fotografií není pevne stanoven a zalezi na výčtu daném parametrem #format v hlavičce souboru. Hodnota těchto attributů ma strukturu: attributes,title,filename.
attributes ... speciální vlastnosti obrázku (0 - normálni, 1 - virtual tour)
title ........... titulek obrázku (řetězcová hodnota v uvozovkách)
filename ..... jméno souboru obrázku, odpovída jménu v ZIP archivu

sections.cfg

Obsahuje v csv formátu seznam sekcí a povinných měnitelných attributů k nim. A to v následujícím tvaru:
id_sekce|jmeno_section|attr1_id|attr2_id|...|attrN_id

attrs.cfg

Obsahuje v csv formátu seznam attributů, jejich typy, případné hodnoty z čísleníku, který je dodán v konfiguračním souboru values.cfg. Format je následující:
id_attributu|jmeno_attributu|typ_attributu|val1_id|val2_id|...|valN_id

Typ attributu může nabývat následujících hodnot:
1 ... attribut je číslo a jeho hodnota je vybírána z číselníku hodnot (values.cfg). Attribut obsahuje id hodnoty.
2 ... attribut je řetězec a jeho hodnota je vybírána z čísleníku hodnot (values.cfg). Atrribut obsahuje id hodnoty.
3 ... attribut je číslo vložené uzivatelem.
4 ... attribut je řetězec vložený uzivatelem.

Pokud je attribut typu 3 nebo 4 neni uveden výčet hodnot val1_id az valN_id.

vals.cfg

Obsahuje v csv formátu číselník hodnot attributů v následujícím formátu: id_hodnoty|jmeno_hodnoty.