ToobaXML System ToobaXML służy wymianie danych o projektach z serwisem za pomocą plików XML.

Transkrypt

1 Spis treści ToobaXML1 Plik XML1 Tag Projekt3 Tag KosztyBudowy..5 Tag Koszt5 Tag Zdjecia..6 Tag Zdj.6 Tag Rzuty..6 Tag Rzut.6 Tag Pomieszczenia.6 Tag Pom7 Tag Elewacje7 Tag Elewacja7 Tag Kosztorysy..8 Tag Kosztorys..8 Tag KosztorysPoz8 Tag Zalaczniki.8 Tag Zalacznik8 Przykłady.9 Przykład definiowania kosztorysu.9 Opis typów danych..10 Changelog ToobaXML System ToobaXML służy wymianie danych o projektach z serwisem za pomocą plików XML. Plik XML <ToobaXML version=1.01> <projekt> <!-- parametry projektu --> <Id>${STRING}</Id> <Data>{DATA}</Data> <Rodzaj>${INTEGER}</Rodzaj> <Cena>${DOUBLE}</Cena> <PowUzytkowa>${DOUBLE}</PowUzytkowa> <PowUzytkowaOpis>${STRING}</PowUzytkowaOpis> <PowZabudowy>${DOUBLE}</PowZabudowy> <RodzajDachu>${INTEGER}</RodzajDachu> <KatDachu1>${DOUBLE}</KatDachu1> <KatDachu2>${DOUBLE}</KatDachu2> <KatDachu3>${DOUBLE}</KatDachu3> <PowDachu>${DOUBLE}</PowDachu> <Wysokosc>${DOUBLE}</Wysokosc> strona 1/11

2 <Garaz>${INTEGER}</Garaz> <DzialkaMinDlugosc>${DOUBLE}</DzialkaMinDlugosc> <DzialkaMinSzerokosc>${DOUBLE}</DzialkaMinSzerokosc> <Kondygnacje>${STRING}</Kondygnacje> <Poddasze>${INTEGER}</Poddasze> <PoddaszeNazwa>${STRING}</PoddaszeNazwa> <Zabudowa>${INTEGER}</Zabudowa> <ZabudowaNazwa>${STRING}</ZabudowaNazwa> <Piwnica>${INTEGER}</Piwnica> <Styl>${INTEGER}</Styl> <Technologia>${INTEGER}</Technologia> <IloscPokoi>${INTEGER}</IloscPokoi> <IloscLazienek>${INTEGER}</IloscLazienek> <Kominek>${BOOLEAN}</Kominek> <Kubatura>${DOUBLE}</Kubatura> <Biznes>${BOOLEAN}</Biznes> <Dwurodzinny>${INTEGER}</Dwurodzinny> <Energooszczedny>${INTEGER}</Energooszczedny> <NaStok>${BOOLEAN}</NaStok> <OdPoludnia>${BOOLEAN}</OdPoludnia> <Opis>${STRING}</Opis> <TechnologiaOpis>${STRING}</TechnologiaOpis> <!-- informacje na temat kosztów budowy --> <KosztyBudowy> <Uwagi>${STRING}</Uwagi> <Koszt> <Miesiac>${INTEGER}</Miesiac> <Rok>${INTEGER}</Rok> <Etap>${INTEGER}</Etap> <System>${INTEGER}</System> <Uwagi>${STRING}</Uwagi> </KosztyBudowy> <!-- lista zdj ęć projektu --> <Zdjecia> <Zdj> <Url>${STRING}</Url> <Glowne>${BOOLEAN}</Glowne> </Zdj> </Zdjecia> <!-- lista rzutów zdefiniowanych w ramach projektu --> <Rzuty> <Rzut> <Rodzaj>${STRING}</Rodzaj> <Url>${STRING}</Url> <Opis>${STRING}</Opis> <!-- lista pomieszcze ń występujących w danym rzucie --> <Pomieszczenia> <Pom> <Numer>${STRING}</Numer> strona 2/11

3 <Pow>${DOUBLE}</Pow> <PowPodlogi>${DOUBLE}</PowPodlogi> </Pom> <Pomieszczenia> </Rzuty> ToobaXML (v1.08) <!-- lista elewacji występujących w danym rzucie --> <Elewacje> <Elewacja> <Rodzaj>${INTEGER}</Rodzaj> <Url>${STRING}</Url> </Elewacja> </Elewacje> <Zalaczniki> <Zal> <Url>${STRING}</Url> <Opis>${STRING}</Opis> <Rodzaj>${INTEGER}</Rodzaj> <RodzajNazwa>${STRING}</RodzajNazwa> </Zal> <Zalaczniki> </Projekt> </ToobaXML> Opis tagów i ich parametrów Tag Projekt Nazwa Wyma gane Id Klucz identyfikujący projekt w ramach jednej pracowni. Url Adres URL do widoku projektu na stronie Partnera. Data Data modyfikacji/dodania projektu. Rodzaj Rodzaj projektu. Możliwe wartości: 1 projekt domu 2 projekt garażu 3 projekt domku letniskowego 4 projekt szamba 5 projekt rezydencji Cena Nazwa PowUzytkowa PowUzytkowaOpis nie Opis dodatkowy do powierzchni uzytkowej (np. z garażem, bez garażu ) PowZabudowy RodzajDachu Możliwe wartości: 1 dwuspadowy 2 czterospadowy strona 3/11

