mirror of
https://github.com/valitydev/damsel.git
synced 2024-11-07 02:05:18 +00:00
60 lines
2.3 KiB
Thrift
60 lines
2.3 KiB
Thrift
include "base.thrift"
|
||
include "domain.thrift"
|
||
|
||
namespace java com.rbkmoney.damsel.geo_ip
|
||
namespace erlang geo_ip
|
||
|
||
/**
|
||
* Идентификатор места по базе http://www.geonames.org/
|
||
**/
|
||
typedef i32 GeoID
|
||
|
||
struct LocationInfo {
|
||
// GeoID города
|
||
1: required GeoID city_geo_id;
|
||
// GeoID страны
|
||
2: required GeoID country_geo_id;
|
||
// Полное описание локации в json
|
||
// подробное описание на сайте https://www.maxmind.com/en/geoip2-city
|
||
3: required string raw_response;
|
||
}
|
||
// Информация о регоине
|
||
struct SubdivisionInfo{
|
||
// глубина в иерархии. Чем ниже тем цифра выше. Например 1 - Московская область. 2 - Подольский район.
|
||
1: required i16 level
|
||
2: optional string subdivision_name;
|
||
}
|
||
|
||
// Информация о данном GeoID
|
||
struct GeoIDInfo{
|
||
1: required GeoID geoname_id;
|
||
2: string country_name;
|
||
3: set<SubdivisionInfo> subdivisions;
|
||
4: optional string city_name;
|
||
}
|
||
|
||
|
||
/** Исключение, сигнализирующее о том, что невозможно определить местоположение по IP */
|
||
exception CantDetermineLocation {
|
||
}
|
||
/** Исключение, сигнализирующее о том, что в базе нет описания для одного из указанных GeoID */
|
||
exception LocationNotFound {
|
||
// список идентификаторов данных о которых нет в базе
|
||
1: list<GeoID> geo_ids
|
||
}
|
||
|
||
/**
|
||
* Интерфейс Geo Service для клиентов - "Columbus"
|
||
*/
|
||
service GeoIpService {
|
||
/**
|
||
* Возвращает информацию о предполагаемом местоположении по IP
|
||
**/
|
||
LocationInfo GetLocation (1: domain.IPAddress ip) throws (1: CantDetermineLocation ex1)
|
||
/**
|
||
* Возвращает текстовое описание места на указанном языке
|
||
* GeoIDs - список geo-id по которым нужно получить информацию.
|
||
* lang - язык ответа. Например: "RU", "ENG"
|
||
**/
|
||
map <GeoID, GeoIDInfo> GetLocationInfo (1: set<GeoID> geo_ids, 2: string lang) throws (1: LocationNotFound ex1)
|
||
} |