Εγχειρίδιο προγραμματιστή



Το εγχειρίδιο προγραμματιστή περιγράφει τους διαδικτυακούς πόρους τους οποίους μπορεί να χρησιμοποιήσει κάποιος για να αξιοποιήσει τις υπηρεσίες διαλειτουργικότητας που προσφέρει η υπηρεσία +κατοικώ. Παρέχεται διεπαφή για XML, JSON και JSONP.

 

 

Επιστροφή λίστας σπιτιών

 

url

https://roommates.teiath.gr/webservice/houses

method

GET

request body

OXI

παράμετροι

ΝΑΙ

αυθεντικοποίηση

ΟΧΙ

 

Όλες οι παράμετροι είναι προαιρετικές. Χρησιμοποιούνται για να περιοριστούν τα αποτελέσματα. Αν δεν συμπεριληφθεί καμία στο URL τότε επιστρέφονται όλα τα σπίτια.

 

Παράμετρος

Έγκυρη τιμή

Περιγραφή

max_price

ακέραιες τιμές

μέγιστη τιμή ενοικίου

(σε ευρώ)

min_area

ακέραιες τιμές

εμβαδόν (σε τετραγωνικά μέτρα) από – μέχρι

max_area

ακέραιες τιμές

municipality

μια έγκυρη τιμή από την λίστα των δήμων (βλέπε παράρτημα A)

Δήμος

furnitured

0

επιπλωμένο

1

2

accessibility

0

παρέχονται διευκολύνσεις για ΑΜΕΑ

1

has_photo

0

Το σπίτι περιέχει φωτογραφία (ες)

1

house_type

studio

τύπος σπιτιού

γκαρσονιέρα

διαμέρισμα

μονοκατοικία

μεζονέτα

heating_type

κεντρική

τύπος θέρμανσης

αυτόνομη

δεν διαθέτει

bedroom_num_min

ακέραιες τιμές

ελάχιστος αριθμός υπνοδωματίων

bathroom_num_min

ακέραιες τιμές

ελάχιστος αριθμός μπάνιων

construction_year_min

χρονολογία της μορφής “YYYY”

ελάχιστο έτος κατασκευής

floor_min

υπόγειο

ελάχιστος όροφος

ημιυπόγειο

υπερυψωμένο

ισόγειο

ημιόροφος

1ος

2ος

3ος

4ος

5ος

6ος

7ος

8+

rent_period_min

ακέραιες τιμές

ελάχιστη περίοδος ενοικίασης

(σε μήνες)

solar_heater

0

ηλιακός θερμοσίφωνας

1

aircondition

0

κλιματισμός

1

garden

0

κήπος

1

parking

0

parking

1

shared_pay

0

κοινόχρηστα

1

security_doors

0

πόρτες ασφαλείς

1

storeroom

0

αποθήκη

1

available_from[day]

ημερομηνία της μορφής “DD”

ημερομηνία διαθεσιμότητας

available_from[month]

ημερομηνία της μορφής “MM”

available_from[year]

ημερομηνία της μορφής “YYYY”

 

 

Επιστροφή συγκεκριμένου σπιτιού

 

url

https://roommates.teiath.gr/webservice/house/<id>

method

GET

request body

OXI

παράμετροι

ΟΧΙ

αυθεντικοποίηση

ΟΧΙ

 

 

Προσθήκη σπιτιού

 

url

https://roommates.teiath.gr/webservice/house

method

POST

request body

NAI

παράμετροι

ΟΧΙ

αυθεντικοποίηση

NAI

 

 

 

 

 

Η προσθήκη σπιτιού γίνεται με ένα XML request της παρακάτω μορφής:




<?xml version="1.0" encoding="utf-8" ?>
<house xmlns="http://www.roommates.teiath.gr/schemas/house">
    <address>foo bar</address>
    <postal_code>12345</postal_code>
    <area >345</area>
    <bedroom_num>3</bedroom_num>
    <bathroom_num>1</bathroom_num>
    <price>350</price>
    <construction_year>1990</construction_year>
    <solar_heater>0</solar_heater>
    <furnitured>0</furnitured>
    <aircondition>1</aircondition>
    <garden>0</garden>
    <parking>0</parking>
    <shared_pay>1</shared_pay>
    <security_doors>0</security_doors>
    <disability_facilities>0</disability_facilities>
    <storeroom>0</storeroom>
    <availability_date><![CDATA[2012-1-3]]></availability_date>
    <rent_period>12</rent_period>
    <description />
    <currently_hosting>1</currently_hosting>
    <total_places>2</total_places>
    <user_id>2</user_id>
    <visible >1</visible>
    <latitude>37.9865711339956</latitude>
    <longitude>23.6764577301635</longitude>
    <geo_distance >341.31</geo_distance>
    <free_places >1</free_places>
    <municipality>
        <name></name>
    </municipality>
    <floor>
        <type></type>
    </floor>
    <house_type>
        <type >studio</type>
    </house_type>
    <heating_type >
        <type></type>
    </heating_type>
    <image></image>
