4. GetArrivalDistricts

Last modified by Giorgi Mdivnishvili on 2024/04/10 03:34

Contents

Method Description

Method Description

This method returns data about arrival districts.
To call the method, the country code must be passed as a parameter in the header and then a list of arrival cities and districts of the chosen country will be returned with all the necessary data.

EndpointURL - [GET]

https://integration.kazunion.com/api/Catalogue/GetArrivalDistricts

Request Parameters

Key	Value	Request URL
CountryCode	KZ	https://integration.kazunion.com/api/Catalogue/GetArrivalDistricts?countryCode=KZ

Request Body

none

Response Body

[
  {
   "type": "string",
   "parent": "string",
   "label": "string",
   "value": "string",
   "tag": "string"
  }
]

example

{
       "type": "city",
       "label": "Aktau",
       "value": "8aa860fd-1899-4253-ad52-0700c5339d70",
       "tag": "Aktau"
    },
    {
       "type": "district",
       "parent": "8aa860fd-1899-4253-ad52-0700c5339d70",
       "label": "Aktau Airport",
       "value": "9e24902a-65ec-41b8-b736-a7e50631ee13",
       "tag": "Aktau Airport Aktau"
    },
    {
       "type": "district",
       "parent": "8aa860fd-1899-4253-ad52-0700c5339d70",
       "label": "Mangghystau",
       "value": "1644b5e1-7dea-4e3b-b2e6-854eb50f2c97",
       "tag": "Mangghystau Aktau"
    },
    {
       "type": "district",
       "parent": "8aa860fd-1899-4253-ad52-0700c5339d70",
       "label": "Microdistrict 9",
       "value": "dcedd4b5-1044-410e-b8ad-f8f9ba443593",
       "tag": "Microdistrict 9 Aktau"
    },
    {
       "type": "city",
       "label": "Aktobe",
       "value": "2e460569-3f8c-48df-a287-03f3d5a94eb4",
       "tag": "Aktobe"
    },

Schema

[TreeNode{

type	string nullable: true
parent	string nullable: true
label	string nullable: true
subLabel	string nullable: true
value	string nullable: true
tag	string nullable: true

}]

Definitions

Each object in the response represents a geographical entity and contains the following fields:

- `type`: (string) The type of the geographical entity. This can be "city" or "district".

- `label`: (string) The name of the geographical entity.

- `value`: (string) The unique identifier for the geographical entity.

- `tag`: (string) A tag for the geographical entity. This typically contains the name of the entity and, for districts, the name of the parent city.

For objects where `type` is "district", there is an additional field:

- `parent`: (string) The unique identifier for the parent city of the district.