Régiók listázása

Megjegyzés

A régiók alatt településeket értünk, amiket megadhatunk több entitásnál felvételkor és módosításkor.

Ezzel a paranccsal egy listát kapunk a lehetséges településekről és azok városrészeiről.

HTTP kérés

GET /region

Példa

GET /region?part=region,areas&created_after=2009-03-05T12:23:01&updated_after=2009-03-05T12:23:01

Kötelező mező	Leírás
`part`	`string` A válaszban megjelenítendő elemek, vesszővel elválasztva. - `"id"`: Azonosítás - `"region"`: Régió adatok - `"areas.id"`: Városrészek azonosítása - `"areas.area"`: Városrész adatok
Opcionális mező	Leírás
`id`	`uint(20)` A régió Ingatlanok.hu rendszerbeli azonosítója. Több is megadható, vesszővel elválasztva.
`created_after`	`datetime` Szűrés a megadottnál később felvett régiókra.
`updated_after`	`datetime` Szűrés a megadottnál később módosított régiókra.

Tartalom

A kérésnek nincs tartalmi része.

Válasz

Minden listaelem két részből tevődik össze:

Az Általános részben taglalt mezőkből.
Az areas blokkban vannak a Városrészek részben taglalt elemek.

Megjegyzés

Hiba esetén a lehetséges válaszok megtalálhatók a Hibák oldalon.

Általános

Példa

HTTP 200 OK

[
    {
        "id": {
            "id": 3269
        },
        "region": {
            "id": 3269,
            "name": "Budapest I. ker",
            "latitude": 47.4967,
            "longitude": 19.038,
            "zip_codes": [8609]
        }
        "areas": [
            {
                "id": {
                    "id": 2
                },
                "area": {
                    "id": 2,
                    "name": "Gellérthegy"
                }
            }
        ]
    }
]

Mező	Leírás
`id`	(A `part=id` esetén) Azonosítás.
`id.id`	`uint(20)` A régió Ingatlanok.hu rendszerbeli azonosítója.
`region`	(A `part=region` esetén) Régió adatok.
`region.id`	`uint(20)` A régió Ingatlanok.hu rendszerbeli azonosítója.
`region.name`	`string(255)` A régió neve.
`region.latitude`	`double` A régió földrajzi szélessége.
`region.longitude`	`double` A régió földrajzi hosszúsága.
`region.zip_codes`	`string` A régióhoz tartozó irányítószámok tömbben.

Városrészek

Megjegyzés

Az itt feltüntetett adatok az Általános részben taglalt JSON areas mezőjébe kerülnek part=areas.* esetén.

Mező	Leírás
`id`	(A `part=areas.id` esetén) A régióhoz tartozó városrészek azonosítói.
`id.id`	`uint(20)` Az városrész Ingatlanok.hu rendszerbeli azonosítója.
`area`	(A `part=areas.area` esetén) A régióhoz tartozó városrészek adatai.
`area.id`	`uint(20)` Az városrész Ingatlanok.hu rendszerbeli azonosítója.
`areas.name`	`string(255)` A városrész neve.