documentation
Xorijiy shaharlar

Xorijiy shaharlar

GET /v1/directory/country-cities?countryId=<countryId>

Ushbu bo‘lim orqali tizimdagi xorijiy shaharlar ro‘yxati olinadi.

So‘rov yuborilganda tizim mavjud barcha xorijiy shaharlar bo‘yicha ma’lumotlarni qaytaradi. Ushbu ma’lumotlar buyurtma yaratish, manzil tanlash va logistika hisob-kitoblarida foydalaniladi.

Har bir shahar uchun uning identifikatori, nomi, tegishli davlat identifikatori va boshqa zarur kodlar qaytarilishi mumkin.

Bu endpoint faqat ma’lumot olish uchun mo‘ljallangan va tizimdagi hech qanday ma’lumotni o‘zgartirmaydi.

API Server https://apitest.bts.uz:28345/
Base Path /v1/directory/country-cities?countryId=<countryId>
Full URL
https://apitest.bts.uz:28345/v1/directory/country-cities?countryId=<countryId>
Authentication Bearer Token
Headers
Header
Value
Req.
Authorization
Bearer {access_token}
🔒
Content-Type
application/json
🔒
Accept
application/json
🔒
language
uz
🔒

REQUEST

Field Type Description
countryCode * string Mamlakat kodi. Katalogdagi «Davlatlar» dagi code
page integer Sahifa raqami. Default: 1
per-page integer Sahifadagi elementlar soni (max 1000, default 20)

RESPONSE

HTTP 200
Response Body
{
    "status": true,
    "message": "Ma’lumot muvaffaqiyatli olindi.",
    "status_code": 200,
    "data": {
        "items": [
            {
                "code": "006023",
                "countryCode": "006",
                "name": "Буэнос-Айрес"
            },
            {
                "code": "006012",
                "countryCode": "006",
                "name": "Жужуй"
            },
            {
                "code": "006014",
                "countryCode": "006",
                "name": "Катамарка"
            },
            {
                "code": "006009",
                "countryCode": "006",
                "name": "Кордова"
            },
            {
                "code": "006005",
                "countryCode": "006",
                "name": "Корриентес"
            },
            {
                "code": "006022",
                "countryCode": "006",
                "name": "Ла-Пампа"
            },
            {
                "code": "006020",
                "countryCode": "006",
                "name": "Ла-Риоха"
            },
            {
                "code": "006013",
                "countryCode": "006",
                "name": "Мендоса"
            },
            {
                "code": "006011",
                "countryCode": "006",
                "name": "Мисьонес"
            },
            {
                "code": "006015",
                "countryCode": "006",
                "name": "Неукен"
            },
            {
                "code": "006017",
                "countryCode": "006",
                "name": "Огненная Земля"
            },
            {
                "code": "006006",
                "countryCode": "006",
                "name": "Рио-Негро"
            },
            {
                "code": "006010",
                "countryCode": "006",
                "name": "Сальта"
            },
            {
                "code": "006003",
                "countryCode": "006",
                "name": "Сан-Луис"
            },
            {
                "code": "006016",
                "countryCode": "006",
                "name": "Санта-Круз "
            },
            {
                "code": "006008",
                "countryCode": "006",
                "name": "Санта-Фе"
            },
            {
                "code": "006002",
                "countryCode": "006",
                "name": "Сантьяго-дель-Эстеро"
            },
            {
                "code": "006001",
                "countryCode": "006",
                "name": "Сан-Хуан"
            },
            {
                "code": "006004",
                "countryCode": "006",
                "name": "Тукуман"
            },
            {
                "code": "006019",
                "countryCode": "006",
                "name": "Формоса"
            }
        ],
        "_links": {
            "self": "/v1/directory/country-cities/006?page=1",
            "first": "/v1/directory/country-cities/006?page=1",
            "last": "/v1/directory/country-cities/006?page=2",
            "next": "/v1/directory/country-cities/006?page=2",
            "prev": null
        },
        "_meta": {
            "totalCount": 23,
            "pageCount": 2,
            "currentPage": 1,
            "perPage": 20,
            "params": {
                "countryCode": "006"
            }
        }
    }
}
Field Type Description
status boolean So'rov muvaffaqiyatli bajarilganligi (true/false)
message string Javob xabari
status_code integer HTTP status kodi
data[items] array<object> Xorijiy shaharlar ro‘yxati (Katalog → «Xorijiy shaharlar»)
data[items][0][code] string Shahar kodi. Katalogdagi «Xorijiy shaharlar» dagi code (receiver.cityCode)
data[items][0][countryCode] string Tegishli mamlakat kodi. Katalogdagi «Davlatlar»
data[items][0][name] string Shahar nomi (lokalizatsiya)
data[_links] object Pagination havolalari (self, next, last, …)
data[_meta][totalCount] integer Jami elementlar soni
data[_meta][pageCount] integer Jami sahifalar soni
data[_meta][currentPage] integer Joriy sahifa raqami
data[_meta][perPage] integer Sahifadagi elementlar soni