4 Nazwa Wyma gane 3 wielospadowy 4 jednospadowy 5 płaski KatDachu1 Kąt nachylenia dachu1. KatDachu2 nie Kąt nachylenia dachu2. KatDachu3 nie Kąt nachylenia dachu3. PowDachu nie Powierzchnia dachu. Wysokosc Wysokość budynku. Garaz Możliwe wartości: 1 brak garażu 2 garaż jednostanowiskowy 3 garaż dwustanowiskowy 4 garaż trzystanowiskowy lub więcej 5 wiata garażowa 99 inna DzialkaMinDlugosc DzialkaMinSzerokosc Kondygnacje Możliwe wartości: 1 parterowy 2 piętrowy Poddasze Możliwe wartości: 1 brak poddasza 2 poddasze użytkowe 3 poddasze do adaptacji 99 inna wartość PoddaszeNazwa nie Nazwa poddasza pole wypełniane (i wymagane) tylko w przypadku, gdy w polu Poddasze występuje wartość 99. Zabudowa Możliwe wartości: 1 wolnostojący 2 szeregowy 3 bliźniaczy 99 inna wartość ZabudowaNazwa nie Nazwa zabudowy pole wypełniane (i wymagane) tylko w przypadku, gdy w polu Zabudowa występuje wartość 99. Piwnica Pole typu integer. Definicja piwnicy w domu. Możliwe wartości: 0 brak piwnicy 1 dom podpiwniczony 2 dom częściowo podpiwniczony W przypadku braku tego typu danych w bazie danych biura projektowego, tag należy pominąć. Styl nie Możliwe wartości: 1 tradycyjny 2 nowoczesny 3 górski 4 dworek 99 inna wartość Technologia Możliwe wartości: 1 murowany strona 4/11

5 IloscPokoi Nazwa IloscLazienek Kominek Kubatura Wyma gane nie nie nie nie 3 drewniany-bale 4 drewniany-szkieletowa Tag technologia może występować kilkukrotnie. Na przykład, jeżeli dom można wybudować zarówno w technologii z bali jak i szkieletowej, wówczas należy użyć tag technologia dwukrotnie. Biznes nie Pole typu boolean. Wartość true oznacza, że projekt przystosowany jest do prowadzenia firmy. W przypadku braku tego typu danych w bazie danych biura projektowego, tag należy pominąć. Dwurodzinny nie Pole typu boolean. Wartość true oznacza, że dom przewidziany jest dla dwóch rodzin. Synonim domu dwupokoleniowego, dwulokalowego. W przypadku braku tego typu danych w bazie danych biura projektowego, tag należy pominąć. Energooszczedny nie Pole typu integer. Możliwe wartości: 1 zwykły dom, brak energooszczędności 2 dom energooszczędny 3 dom pasywny W przypadku braku tego typu danych w bazie danych biura projektowego, tag należy pominąć. NaStok nie Pole typu boolean. W przypadku braku tego typu danych w bazie danych biura projektowego, tag należy pominąć. OdPoludnia nie Pole typu boolean. Wartość true oznacza, że dom posiada wejście od południa. Wartość false definiuje, że dom nie posiada wejścia od południa. W przypadku braku tego typu danych w bazie danych biura projektowego, tag należy pominąć. Opis TechnologiaOpis nie KosztyBudowy nie Tag grupujący tagi definiujące koszty budowy. Zdjecia Tag grupujący tagi definiujące zdjęcia. Rzuty Tag grupujący tagi definiujące rzuty. Elewacje Tak grupujący tagi definiujące elewacje. Kosztorys nie Tag grupujący tagi definiujące kosztorys. Zalaczniki nie Tag grupujące tagi definiujące poliki załączone. Tag KosztyBudowy Grupuje definicje kosztów budowy. Nazwa obowiązkowy Opis Uwagi nie Pole zawierające ogólne uwagi do wszystkich zdefiniowanych kosztów. Koszt Tag definiujący koszt budowy. Można zdefiniować dowolną liczbę kosztów budowy (w zależności od tego, czy podawany koszt strona 5/11

6 uje budowę systemem gospodarczym, czy zleconym, albo czy dotyczy stanu surowego zamkniętego, czy innego etapu budowy). Szczegółowy tego taga znajduje się tu: Tag Koszt. Tag Koszt Nazwa obowiązkowy Opis Miesiac Miesiąc, w którym liczony był koszt. Rok Rok, w którym liczony był koszt. Etap Określa etap budowy, którego dotyczy definiowany koszt. Możliwe wartości: surowy zamknięty wykończenie pod klucz System Możliwe wartości: gospodarczy zlecony Uwagi nie Uwagi do kosztu. Tag Zdjecia Tag grupujący definicję zdjęć danego projektu. Nie posiada żadnych atrybutów. Wewnątrz taga mogą występować tylko tagi Zdj. Tag Zdj Opisuje jedno zdjęcie projektu. Nazwa obowiązkowy Opis Nazwa nie Nazwa zdjęcia, np. widok od strony ogrodu. Url Adres URL pod którym znajduje się obrazek do zdjęcia. Glowne Flaga informuje, czy zdjęcie jest zdjęciem głównym projektu. Zdjęcie główne projektu wyświetlane jest jako pierwsze podczas prezentowania projektu. Tag Rzuty Grupuje rzuty danego projektu. Nie posiada żadnych atrybutów. Wewnątrz taga mogą występować tylko tagi Rzut. Dany projekt może mieć zdefiniowaną dowolną liczbę rzutów. Tag Rzut nazwa obowiązkowy Rodzaj Możliwe wartości: 1 rzut parteru 2 rzut piętra 3 rzut poddasza 4 rzut piwnicy 5 przekrój 6 sytuacja 99 - inna Nazwa nie Pole wypełniane w przypadku, gdy rodzaj=99. Url Adres URL do obrazka zawierającego rzut. strona 6/11