</house>

ή με την χρήση json request της παρακάτω μορφής:


        {u'house':
           {'address': 'foo bar',
            'aircondition': '1',
            'area': '345',
            'availability_date': '2012-10-10',
            'bathroom_num': '1',
            'bedroom_num': '3',
            'construction_year': '1990',
            'created': '',
            'currently_hosting': '1',
            'description': None,
            'disability_facilities': '0',
            'floor': {'type': "1ος όροφος"},
            'free_places': '1',
            'furnitured': '0',
            'garden': '0',
            'geo_distance': '341.31',
            'heating_type': {'type': "αυτόνομη"},
            'house_type': {'type': 'studio'},
            'id': '1',
            'image': None,
            'latitude': '37.9865711339956',
            'longitude': '23.6764577301635',
            'modified': '2012-1-3T23:21:31',
            'municipality': {'name': "ΑΘΗΝΑΙΩΝ"},
            'parking': '1',
            'postal_code': '12345',
            'price': '350',
            'rent_period': '12',
            'security_doors': '0',
            'shared_pay': '1',
            'solar_heater': '0',
            'storeroom': '1',
            'total_places': '3',
            'user_id': '2',
            'visible': '1'}
        }

 

 

 

Αλλαγή ενός σπιτιού

 

url

https://roommates.teiath.gr/webservice/house/<id>

method

PUT

request body

ΝΑΙ

παράμετροι

ΟΧΙ

αυθεντικοποίηση

NAI

 

To XML request είναι της ίδιας μορφής που απαιτεί το POST method. Πρέπει να συμπληρώνονται και τα πεδία τα οποία δεν είναι επιθυμητό να μεταβληθούν.

 

 

Διαγραφή ενός σπιτιού

 

url

https://roommates.teiath.gr/webservice/house/<id>

method

DELETE

request body

ΟΧΙ

παράμετροι

ΟΧΙ

αυθεντικοποίηση

NAI

 

Επιστροφή λίστας χρηστών

 

 

url

https://roommates.teiath.gr/webservice/users

method

GET

request body

OXI

παράμετροι

NAI

αυθεντικοποίηση

NAI

Παράμετροι οι οποίες χρησιμοποιούνται για τον περιορισμό των αποτελεσμάτων του αιτήματος.

 

Παράμετρος

Έγκυρη τιμή

Περιγραφή

firstname

χαρακτήρες

όνομα

lastname

χαρακτήρες

επίθετο

email

διεύθυνση email

email

phone

αριθμητικό

τηλέφωνο

gender

male

φύλο

female

dob

ημερομηνία της μορφής “YYYY”

ημερομηνία γέννησης

smoker

0

καπνιστής

1

pet

0

Έχει κατοικίδιο

1

child

0

Έχει παιδί

1

couple

0

είναι ζευγάρι

1

we_are

αριθμητικό

Πόσοι ψάχνουν σπίτι

max_roommates

αριθμητικό

Μέγιστος επιθυμητός αριθμός συγκατοίκων

 

 

Συμπληρωματικά, οι παρακάτω παράμετροι αφορούν real estate και ιδιώτες.

 

Παράμετρος

Έγκυρη τιμή

Περιγραφή

afm

αριθμητικό

ΑΦΜ

doy

χαρακτήρες

ΔΟΥ

address

αλφαριθμητικό

διεύθυνση

postal_code

αριθμητικό

Ταχυδρομικός κώδικας

municipality

μια έγκυρη τιμή από την λίστα των δήμων (βλέπε παράρτημα A)

Δήμος

 

 

Επιστροφή ενός συγκεκριμένου χρήστη

 

url

https://roommates.teiath.gr/webservice/user/<id>

method

GET

request body

OXI

παράμετροι

OXI

αυθεντικοποίηση

NAI

House XSD

User XSD

ΠΑΡΑΡΤΗΜΑ

 

ΚΑΛΛΙΚΡΑΤΙΚΟΙ ΔΗΜΟΙ

