{ "openapi": "3.0.1", "info": { "title": "api/dictionaries/geo", "version": "1.0.0" }, "servers": [ { "url": "/" }, { "url": "https://api.ati.su" } ], "security": [ { "BearerAuth": [] } ], "paths": { "/gw/gis-dict/v1/cities/by-ids": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/cities/by-ids": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/cities/by-coordinate": { "post": { "tags": [ "Cities" ], "summary": "Получение населённого пункта по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/cities/by-coordinate": { "post": { "tags": [ "Cities" ], "summary": "Получение населённого пункта по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/cities/by-fias-ids": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов ФИАС", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/cities/by-fias-ids": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов ФИАС", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/cities/by-kladr-codes": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов КЛАДР", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/cities/by-kladr-codes": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов КЛАДР", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/city-types": { "get": { "tags": [ "CityTypes" ], "summary": "Получение всех типов населённых пунктов", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/oauth2/gis-dict/v1/city-types": { "get": { "tags": [ "CityTypes" ], "summary": "Получение всех типов населённых пунктов", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/gis-dict/v1/districts/by-ids": { "post": { "tags": [ "Districts" ], "summary": "Получение районов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/districts/by-ids": { "post": { "tags": [ "Districts" ], "summary": "Получение районов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/federal-districts": { "get": { "tags": [ "FederalDistricts" ], "summary": "Получение всех федеральных округов", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/oauth2/gis-dict/v1/federal-districts": { "get": { "tags": [ "FederalDistricts" ], "summary": "Получение всех федеральных округов", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/gis-dict/v1/regions/by-ids": { "post": { "tags": [ "Regions" ], "summary": "Получение регионов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/regions/by-ids": { "post": { "tags": [ "Regions" ], "summary": "Получение регионов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/regions/by-coordinate": { "post": { "tags": [ "Regions" ], "summary": "Получение региона по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/regions/by-coordinate": { "post": { "tags": [ "Regions" ], "summary": "Получение региона по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/regions/by-fias-ids": { "post": { "tags": [ "Regions" ], "summary": "Получение регионов по списку идентификаторов ФИАС", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/regions/by-fias-ids": { "post": { "tags": [ "Regions" ], "summary": "Получение регионов по списку идентификаторов ФИАС", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } } } } } } }, "/gw/gis-dict/v1/countries/by-ids": { "post": { "tags": [ "Countries" ], "summary": "Получение стран по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/countries/by-ids": { "post": { "tags": [ "Countries" ], "summary": "Получение стран по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/countries/by-coordinate": { "post": { "tags": [ "Countries" ], "summary": "Получение страны по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/countries/by-coordinate": { "post": { "tags": [ "Countries" ], "summary": "Получение страны по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/directions": { "get": { "tags": [ "Directions" ], "summary": "Получение всех направлений", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/oauth2/gis-dict/v1/directions": { "get": { "tags": [ "Directions" ], "summary": "Получение всех направлений", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/gis-dict/v1/direction/from/{from}/to/{to}": { "get": { "tags": [ "Directions" ], "summary": "Получение направления между городами", "parameters": [ { "name": "from", "in": "path", "description": "Код ATI.SU для населённого пункта \"откуда\"", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "to", "in": "path", "description": "Код ATI.SU для населённого пункта \"куда\"", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/direction/from/{from}/to/{to}": { "get": { "tags": [ "Directions" ], "summary": "Получение направления между городами", "parameters": [ { "name": "from", "in": "path", "description": "Код ATI.SU для населённого пункта \"откуда\"", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "to", "in": "path", "description": "Код ATI.SU для населённого пункта \"куда\"", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } } } } } } }, "/v1.0/dictionaries/streetTypes": { "get": { "tags": [ "Справочники" ], "summary": "Получение списка типов улиц", "operationId": "Dictionaries_StreetTypesAll", "responses": { "200": { "description": "Типы улиц", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StreetType" } } } } } } } }, "/gw/gis-dict/v1/autocomplete/suggestions": { "post": { "tags": [ "AutoComplete" ], "summary": "Автокомплит до населённого пункта", "requestBody": { "description": "GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/autocomplete/suggestions": { "post": { "tags": [ "AutoComplete" ], "summary": "Автокомплит до населённого пункта", "requestBody": { "description": "GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/direct-geocoding": { "post": { "tags": [ "GeoCoding" ], "summary": "Получение координаты гео-объекта по адресной строке (платный)", "requestBody": { "content": { "application/json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } }, "text/json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } }, "application/*+json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/direct-geocoding": { "post": { "tags": [ "GeoCoding" ], "summary": "Получение координаты гео-объекта по адресной строке (платный)", "requestBody": { "content": { "application/json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } }, "text/json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } }, "application/*+json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/reverse-geocoding": { "post": { "tags": [ "GeoCoding" ], "summary": "Получение адресной структуры гео-объекта по координате (платный)", "requestBody": { "content": { "application/json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } }, "text/json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } }, "application/*+json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/reverse-geocoding": { "post": { "tags": [ "GeoCoding" ], "summary": "Получение адресной структуры гео-объекта по координате (платный)", "requestBody": { "content": { "application/json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } }, "text/json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } }, "application/*+json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/v1.0/dictionaries/cities": { "get": { "tags": [ "Справочники" ], "summary": "Получение списка всех городов с возможностью поиска по префиксу имени, по id городов или только по названию города", "description": "* В случае, если указаны параметр name параметр ids, поиск городов будет произведен по параметру name, параметр ids учитываться не будет;\n* При отсутствии параметра includedFields, будут выданы все возможные поля;\n* При любом значении параметра includedFields будет возвращено поле CityId;\n* Если NameOnly=true, поиск только по названию города. Если NameOnly=false, поиск совпадений по всей строке fullName.", "operationId": "Dictionaries_CitiesAll", "parameters": [ { "name": "name", "in": "query", "description": "Слово для поиска", "schema": { "type": "string" }, "x-position": 1 }, { "name": "cityNameOnly", "in": "query", "description": "Поиск только по названию города", "schema": { "type": "boolean" }, "x-position": 2 } ], "responses": { "200": { "description": "Города", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/City" } } } } } } } }, "/v1.0/dictionaries/cities/byfias/{fias}": { "get": { "tags": [ "Справочники" ], "summary": "Получение конкретного города по его идентификатору в базе ФИАС", "operationId": "Dictionaries_Cities8", "parameters": [ { "name": "fias", "in": "path", "required": true, "description": "ID города в базе ФИАС", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Город", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/City" } } } }, "404": { "description": "Город не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfCityNotFoundException" } } } } } } }, "/v1.0/dictionaries/cities/{cityId}": { "get": { "tags": [ "Справочники" ], "summary": "Получение конкретного города по его идентификатору", "operationId": "Dictionaries_Cities4", "parameters": [ { "name": "cityId", "in": "path", "required": true, "description": "ID города", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "Город", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/City" } } } }, "404": { "description": "Город не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfCityNotFoundException" } } } } } } }, "/v1.0/dictionaries/regions": { "get": { "tags": [ "Справочники" ], "summary": "Получение списка регионов", "operationId": "Dictionaries_RegionsAll", "responses": { "200": { "description": "Регионы", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Region" } } } } } } } }, "/v1.0/dictionaries/locations/parse": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/PublicGeoParserResultView" }, "type": "object" } } }, "description": "Результат геокодирования", "x-nullable": false } }, "security": [ { "JWT": [] } ], "tags": [ "Работа с адресами" ], "description": "За один запрос можно передать не более 20 адресов, они должны быть уникальны в рамках запроса", "operationId": "Locations_ParseLocations", "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/PublicLocationsParseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublicLocationsParseDto" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PublicLocationsParseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicLocationsParseDto" } } }, "description": "Адреса, которые нужно обработать" }, "summary": "Получение города, соответствующего указанному адресу" } }, "/v1.0/dictionaries/cities/{cityId}/near": { "get": { "tags": [ "Справочники" ], "summary": "Получение списка ближайших городов по городу", "operationId": "Dictionaries_NearCitiesAll", "parameters": [ { "name": "cityId", "in": "path", "required": true, "description": "Идентификатор города", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "count", "in": "query", "description": "Количество БКГ", "schema": { "type": "integer", "format": "int32", "default": 5 }, "x-position": 2 }, { "name": "radius", "in": "query", "description": "Радиус в км", "schema": { "type": "integer", "format": "int32", "default": 200 }, "x-position": 3 }, { "name": "largeCityCount", "in": "query", "description": "Размер БКГ", "schema": { "type": "integer", "format": "int32", "default": 3 }, "x-position": 4 } ], "responses": { "200": { "description": "Города", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/City" } } } } }, "404": { "description": "Город не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfCityNotFoundException" } } } } } } } }, "components": { "schemas": { "GeoService.Dictionaries.Models.AutoComplete.CityGeoObject": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор географического объекта", "format": "int32" }, "name": { "type": "string", "description": "Название географического объекта" }, "short_name": { "type": "string", "description": "Короткое название географического объекта", "nullable": true }, "city_type": { "required": [ "city_type_id", "name", "short_name" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.CityType" } ], "description": "Тип нас. пункта", "nullable": true }, "old_name": { "type": "string", "description": "Старое название\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "alt_name": { "type": "string", "description": "Альтернативное название\r\n\nЗначение по умолчанию: `null`", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.AutoComplete.SimpleGeoObject": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор географического объекта", "format": "int32" }, "name": { "type": "string", "description": "Название географического объекта" }, "short_name": { "type": "string", "description": "Короткое название географического объекта", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.AutoComplete.SubdistrictGeoObject": { "type": "object", "properties": { "name": { "type": "string", "description": "Название части района" }, "short_name": { "type": "string", "description": "Короткое название части района" } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.AutoComplete.Suggestion": { "type": "object", "properties": { "type": { "enum": [ 1, 2, 4, 8 ], "type": "integer", "description": "Тип элемента для автокомплита. В запросе может быть маской, в ответе не может быть маской.\r\n\nЗначение по умолчанию: `1`

Members:

", "format": "int32" }, "direction": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SimpleGeoObject" } ], "description": "Направление\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "country": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SimpleGeoObject" } ], "description": "Страна\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "region": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SimpleGeoObject" } ], "description": "Регион\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "districts": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SimpleGeoObject" }, "description": "Районы\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "subdistrict": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SubdistrictGeoObject" } ], "description": "Часть района\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "city": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.CityGeoObject" } ], "description": "Населённый пункт\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "address": { "type": "string", "description": "Адрес" }, "geo_point": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoPointResponse" } ], "description": "Координаты объекта", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest": { "required": [ "prefix" ], "type": "object", "properties": { "prefix": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Поисковая строка", "example": "санкт" }, "suggestion_types": { "enum": [ 1, 2, 4, 8 ], "type": "integer", "description": "Тип элемента для автокомплита. В запросе может быть маской, в ответе не может быть маской.\r\n\nЗначение по умолчанию: `1`

Members:

", "format": "int32", "example": 15 }, "limit": { "maximum": 50, "minimum": 1, "type": "integer", "description": "Сколько элементов нужно вернуть пользователю\r\n\nЗначение по умолчанию: `10`", "format": "int32", "nullable": true, "example": 15 }, "country_id": { "type": "integer", "description": "Страна по умолчанию для сортировки объектов. Объекты из этой страны будут наверху списка.\r\n\nЕсли не передать или передать `null`, то для залогиненного пользователя настройка возьмется из кабинета.\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.Suggestion" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GeoCoding.BoundingBox": { "type": "object", "properties": { "sw": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoPointRequest" } ], "description": "Точка, обозначающая нижний левый угол области поиска." }, "ne": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoPointRequest" } ], "description": "Точка, обозначающая верхний правый угол области поиска." } }, "additionalProperties": false, "description": "Область поиска. Задается координатами нижнего левого угла и верхнего правого.\r\n\nЗначение по умолчанию: `null`" }, "GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest": { "required": [ "address", "max_level" ], "type": "object", "properties": { "address": { "maxLength": 1024, "minLength": 0, "type": "string", "description": "Адресная строка.", "example": "Россия, Ленинградская область, Гатчинский муниципальный округ, Вырица, Вокзальная улица, д. 23" }, "exact_in_bounding_box": { "type": "boolean", "description": "Флаг, указывающий, что искать объекты нужно строго в области, обозначенной в параметре bounding_box.\r\nДля true вне области не ищем. Для false приоритет для объектов внутри области.\r\nЕсли true, то обязательно передавать bounding_box.\n\r\nЗначение по умолчанию: `false`\n\r\n! Зарезервирован на будущее, сейчас не используется.", "nullable": true, "example": false }, "max_level": { "maximum": 5, "minimum": 1, "type": "integer", "description": "Максимальный уровень, до которого необходимо провести гео-кодирование.\r\n\n\r\nВозможные значения\r\n\n\r\n1 — страна\n\r\n2 — область/регион\n\r\n3 — населённый пункт\n\r\n4 — улица\n\r\n5 — дом\r\n", "format": "int32", "example": 3 }, "bounding_box": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.BoundingBox" } ], "description": "Область поиска. Задается координатами нижнего левого угла и верхнего правого.\n\r\nЗначение по умолчанию: `null`", "nullable": true }, "count": { "maximum": 10, "minimum": 1, "type": "integer", "description": "Ограничение количества элементов в выдаче.\n\r\nДиапазон значений от `1` до `10`.\n\r\nЗначение по умолчанию: `1`", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Запрос на гео-кодирование по адресной строке" }, "GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest": { "required": [ "location", "max_level" ], "type": "object", "properties": { "location": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoPointRequest" } ], "description": "Координаты точки, от которой необходимо провести обратное гео-кодирование." }, "max_level": { "type": "integer", "description": "Максимальный уровень, до которого необходимо провести гео-кодирование.\r\n\n\r\nВозможные значения\r\n\n\r\n1 — страна\n\r\n2 — область/регион\n\r\n3 — населённый пункт\n\r\n4 — улица\n\r\n5 — дом\r\n", "format": "int32", "nullable": true, "example": 3 }, "count": { "type": "integer", "description": "Ограничение количества элементов в выдаче.\n\r\nДиапазон значений от `1` до `10`.\n\r\nЗначение по умолчанию: `1`", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Модель, представляющая настройки обратного гео-кодирования" }, "GeoService.Dictionaries.Models.Requests.GeoPointRequest": { "required": [ "lat", "lon" ], "type": "object", "properties": { "lat": { "type": "number", "description": "Широта", "format": "double", "example": 59.93904 }, "lon": { "type": "number", "description": "Долгота", "format": "double", "example": 30.31581 } }, "additionalProperties": false, "description": "Координаты" }, "GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest": { "required": [ "fias_ids" ], "type": "object", "properties": { "fias_ids": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Список идентификаторов ФИАС населённых пунктов\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ "c2deb16a-0330-4f05-821f-1d09c93331e6", "0c5b2444-70a0-4932-980c-b4dc0d3f02b5" ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Список идентификаторов населённых пунктов (кодов ATI.SU)\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ 1, 3611 ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest": { "required": [ "kladr_codes" ], "type": "object", "properties": { "kladr_codes": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Список идентификаторов КЛАДР населённых пунктов\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ "7800000000000", "7700000000000" ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Список идентификаторов стран (кодов ATI.SU)\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ 1, 50 ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Список идентификаторов районов (кодов ATI.SU)\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ 8456, 8464, 6857 ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest": { "required": [ "fias_ids" ], "type": "object", "properties": { "fias_ids": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Список идентификаторов ФИАС регионов\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ "6d1ebb35-70c6-4129-bd55-da3969658f5d", "29251dcf-00a1-4e34-98d4-5c47484a36d4" ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Список идентификаторов регионов (кодов ATI.SU)", "example": [ 1, 680, 681 ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest": { "required": [ "location" ], "type": "object", "properties": { "location": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoPointRequest" } ], "description": "Координаты" } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.City": { "required": [ "city_id", "clarified_name", "country_id", "name", "size" ], "type": "object", "properties": { "city_id": { "type": "integer", "description": "Идентификатор населённого пункта", "format": "int32", "readOnly": true }, "country_id": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "federal_district_id": { "type": "integer", "description": "Идентификатор федерального округа\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "region_id": { "type": "integer", "description": "Идентификатор региона\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "district_ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Идентификаторы районов\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "name": { "type": "string", "description": "Название населённого пункта" }, "alt_name": { "type": "string", "description": "Альтернативное название населённого пункта\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "old_name": { "type": "string", "description": "Старое название населённого пункта\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "subdistrict": { "type": "string", "description": "Часть района\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "short_subdistrict": { "type": "string", "description": "Часть района с сокращениями типа\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "fias_id": { "type": "string", "description": "Идентификатор ФИАС\r\n\nЗначение по умолчанию: `null`", "format": "uuid", "nullable": true }, "kladr": { "type": "string", "description": "Идентификатор КЛАДР\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "okato": { "type": "string", "description": "Код ОКАТО\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "oktmo": { "type": "string", "description": "Код ОКТМО\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "is_regional_center": { "type": "boolean", "description": "Является ли населённый пункт региональным центром\r\n\nЗначение по умолчанию: `false`" }, "is_district_center": { "type": "boolean", "description": "Является ли населённый пункт районным центром\r\n\nЗначение по умолчанию: `false`" }, "size": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "Размер населённого пункта.

Members:

Members:

", "format": "int32" }, "geo_point": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoPointResponse" } ], "description": "Координаты\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "city_type_id": { "type": "integer", "description": "Идентификатор типа населённого пункта\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "timezone": { "type": "string", "description": "Часовой пояс в формате IANA.\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "clarified_name": { "type": "string", "description": "Название населённого пункта с уточнением типа и района при необходимости\r\nЕсли в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение" }, "legacy_attributes": { "type": "integer", "description": "Атрибуты устаревшей записи населённого пункта\r\n\nВозвращаются только для населенных пунктов, помеченных как `is_legacy=true`.\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "is_legacy": { "type": "boolean", "description": "Флаг, обозначающий, что объект является устаревшим\r\n\nЗначение по умолчанию: `false`" } }, "additionalProperties": false, "description": "Модель, описывающая сущность \"Населённый пункт\"" }, "GeoService.Dictionaries.Models.Responses.CityType": { "required": [ "city_type_id", "name", "short_name" ], "type": "object", "properties": { "city_type_id": { "type": "integer", "description": "Идентификатор типа населённого пункта", "format": "int32" }, "name": { "type": "string", "description": "Название типа" }, "short_name": { "type": "string", "description": "Сокращённое название типа" } }, "additionalProperties": false, "description": "Модель, описывающая сущность \"Тип населённого пункта\"" }, "GeoService.Dictionaries.Models.Responses.Country": { "required": [ "country_id", "iso_3166_alpha2", "iso_3166_alpha3", "iso_3166_numeric", "name" ], "type": "object", "properties": { "country_id": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "name": { "type": "string", "description": "Название страны" }, "iso_3166_alpha2": { "type": "string", "description": "Двухбуквенный код страны по ISO-3166" }, "iso_3166_alpha3": { "type": "string", "description": "Трехбуквенный код страны по ISO-3166" }, "iso_3166_numeric": { "type": "integer", "description": "Числовой код страны по ISO-3166", "format": "int32" }, "is_legacy": { "type": "boolean", "description": "Флаг, обозначающий, что объект является устаревшим.\r\n\nЗначение по умолчанию: `false`" } }, "additionalProperties": false, "description": "Модель, описывающая сущность \"Страна\"" }, "GeoService.Dictionaries.Models.Responses.Direction": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор направления", "format": "int32" }, "name": { "type": "string", "description": "Описание направления" } }, "additionalProperties": false, "description": "Направление \"Север\", \"Юг\" и т.д." }, "GeoService.Dictionaries.Models.Responses.DirectionResponse": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор направления. Может быть битовой маской", "format": "int32" }, "name": { "type": "string", "description": "Описание направления. Может быть перечислением направлений" } }, "additionalProperties": false, "description": "Направление \"Север\", \"Юг\" и т.д." }, "GeoService.Dictionaries.Models.Responses.District": { "required": [ "country_id", "district_id", "name", "short_name" ], "type": "object", "properties": { "district_id": { "type": "integer", "description": "Идентификатор района", "format": "int32" }, "country_id": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "federal_district_id": { "type": "integer", "description": "Идентификатор федерального округа\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "name": { "type": "string", "description": "Название района" }, "short_name": { "type": "string", "description": "Название района с сокращениями типа" }, "region_id": { "type": "integer", "description": "Идентификатор региона\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.FederalDistrict": { "required": [ "country_id", "federal_district_id", "name" ], "type": "object", "properties": { "federal_district_id": { "type": "integer", "description": "Идентификатор фед. округа", "format": "int32" }, "country_id": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "name": { "type": "string", "description": "Название федерального округа" }, "is_legacy": { "type": "boolean", "description": "Флаг, обозначающий, что объект является устаревшим.\r\n\nЗначение по умолчанию: `false`" } }, "additionalProperties": false, "description": "Модель, описывающая сущность \"Федеральный округ\"" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.AddressElement": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор географического объекта", "format": "int32" }, "name": { "type": "string", "description": "Название географического объекта" }, "short_name": { "type": "string", "description": "Короткое название географического объекта", "nullable": true } }, "additionalProperties": false, "description": "Идентификатор и название элемента адреса" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.CityElement": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор населённого пункта", "format": "int32" }, "name": { "type": "string", "description": "Название населённого пункта" }, "city_type": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.CityType" } ], "description": "Тип населённого пункта" } }, "additionalProperties": false, "description": "Название, идентификатор и тип населённого пункта населённого пункта" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.CityType": { "type": "object", "properties": { "city_type_id": { "type": "integer", "description": "Идентификатор типа населённого пункта", "format": "int32" }, "name": { "type": "string", "description": "Название типа населённого пункта" }, "short_name": { "type": "string", "description": "Короткое название типа населённого пункта" } }, "additionalProperties": false, "description": "Тип населённого пункта" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse": { "type": "object", "properties": { "max_count_exceeded": { "type": "boolean", "description": "Флаг, указывающий, что найдено больше результатов, чем просили в параметре count и требуется уточнение.\r\n\nЗначение по умолчанию: `false`" }, "uncertainty_score": { "type": "integer", "description": "Минимальная степень неуверенности в точности распознавания среди всех результатов.", "format": "int32" }, "uncertainty_reasons": { "type": "array", "items": { "type": "string" }, "description": "Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате" }, "suggestions": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingSuggestion" }, "description": "Распознанные адреса" } }, "additionalProperties": false, "description": "Результат гео-кодирования" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingSuggestion": { "required": [ "address", "level", "uncertainty_reasons", "uncertainty_score" ], "type": "object", "properties": { "uncertainty_score": { "type": "integer", "description": "Степень неуверенности в точности распознавания. Рассчитывается как сумма весов ошибок распознавания из поля uncertainty_reasons. 0 - абсолютно уверены.", "format": "int32" }, "uncertainty_reasons": { "type": "array", "items": { "type": "string" }, "description": "Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате." }, "address": { "type": "string", "description": "Адресная строка до уровня, до которого удалось распознать", "readOnly": true }, "level": { "type": "integer", "description": "Уровень, до которого удалось распознать\r\n\n\r\nВозможные значения\r\n\n\r\n1 — страна\n\r\n2 — область/регион\n\r\n3 — населённый пункт\n\r\n4 — улица\n\r\n5 — дом\r\n", "format": "int32" }, "country": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.AddressElement" } ], "description": "Название и идентификатор страны\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "region": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.AddressElement" } ], "description": "Название и идентификатор региона\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "districts": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.AddressElement" }, "description": "Районы\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "subdistrict": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.SubdistrictElement" } ], "description": "Часть района\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "city": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.CityElement" } ], "description": "Название, идентификатор и тип населённого пункта населённого пункта\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "geo_point": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoPointResponse" } ], "description": "Координаты объекта, который удалось распознать\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "name": { "type": "string", "description": "Название для именованных объектов (магазины, склады, месторождения и т.п.)\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "street": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.StreetElement" } ], "description": "Название и идентификатор улицы\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "house": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.AddressElement" } ], "description": "Номер и идентификатор дома/строения\r\n\nЗначение по умолчанию: `null`", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GeoCoding.StreetElement": { "type": "object", "properties": { "name": { "type": "string", "description": "Название улицы" }, "short_name": { "type": "string", "description": "Название улицы с коротким типом" } }, "additionalProperties": false, "description": "Название и идентификатор улицы" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.SubdistrictElement": { "type": "object", "properties": { "name": { "type": "string", "description": "Название части района" }, "short_name": { "type": "string", "description": "Короткое название части района" } }, "additionalProperties": false, "description": "" }, "GeoService.Dictionaries.Models.Responses.GeoPointResponse": { "type": "object", "properties": { "lat": { "type": "number", "description": "Широта", "format": "double" }, "lon": { "type": "number", "description": "Долгота", "format": "double" } }, "additionalProperties": false, "description": "Координаты" }, "GeoService.Dictionaries.Models.Responses.GetCitiesResponse": { "required": [ "cities" ], "type": "object", "properties": { "cities": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetCityTypesResponse": { "required": [ "city_types" ], "type": "object", "properties": { "city_types": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.CityType" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetCountriesResponse": { "required": [ "countries" ], "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetDirectionsResponse": { "required": [ "directions" ], "type": "object", "properties": { "directions": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Direction" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetDistrictsResponse": { "required": [ "districts" ], "type": "object", "properties": { "districts": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.District" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse": { "required": [ "federal_districts" ], "type": "object", "properties": { "federal_districts": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.FederalDistrict" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetRegionsResponse": { "required": [ "regions" ], "type": "object", "properties": { "regions": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.Region": { "required": [ "clarified_name", "country_id", "name", "region_id" ], "type": "object", "properties": { "region_id": { "type": "integer", "description": "Идентификатор региона", "format": "int32" }, "name": { "type": "string", "description": "Название региона" }, "country_id": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "federal_district_id": { "type": "integer", "description": "Идентификатор федерального округа\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "fias_id": { "type": "string", "description": "Идентификатор ФИАС\r\n\nЗначение по умолчанию: `null`", "format": "uuid", "nullable": true }, "tax_region_code": { "type": "string", "description": "Код региона для ФНС.\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "clarified_name": { "type": "string", "description": "Название региона с уточнением, что это регион при необходимости.\r\nЕсли название региона совпадает с каким-нибудь городом, то для него добавляется уточнение." }, "regional_center_id": { "type": "integer", "description": "Идентификатор регионального центра\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "is_legacy": { "type": "boolean", "description": "Флаг, обозначающий, что объект является устаревшим.\r\n\nЗначение по умолчанию: `false`" } }, "additionalProperties": false, "description": "Модель, описывающая сущность \"Регион\"" }, "GeoService.Dictionaries.Models.Validation.SingleErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "description": "Текстовый код ошибки" }, "reason": { "type": "string", "description": "Человекочитаемое описание ошибки" }, "details": { "type": "object", "additionalProperties": {}, "description": "Дополнительная информация об ошибке", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Validation.ValidationErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "readOnly": true }, "reason": { "type": "string", "readOnly": true }, "error_list": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "details": { "type": "object", "additionalProperties": {}, "nullable": true } }, "additionalProperties": false }, "City": { "type": "object", "additionalProperties": false, "properties": { "Id2": { "type": "string", "format": "guid" }, "CityId": { "type": "integer", "description": "Id города", "format": "int32" }, "RegionId": { "type": "integer", "description": "Id региона", "format": "int32", "nullable": true }, "CountryId": { "type": "integer", "description": "Id страны", "format": "int32", "nullable": true }, "FullName": { "type": "string", "description": "Составное название состоящее из названий города, региона и страны разделенные через запятую" }, "ShortName": { "type": "string", "description": "Составное название состоящее из названия города,\nназвания региона (если город не является областным центром) и\nбуквенного кода страны (если страна отличается от России)" }, "FullNameEng": { "type": "string", "description": "Составное название состоящее из названий города, региона и страны разделенные через запятую, на английском" }, "ShortNameEng": { "type": "string", "description": "Составное название состоящее из названия города,\nназвания региона (если город не является областным центром) и\nбуквенного кода страны (если страна отличается от России), на английском" }, "IsRegionalCenter": { "type": "boolean", "description": "Является ли город региональным центром" }, "CitySize": { "type": "integer", "description": "Размер города по числу жителей", "format": "int32" }, "FiasId": { "type": "string", "description": "идентификатор в базе данных ФИАС", "format": "guid", "nullable": true }, "Longitude": { "type": "number", "description": "Долгота города", "format": "double", "nullable": true }, "Latitude": { "type": "number", "description": "Широта города", "format": "double", "nullable": true }, "CityName": { "type": "string", "description": "Название города" }, "RegionName": { "type": "string", "description": "Название региона" }, "CountryName": { "type": "string", "description": "Название страны" }, "CityNameEng": { "type": "string", "description": "Название города на английском" }, "RegionNameEng": { "type": "string", "description": "Название региона на английском" }, "CountryNameEng": { "type": "string", "description": "Название страны на английском" }, "CountryCodeName": { "type": "string", "description": "Буквенный код страны" } } }, "FinalExceptionModelOfCityNotFoundException": { "type": "object", "description": "Модель ошибки", "additionalProperties": false, "properties": { "Reason": { "type": "string", "description": "Причина ошибки" }, "Error": { "type": "string", "description": "Ключ ошибки" } } }, "BaseDictionaryType": { "type": "object", "additionalProperties": false, "properties": { "Id": { "type": "integer", "description": "Id", "format": "int64" }, "Id2": { "type": "string", "description": "Guid", "format": "guid" }, "Name": { "type": "string", "description": "Название" } } }, "Region": { "allOf": [ { "$ref": "#/components/schemas/BaseDictionaryType" }, { "type": "object", "additionalProperties": false, "properties": { "NameEng": { "type": "string", "description": "Название на английском" }, "RegionClearName": { "type": "string", "description": "Только название области или края. Напр, Московская область -> Московская" }, "RegionTypeAbbr": { "type": "string", "description": "Тип региона. Напр, Московская область -> обл." }, "CountryId": { "type": "integer", "description": "Id страны", "format": "int32" }, "RegionCode": { "type": "string", "description": "Код региона" } } } ] }, "StreetType": { "allOf": [ { "$ref": "#/components/schemas/BaseDictionaryType" }, { "type": "object", "additionalProperties": false, "properties": { "ShortName": { "type": "string", "description": "Короткое название" } } } ] }, "PublicGeoParserResultView": { "properties": { "city_id": { "description": "Id города", "format": "int32", "type": "integer" }, "is_success": { "description": "Геокодирование завершено успешно", "type": "boolean" }, "street": { "description": "Улица/район", "type": "string" } }, "required": [ "is_success" ], "type": "object" }, "PublicLocationsParseDto": { "items": { "type": "string" }, "type": "array" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Authorization: Bearer {authorizationToken}" }, "JWT": { "type": "apiKey", "description": "Bearer {access_token}", "name": "Authorization", "in": "header" } } } }