7 Opis nazwa obowiązkowy Opis rzutu. W miarę możliwości szczegółówy pomieszczeń należy umieszczać przy wykorzystaniu tagów Pomieszczenia i Pom. Tag Pomieszczenia Grupuje pomieszczenia danego projektu. Nie posiada żadnych atrybutów. Wewnątrz taga mogą występować tylko tagi Pom.. Wewnątrz tagu Rzut może występować tylko jeden tag Pomieszczenia. Wewnąrz tagu Pomieszczenia może występować dowolna liczba tagów Pom.. Pomieszczenia sortowane są według kolejności występowania. Przykład: <Pomieszczenia> <Pom> <Nazwa>Wiatrołap</Nazwa> <Numer>1</Numer> <Pow>5.1</Pow> <PowPodlogi/> </Pom> <Pom> <Nazwa>Łazienka + CO</Nazwa> <Numer>2</Numer> <Pow>4.4</Pow> <PowPodlogi/> </Pom> <Pom> <Nazwa>Hol</Nazwa> <Numer>3</Numer> <Pow>7.5</Pow> <PowPodlogi/> </Pom> [] </Pomieszczenia> Tag Pom nazwa obowiązkowy Nazwa Nazwa pomieszczenia. Numer nie Uwaga: Pomieszczenia są sortowane według numeru podczas prezentowania w serwisie. Pow Powierzchnia pomieszczenia. PowPodlogi nie Powierzchnia pomieszczenia po podłodze. Pole należy wypełniać przy definiowaniu pomieszczeń ze skosami. Tag Elewacje Grupuje elewacje danego projektu. Nie posiada żadnych atrybutów. Wewnątrz taga mogą występować tylko tagi Elewacja.. Dany projekt może mieć zdefiniowaną dowolną liczbę elewacji. Tag Elewacja strona 7/11

8 nazwa obowiązkowy Rodzaj Możliwe wartości: 1 elewacja przednia 2 elewacja tylna 3 elewacja lewa 4 elewacja prawa 5 elewacja boczna 99 inna wartość Nazwa nie Nazwa elewacji jeżeli rodzaj=99. Url Adres url do pliku graficznego z elewacją. Tag Kosztorysy Tag grupujący wszystkie zdefiniowane kosztorysy. Jeden projekt może posiadać tylko jeden tag kosztorysy. Wewnątrz tego taga znajduje się dowolna ilość tagów kosztorys. Zobacz Przykład definiowania kosztorysu. Tag Kosztorys nazwa wyma gany Nazwa Pole tekstowe zawierające nazwę kosztorysu. Np. Koszt budowy. Data Data wykonania kosztorysu. Forma daty Opis typów danych. Cena Łączna wartość danego kosztorysu. Pole liczbowe typu 'double'. nettobrutto Czy podana cena jest ceną netto, czy brutto. Możliwe wartości: netto brutto Uwagi nie Pole tekstowe. Zawiera uwagi do definiowanego kosztorysu. Tag KosztorysPoz Definiuje pozycję kosztorysu. nazwa wyma gany Nazwa Pole tekstowe zawierające nazwę pozycji kosztorysu. Np. stan surowy otwarty. Cena Wartość danej pozycji kosztorysu. Pole liczbowe typu 'double'. Rodzaj ceny (netto/brutto) definiowany jest w nadrzędnym tagu kosztorys. Wyrozniona nie Czy pozycja kosztorysu ma być wyróżniona. Wyróżnienie stosuje się do oznaczenia podsum poszczególnych pozycji. Tag Zalaczniki Grupuje pliki załączone do projektu. Tag Zalacznik Definiuje jeden plik załączony do projektu. nazwa wyma gany Nazwa Nazwa załączanego dokumentu. Jest to nazwa wyświetlana na stronie. Nie strona 8/11