ΑΓΙΑΣ ΒΑΡΒΑΡΑΣ

ΑΓΙΑΣ ΠΑΡΑΣΚΕΥΗΣ

ΑΓΙΟΥ ΔΗΜΗΤΡΙΟΥ

ΑΓΙΩΝ ΑΝΑΡΓΥΡΩΝ - ΚΑΜΑΤΕΡΟΥ

ΑΓΚΙΣΤΡΙΟΥ

ΑΘΗΝΑΙΩΝ

ΑΙΓΑΛΕΩ

ΑΙΓΙΝΑΣ

ΑΛΙΜΟΥ

ΑΜΑΡΟΥΣΙΟΥ

ΑΣΠΡΟΠΥΡΓΟΥ

ΑΧΑΡΝΩΝ

ΒΑΡΗΣ - ΒΟΥΛΑΣ - ΒΟΥΛΙΑΓΜΕΝΗΣ

ΒΡΙΛΗΣΣΙΩΝ

ΒΥΡΩΝΟΣ

ΓΑΛΑΤΣΙΟΥ

ΓΛΥΦΑΔΑΣ

ΔΑΦΝΗΣ - ΥΜΗΤΤΟΥ

ΔΙΟΝΥΣΟΥ

ΕΛΕΥΣΙΝΑΣ

ΕΛΛΗΝΙΚΟΥ - ΑΡΓΥΡΟΥΠΟΛΗΣ

ΖΩΓΡΑΦΟΥ

ΗΛΙΟΥΠΟΛΕΩΣ

ΗΡΑΚΛΕΙΟΥ

ΙΛΙΟΥ (ΝΕΩΝ ΛΙΟΣΙΩΝ)

ΚΑΙΣΑΡΙΑΝΗΣ

ΚΑΛΛΙΘΕΑΣ

ΚΕΡΑΤΣΙΝΙΟΥ - ΔΡΑΠΕΤΣΩΝΑΣ

ΚΗΦΙΣΙΑΣ

ΚΟΡΥΔΑΛΛΟΥ

ΚΡΩΠΙΑΣ

ΚΥΘΗΡΩΝ

 

ΛΑΥΡΕΩΤΙΚΗΣ

ΛΥΚΟΒΡΥΣΗΣ - ΠΕΥΚΗΣ

ΜΑΝΔΡΑΣ - ΕΙΔΥΛΛΙΑΣ

ΜΑΡΑΘΩΝΟΣ

ΜΑΡΚΟΠΟΥΛΟΥ ΜΕΣΟΓΑΙΑΣ

ΜΕΓΑΡΕΩΝ

ΜΕΤΑΜΟΡΦΩΣΕΩΣ

ΜΟΣΧΑΤΟΥ - ΤΑΥΡΟΥ

ΝΕΑΣ ΙΩΝΙΑΣ

ΝΕΑΣ ΣΜΥΡΝΗΣ

ΝΙΚΑΙΑΣ - ΑΓΙΟΥ ΙΩΑΝΝΗ ΡΕΝΤΗ

ΠΑΙΑΝΙΑΣ

ΠΑΛΑΙΟΥ ΦΑΛΗΡΟΥ

ΠΑΛΛΗΝΗΣ

ΠΑΠΑΓΟΥ - ΧΟΛΑΡΓΟΥ

ΠΕΙΡΑΙΩΣ

ΠΕΝΤΕΛΗΣ

ΠΕΡΑΜΑΤΟΣ

ΠΕΡΙΣΤΕΡΙΟΥ

ΠΕΤΡΟΥΠΟΛΕΩΣ

ΠΟΡΟΥ

ΡΑΦΗΝΑΣ - ΠΙΚΕΡΜΙΟΥ

ΣΑΛΑΜΙΝΑΣ

ΣΑΡΩΝΙΚΟΥ

ΣΠΑΤΩΝ - ΑΡΤΕΜΙΔΟΣ

ΣΠΕΤΣΩΝ

ΤΡΟΙΖΗΝΙΑΣ

ΥΔΡΑΣ

ΦΙΛΑΔΕΛΦΕΙΑΣ - ΧΑΛΚΗΔΟΝΟΣ

ΦΙΛΟΘΕΗΣ - ΨΥΧΙΚΟΥ

ΦΥΛΗΣ

ΧΑΙΔΑΡΙΟΥ

ΧΑΛΑΝΔΡΙΟΥ

ΩΡΩΠΟΥ