9 nazwa wyma gany powinna być to nazwa pliku. Przykład: obrys w skali 1:500. Url Adres url do załączanego pliku. Opis nie Opis załączanego pliku. Rodzaj Rodzaj załączanego pliku. Możliwe wartości: 1 kosztorys 2 zestawienie materiałowe 3 rzut szczegółowy 99 inny RodzajNazwa nie Pole wypełniane w przypadku gdy rodzaj został ustawiony na 99. Przykłady Przykład definiowania kosztorysu Opis robót Stan surowy ,03 Roboty ziemne i fundamentowe 62638,80 Konstrukcja parteru ze stropem 54117,69 Stal zbrojeniowa dla całego budynku 23433,63 Konstrukcja poddasza 21543,34 Konstrukcja i pokrycie dachów 98817,92 Stolarka okienna i drzwiowa na ścianach osłonowych 20959,34 Elewacja i roboty zewnętrzne 43102,14 Tarasy na gruncie 21609,16 Wykończenie 92694,26 Oblicowania ścian i sufitów 48987,15 Podłogi i posadzki 35837,60 Stolarka wewnętrzna 7869,51 Definicja XML <Kosztorysy> <Kosztorys> <Nazwa> robót</nazwa> <Data> </Data> <Cena>438916,29</Cena> <NettoBrutto>netto</NettoBrutto> <!-- pierwsza wyrózniona pozycja kosztorysu --> <KosztorysPoz> <Nazwa>Stan surowy</nazwa> <Cena>346222,03</Cena> <Wyrozniona></Wyrozniona> </KosztorysPoz> <!-- druga zwykła pozycja kosztorysu --> Łącznie ,29 strona 9/11

10 <KosztorysPoz> <Nazwa>Roboty ziemne i fundamentowe</nazwa> <Cena>62638,80</Cena> <Wyrozniona>nie</Wyrozniona> </KosztorysPoz> </Kosztorys> </Kosztorysy> Opis typów danych Oznaczenie ${STRING} ${INTEGER} ${DOUBLE} ${BOOLEAN} ${DATE} Changelog Łańcuch. Format danych Liczba całkowita. Nie może zawierać znaków innych niż cyfry (w szczególności spacji, kropek, przecinków). Liczba rzeczywista. Składa się z cyfr, kropki lub przecinka. Część ułamkowa może być odzielona od części całkowitej kropką lub przecinkiem. Wartość logiczna. Możliwe wartości: true/1 false/0 Określenie daty w jednym z następujących formatów: RRRRMMDD RRRR-MM-DD 1.01 dodany rodzaj projektu: 5 rezydencja 1.02 dodana własność RodzajDachu w projekcie 1.03 dodana własność PoddaszeNazwa w projekcie dodana własność ZabudowaNazwa w projekcie Zmiana typu numeru pomieszczenia z liczbowego na łańcuchowy (tag Numer wewnątrz taga Pom) Uszczegółowiony i dodany przykład dla tagu Pomieszczenia i Pom 1.04 Dodana własność Url w projekcie strona 10/11

11 Technologia drewniany zastąpiona dwiema bardziej szczegółowymi technologiami: drewniany-bale i drewniany-szkieletowa dodana możliwość definiowania kosztorysu dodana możliwość definiowania plików załączonych dodany tag energooszczedny dodany tag biznes 1.06 Usunięty tag Podobne z tagu Projekt 1.07 Dodany tag KosztyBudowy do tagu Projekt Zmiana typu danych w tagu Energooszczedny z tagu Projekt 1.08 Dodana własność Dwurdzinny do projektu Dodana własność NaStok do projektu Dodana własność OdPoludnia do projektu Zmiana w typie danych w tagu Piwnica projektu(był typ boolean, teraz jest typ integer, możliwe jest zdefiniowanie częściowego podpiwniczenia) strona 11/11