Latest version 2.4.9
REST Documentation
-
GeoRouting REST Documentation
Overview
Documentation of GeoRouting REST Web Service.
You can test all the functions inside the api with swagger ui from: http://<dockerhost>:8080/GeoRouting-WS-R/swagger-ui.html
Swagger documentation
Web service functions:
If docker has the rest secret code environment, all service has need the secret code like this ?restsecret=[secretcode string] example: http://127.0.0.1:8081/GeoRouting-WS-R/georouting/geordbbasedata/isServiceCodeNeeded?restsecret=RtbHs38J289VXdkRY
Version information
Version : 2.4.9
URI scheme
Host : localhost:8090
BasePath : /GeoRouting-WS-RTags
- calculate-collection-controller : Calculate Collection Controller
- calculate-route-controller : Calculate Route Controller
- calculatebu-specific-route-controller : Calculatebu Specific Route Controller
- geo-rdb-base-data-controller : Geo Rdb Base Data Controller
Paths
calculateCollectionAndRouteData
POST /georouting/calculatecollection/calculateCollectionAndRouteResult
Parameters
Type Name Description Schema Body
input
requiredinput
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-collection-controller
calculateCollectionAndRouteDataWithPredefinedDeliveryBU
POST /georouting/calculatecollection/calculateCollectionAndRouteResultWithPredefinedDeliveryBU
Parameters
Type Name Description Schema Body
input
requiredinput
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-collection-controller
calculateCollectionData
POST /georouting/calculatecollection/calculateCollectionData
Parameters
Type Name Description Schema Body
crInputData
requiredcrInputData
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-collection-controller
calculateProductSelection
POST /georouting/calculatecollection/calculateProductSelection
Parameters
Type Name Description Schema Body
crInputData
requiredcrInputData
Responses
HTTP Code Description Schema 200
OK
< CrCollectionDataWithSoAsDTO > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-collection-controller
calculateCollectionDepot
POST /georouting/calculateroute/calculateCollectionDepot
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getCheckDigit
POST /georouting/calculateroute/checkDigit
Parameters
Type Name Description Schema Body
checkDigitDTO
requiredcheckDigitDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
domesticRouteWithRouteInputdata
POST /georouting/calculateroute/domestic_route_with_route_inputdata
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
domesticrouteWithLabelDataWithRouteInputdata
POST /georouting/calculateroute/domesticroute_with_label_data_with_route_inputdata
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getCityByCountryAndPostal
POST /georouting/calculateroute/getCityByCountryAndPostal
Parameters
Type Name Description Schema Body
countryCodeNPostalCodeDTO
requiredcountryCodeNPostalCodeDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getCityByCountryAndPrefix
POST /georouting/calculateroute/getCityByCountryAndPrefix
Parameters
Type Name Description Schema Body
countryCodeNPostalCodeDTO
requiredcountryCodeNPostalCodeDTO
Responses
HTTP Code Description Schema 200
OK
< City > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getCityLocalByCountryAndPostalAndLang
POST /georouting/calculateroute/getCityLocalByCountryAndPostalAndLang
Parameters
Type Name Description Schema Body
codeNPostalCodeNLang
requiredcodeNPostalCodeNLang
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getCityLocalByCountryAndPrefixAndLang
POST /georouting/calculateroute/getCityLocalByCountryAndPrefixAndLang
Parameters
Type Name Description Schema Body
countryCodeNPrefixNLang
requiredcountryCodeNPrefixNLang
Responses
HTTP Code Description Schema 200
OK
< City > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getDbVersionForDate
POST /georouting/calculateroute/getDbVersionForDate
Parameters
Type Name Description Schema Body
date
requireddate
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getImportedList
POST /georouting/calculateroute/getImportedList
Responses
HTTP Code Description Schema 200
OK
object
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getLastDbValidTo
POST /georouting/calculateroute/getLastDbValidTo
Responses
HTTP Code Description Schema 200
OK
object
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getPostalByCountryAndCity
POST /georouting/calculateroute/getPostalByCountryAndCity
Parameters
Type Name Description Schema Body
countryCodeNCity
requiredcountryCodeNCity
Responses
HTTP Code Description Schema 200
OK
< Postalcode > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getPostalByCountryAndCode
POST /georouting/calculateroute/getPostalByCountryAndCode
Parameters
Type Name Description Schema Body
countryCodeNPostalCodeDTO
requiredcountryCodeNPostalCodeDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getPostalsByCountryAndPrefix
POST /georouting/calculateroute/getPostalsByCountryAndPrefix
Parameters
Type Name Description Schema Body
countryCodeNPrefixDTO
requiredcountryCodeNPrefixDTO
Responses
HTTP Code Description Schema 200
OK
< Postalcode > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getPropertiesForProductSelectionList
POST /georouting/calculateroute/getPropertiesForProductSelectionList
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
< Map«string,string» > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getPropertiesForProductSelectionListWithAdditionalElements
POST /georouting/calculateroute/getPropertiesForProductSelectionListWithAdditionalElements
Parameters
Type Name Description Schema Body
routeInputDataWithAdditionalElementsDTO
requiredrouteInputDataWithAdditionalElementsDTO
Responses
HTTP Code Description Schema 200
OK
< Map«string,string» > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getPropertiesForProductSelectionListWithFillElement
POST /georouting/calculateroute/getPropertiesForProductSelectionWithFillElement
Parameters
Type Name Description Schema Body
routeInputDataNElementStringDTO
requiredrouteInputDataNElementStringDTO
Responses
HTTP Code Description Schema 200
OK
< Map«string,string» > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getPropertiesForProductSelectionListWithFillElementAndAdditionalElements
POST /georouting/calculateroute/getPropertiesForProductSelectionWithFillElementAndAdditionalElements
Parameters
Type Name Description Schema Body
routeInputDataNElementStringDTO
requiredrouteInputDataNElementStringDTO
Responses
HTTP Code Description Schema 200
OK
< Map«string,string» > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getPropertiesForResult
POST /georouting/calculateroute/getPropertiesForResult
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
< string, string > map
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getVersionPrefix
POST /georouting/calculateroute/getVersionPrefix
Parameters
Type Name Description Schema Body
date
requireddate
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
isUpToDate
POST /georouting/calculateroute/isUpToDate
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
*/*
Tags
- calculate-route-controller
onlycsort
POST /georouting/calculateroute/onlyCsort
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
onlyCsortList
POST /georouting/calculateroute/onlyCsortList
Parameters
Type Name Description Schema Body
routeInputDataList
requiredrouteInputDataList
< RouteInputDataDTO > array
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
onlyDbuQuick
POST /georouting/calculateroute/onlyDbuQuick
Parameters
Type Name Description Schema Body
routeInputDataWithPCodeWarning
requiredrouteInputDataWithPCodeWarning
Responses
HTTP Code Description Schema 200
OK
string
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
onlydsort
POST /georouting/calculateroute/onlyDsort
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
onlyDsortList
POST /georouting/calculateroute/onlyDsortList
Parameters
Type Name Description Schema Body
routeInputDataList
requiredrouteInputDataList
< RouteInputDataDTO > array
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
onlyosort
POST /georouting/calculateroute/onlyOsort
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
onlyOsortList
POST /georouting/calculateroute/onlyOsortList
Parameters
Type Name Description Schema Body
routeInputDataList
requiredrouteInputDataList
< RouteInputDataDTO > array
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
onlyRoute
POST /georouting/calculateroute/onlyRoute
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
onlyRouteList
POST /georouting/calculateroute/onlyRouteList
Parameters
Type Name Description Schema Body
routeInputDataList
requiredrouteInputDataList
< RouteInputDataDTO > array
Responses
HTTP Code Description Schema 200
OK
< RouteResultWithError > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
productSelection
POST /georouting/calculateroute/productSelection
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
< ProductSelectionResultDTO > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
productSelectionList
POST /georouting/calculateroute/productSelectionList
Parameters
Type Name Description Schema Body
routeInputDataListDTO
requiredrouteInputDataListDTO
< RouteInputDataDTO > array
Responses
HTTP Code Description Schema 200
OK
< < ProductSelectionResultWithError > array > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
productSelectionWithFillElement
POST /georouting/calculateroute/productSelectionWithFillElement
Parameters
Type Name Description Schema Body
routeInputDataNElementStringDTO
requiredrouteInputDataNElementStringDTO
Responses
HTTP Code Description Schema 200
OK
< ProductSelectionResult > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
returnNOPSSet
POST /georouting/calculateroute/returnNOPSSet
Parameters
Type Name Description Schema Body
nopsSetDTO
requirednopsSetDTO
Responses
HTTP Code Description Schema 200
OK
< NOPSElement > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
routeWithRouteInputdata
POST /georouting/calculateroute/route
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
routeList
POST /georouting/calculateroute/routeList
Parameters
Type Name Description Schema Body
routeInputDataListDTO
requiredrouteInputDataListDTO
Responses
HTTP Code Description Schema 200
OK
< RouteResultWithError > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
routeWithElementListFiltering
POST /georouting/calculateroute/routeWithElementListFiltering
Parameters
Type Name Description Schema Body
routeInputDataWithElementList
requiredrouteInputDataWithElementList
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
routeWithLabelData
POST /georouting/calculateroute/routeWithLabelData
Parameters
Type Name Description Schema Body
routeInputDataDTO
requiredrouteInputDataDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculate-route-controller
getCalcPickupData
POST /georouting/calculateroute_specific_route/calcPickupData
Parameters
Type Name Description Schema Body
routeInputDataWithMaxWeightDTO
requiredrouteInputDataWithMaxWeightDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculatebu-specific-route-controller
routeWithBuRAndMSort
POST /georouting/calculateroute_specific_route/routeWithBuRAndMSort
Parameters
Type Name Description Schema Body
routeInputDataWithCustomerIDDTO
requiredrouteInputDataWithCustomerIDDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- calculatebu-specific-route-controller
findAllPostalCodesWithRelatedCityByCountryCode
POST /georouting/geordbbasedata/findAllPostalCodesWithRelatedCityByCountryCode
Parameters
Type Name Description Schema Body
dto
requireddto
Responses
HTTP Code Description Schema 200
OK
< PostalCodeWithCity > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
findAllPostalCodesWithRelatedCityByCountryCodeAndFilter
POST /georouting/geordbbasedata/findAllPostalCodesWithRelatedCityByCountryCodeAndFilter
Parameters
Type Name Description Schema Body
dto
requireddto
Responses
HTTP Code Description Schema 200
OK
< PostalCodeWithCity > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
firstWorkingDay
POST /georouting/geordbbasedata/firstWorkingDay
Parameters
Type Name Description Schema Body
input
requiredinput
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllAsCode
POST /georouting/geordbbasedata/getAllAsCode
Responses
HTTP Code Description Schema 200
OK
< AsCode > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllBu
POST /georouting/geordbbasedata/getAllBu
Responses
HTTP Code Description Schema 200
OK
< BusinessUnit > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllCountry
POST /georouting/geordbbasedata/getAllCountry
Responses
HTTP Code Description Schema 200
OK
< Country > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllCountryForLang
POST /georouting/geordbbasedata/getAllCountryForLang
Parameters
Type Name Description Schema Body
langDTO
requiredlangDTO
Responses
HTTP Code Description Schema 200
OK
< CountryForLang > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllDepot
POST /georouting/geordbbasedata/getAllDepot
Responses
HTTP Code Description Schema 200
OK
< Depot > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllDepotByBUCode
POST /georouting/geordbbasedata/getAllDepotByBUCode
Parameters
Type Name Description Schema Body
buCodeDTO
requiredbuCodeDTO
Responses
HTTP Code Description Schema 200
OK
< Depot > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllDepotByDepotNumberList
POST /georouting/geordbbasedata/getAllDepotByDepotNumberList
Parameters
Type Name Description Schema Body
depotNumberListDTO
requireddepotNumberListDTO
Responses
HTTP Code Description Schema 200
OK
< Depot > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllDepotWithExtendedFields
POST /georouting/geordbbasedata/getAllDepotWithExtendedFields
Responses
HTTP Code Description Schema 200
OK
< DepotWithExtendedFields > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllDepotWithExtendedFieldsByBUCode
POST /georouting/geordbbasedata/getAllDepotWithExtendedFieldsByBUCode
Parameters
Type Name Description Schema Body
buCodeDTO
requiredbuCodeDTO
Responses
HTTP Code Description Schema 200
OK
< DepotWithExtendedFields > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllDepotWithExtendedFieldsByDepotNumberList
POST /georouting/geordbbasedata/getAllDepotWithExtendedFieldsByDepotNumberList
Parameters
Type Name Description Schema Body
depotNumberListDTO
requireddepotNumberListDTO
Responses
HTTP Code Description Schema 200
OK
< DepotWithExtendedFields > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllElement
POST /georouting/geordbbasedata/getAllElement
Responses
HTTP Code Description Schema 200
OK
< ElementObj > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllElementByLang
POST /georouting/geordbbasedata/getAllElementByLang
Parameters
Type Name Description Schema Body
langDTO
requiredlangDTO
Responses
HTTP Code Description Schema 200
OK
< string, string > map
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllNetwork
POST /georouting/geordbbasedata/getAllNetwork
Responses
HTTP Code Description Schema 200
OK
< Network > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllRCode
POST /georouting/geordbbasedata/getAllRCode
Responses
HTTP Code Description Schema 200
OK
< RCodeData > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllServiceInfoForLang
POST /georouting/geordbbasedata/getAllServiceInfoForLang
Parameters
Type Name Description Schema Body
langDTO
requiredlangDTO
Responses
HTTP Code Description Schema 200
OK
< ServiceInfo > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllSoCode
POST /georouting/geordbbasedata/getAllSoCode
Responses
HTTP Code Description Schema 200
OK
< SoCode > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllStatesByCountryCode
POST /georouting/geordbbasedata/getAllStatesByCountryCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getAllStatesForLang
POST /georouting/geordbbasedata/getAllStatesForLang
Parameters
Type Name Description Schema Body
langDTO
requiredlangDTO
Responses
HTTP Code Description Schema 200
OK
< StateForLang > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getBUAlphaByBUCode
POST /georouting/geordbbasedata/getBUAlphaByBUCode
Parameters
Type Name Description Schema Body
buCode
requiredbuCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getBUByBUAlphaString
POST /georouting/geordbbasedata/getBUByBUAlphaString
Parameters
Type Name Description Schema Body
buAlphastring
requiredbuAlphastring
Responses
HTTP Code Description Schema 200
OK
< BusinessUnit > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getBUByBUCode
POST /georouting/geordbbasedata/getBUByBUCode
Parameters
Type Name Description Schema Body
buCode
requiredbuCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getBUCodeByAlphaString
POST /georouting/geordbbasedata/getBUCodeByAlphaString
Parameters
Type Name Description Schema Body
alphaString
requiredalphaString
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getBUNameByBUCode
POST /georouting/geordbbasedata/getBUNameByBUCode
Parameters
Type Name Description Schema Body
buCode
requiredbuCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getCitiesByCountryAndCityName
POST /georouting/geordbbasedata/getCitiesByCountryAndCityName
Parameters
Type Name Description Schema Body
countryCodeWithCityNameDTO
requiredcountryCodeWithCityNameDTO
Responses
HTTP Code Description Schema 200
OK
< City > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getCitiesByCountryAndCityNameAndPostalCode
POST /georouting/geordbbasedata/getCitiesByCountryAndCityNameAndPostalCode
Parameters
Type Name Description Schema Body
countryCodeWithCityNameAndPostalCodeRangeDTO
requiredcountryCodeWithCityNameAndPostalCodeRangeDTO
Responses
HTTP Code Description Schema 200
OK
< City > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getCitiesByCountryAndPostalCode
POST /georouting/geordbbasedata/getCitiesByCountryAndPostalCode
Parameters
Type Name Description Schema Body
countryCodeWithPostalCodeRangeDTO
requiredcountryCodeWithPostalCodeRangeDTO
Responses
HTTP Code Description Schema 200
OK
< City > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getCitiesByCountryCode
POST /georouting/geordbbasedata/getCitiesByCountryCode
Parameters
Type Name Description Schema Body
countryCodeDTO
requiredcountryCodeDTO
Responses
HTTP Code Description Schema 200
OK
< City > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getCodeObjectByValue
POST /georouting/geordbbasedata/getCodeObjectByValue
Parameters
Type Name Description Schema Body
codeObjectByValueDTO
requiredcodeObjectByValueDTO
Responses
HTTP Code Description Schema 200
OK
object
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getCodeObjetByNumericValue
POST /georouting/geordbbasedata/getCodeObjetByNumericValue
CAUTIONoperation.deprecated
Parameters
Type Name Description Schema Body
codeObjetByNumericValueDTO
requiredcodeObjetByNumericValueDTO
Responses
HTTP Code Description Schema 200
OK
object
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getCountryByCountryCode
POST /georouting/geordbbasedata/getCountryByCountryCode
Parameters
Type Name Description Schema Body
countryCode
requiredcountryCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getCountryByISONum
POST /georouting/geordbbasedata/getCountryByISONum
Parameters
Type Name Description Schema Body
isoNum
requiredisoNum
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getCountryCountryCodeByNum
POST /georouting/geordbbasedata/getCountryCountryCodeByNum
Parameters
Type Name Description Schema Body
ISONum
requiredISONum
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getCountryISONumByCountryCode
POST /georouting/geordbbasedata/getCountryISONumByCountryCode
Parameters
Type Name Description Schema Body
countryCode
requiredcountryCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getCountryNameByLang
POST /georouting/geordbbasedata/getCountryNameByLang
Parameters
Type Name Description Schema Body
countryCodeAndLangDTO
requiredcountryCodeAndLangDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getDepotByCode
POST /georouting/geordbbasedata/getDepotByCode
Parameters
Type Name Description Schema Body
depotCode
requireddepotCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getDepotWithExtendedFieldsByCode
POST /georouting/geordbbasedata/getDepotWithExtendedFieldsByCode
Parameters
Type Name Description Schema Body
depotCode
requireddepotCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getElementByElementCode
POST /georouting/geordbbasedata/getElementByElementCode
Parameters
Type Name Description Schema Body
elementCode
requiredelementCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getElementDescByLang
POST /georouting/geordbbasedata/getElementDescByLang
Parameters
Type Name Description Schema Body
elementCode
requiredelementCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getElementObject
POST /georouting/geordbbasedata/getElementObject
Parameters
Type Name Description Schema Body
code
requiredcode
Responses
HTTP Code Description Schema 200
OK
< ElementObj > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getElementTypeByElementCode
POST /georouting/geordbbasedata/getElementTypeByElementCode
Parameters
Type Name Description Schema Body
elementCode
requiredelementCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getLanguagesByCountryCode
POST /georouting/geordbbasedata/getLanguagesByCountryCode
Parameters
Type Name Description Schema Body
countrycode
requiredcountrycode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getNetworkByCode
POST /georouting/geordbbasedata/getNetworkByCode
Parameters
Type Name Description Schema Body
networkCodeDTO
requirednetworkCodeDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getPostalCodesByCountry
POST /georouting/geordbbasedata/getPostalCodesByCountry
Parameters
Type Name Description Schema Body
dto
requireddto
Responses
HTTP Code Description Schema 200
OK
< Postalcode > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getPostalCodesByCountryAndPostalCodeRange
POST /georouting/geordbbasedata/getPostalCodesByCountryAndPostalCodeRange
Parameters
Type Name Description Schema Body
dto
requireddto
Responses
HTTP Code Description Schema 200
OK
< Postalcode > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getPostalcodePatternByCountryCode
POST /georouting/geordbbasedata/getPostalcodePatternByCountryCode
Parameters
Type Name Description Schema Body
countryCode
requiredcountryCode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getRCodeByCode
POST /georouting/geordbbasedata/getRCodeByCode
Parameters
Type Name Description Schema Body
rCodeDTO
requiredrCodeDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getSOFieldInfosByLang
POST /georouting/geordbbasedata/getSOFieldInfosByLang
Parameters
Type Name Description Schema Body
socodeCodeAndLangDTO
requiredsocodeCodeAndLangDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getServiceMark
POST /georouting/geordbbasedata/getServiceMark
Parameters
Type Name Description Schema Body
socode
requiredsocode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getServicetext
POST /georouting/geordbbasedata/getServicetext
Parameters
Type Name Description Schema Body
code
requiredcode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getSpecifiedNumberOfWorkingDays
POST /georouting/geordbbasedata/getSpecifiedNumberOfWorkingDays
Parameters
Type Name Description Schema Body
input
requiredinput
Responses
HTTP Code Description Schema 200
OK
< string > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getStateNameByLang
POST /georouting/geordbbasedata/getStateNameByLang
Parameters
Type Name Description Schema Body
stateCodeAndLangDTO
requiredstateCodeAndLangDTO
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getStatesByCountryCode
POST /georouting/geordbbasedata/getStatesByCountryCode
Parameters
Type Name Description Schema Body
countryCode
requiredcountryCode
Responses
HTTP Code Description Schema 200
OK
< State > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
getWorkingDaysBetweenSpecifiedPeriod
POST /georouting/geordbbasedata/getWorkingDaysBetweenSpecifiedPeriod
Parameters
Type Name Description Schema Body
input
requiredinput
Responses
HTTP Code Description Schema 200
OK
< string > array
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
isServiceCodeNeeded
POST /georouting/geordbbasedata/isServiceCodeNeeded
Parameters
Type Name Description Schema Body
socode
requiredsocode
Responses
HTTP Code Description Schema 200
OK
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
isWorkingDay
POST /georouting/geordbbasedata/isWorkingDay
Parameters
Type Name Description Schema Body
input
requiredinput
Responses
HTTP Code Description Schema 200
OK
boolean
201
Created
No Content
401
Unauthorized
No Content
403
Forbidden
No Content
404
Not Found
No Content
Consumes
application/json
Produces
application/json
Tags
- geo-rdb-base-data-controller
Definitions
AsCode
Name Schema ascode
optionalstring
elementCodes
optionalstring
elements
optional< ElementObj > array
serviceText
optionalstring
BUAlphaStringDTO
Name Schema buAlphaString
optionalstring
BUAlphaStringListDTO
Name Schema buCodeList
optional< string > array
BUNameByBUCodeDTO
Name Schema buNameByBUCode
optionalstring
BuCodeDTO
Name Schema buCode
optionalstring
BusinessUnit
Name Schema buAlphastr
optionalstring
buCode
optionalstring
buDefaultCountry
optionalstring
buFinancialgroup
optionalstring
buGeographGroup
optionalstring
buName
optionalstring
buTechnicalGroup
optionalstring
dpdContract
optionalstring
typeOfBu
optionalstring
CalculateCollectionAndRouteResultInputDTO
Name Schema crInputData
optionalrouteInputDataForCollectionRequest
optionalCalculateCollectionAndRouteResultWithDeliveryBUInputDTO
Name Schema crInputData
optionalrouteInputDataForCollectionRequestWithDeliveryBu
optionalCheckDigitDTO
Name Schema checkDigit
optionalstring
City
Name Schema beginPostCode
optionalstring
cityNameEnglish
optionalstring
cityNameLocal
optionalstring
cityNameLocalLang
optionalstring
countryCode
optionalstring
endPostCode
optionalstring
stateCode
optionalstring
CodeAndLangDTO
Name Schema lang
optionalstring
soCode
optionalstring
CodeDTO
Name Schema code
optionalstring
CodeObjectByValueDTO
Name Schema lang
optionalstring
value
optionalstring
CodeObjetByNumericValueDTO
Name Schema lang
optionalstring
numericValue
optionalstring
CollectionDepotResult
Name Schema collectionBU
optionalstring
collectionDepot
optionalstring
CollectionPlace
Name Schema bu
optionalstring
city
optionalstring
country
optionalstring
postcode
optionalstring
Country
Name Schema cityvalidation
optionalstring
countryCode
optionalstring
destinatioonLanguages
optionalstring
dummyCountryCode
optionalstring
flagNeedState
optionalinteger (int32)
flagPostCodeNo
optionalinteger (int32)
freetradeArea
optionalstring
isoNumCountryCode
optionalstring
isoalpha2CountryCode
optionalstring
isoalpha3CountryCode
optionalstring
postCodePattern
optionalstring
postCodeValifation
optionalstring
CountryCodeAndLangDTO
Name Schema countryCode
optionalstring
lang
optionalstring
CountryCodeByNumDTO
Name Schema countryCodeByNum
optionalstring
CountryCodeDTO
Name Schema countryCode
optionalstring
CountryCodeNCity
Name Schema city
optionalstring
countryCode
optionalstring
CountryCodeNPostalCodeDTO
Name Schema countryCode
optionalstring
postalCode
optionalstring
CountryCodeNPostalCodeNLang
Name Schema countryCode
optionalstring
lang
optionalstring
postalCode
optionalstring
CountryCodeNPrefixDTO
Name Schema cityNamePrefix
optionalstring
countryCode
optionalstring
CountryCodeNPrefixNLang
Name Schema cityNamePrefix
optionalstring
countryCode
optionalstring
lang
optionalstring
CountryCodeWithCityNameAndPostalCodeRangeDTO
Name Schema cityName
optionalstring
countryCode
optionalstring
postalCodeFrom
optionalstring
postalCodeTo
optionalstring
CountryCodeWithCityNameDTO
Name Schema cityName
optionalstring
countryCode
optionalstring
CountryCodeWithPostalCodeRangeDTO
Name Schema countryCode
optionalstring
postalCodeFrom
optionalstring
postalCodeTo
optionalstring
CountryForLang
Name Schema cityvalidation
optionalstring
countryCode
optionalstring
destinatioonLanguages
optionalstring
dummyCountryCode
optionalstring
flagNeedState
optionalinteger (int32)
flagPostCodeNo
optionalinteger (int32)
freetradeArea
optionalstring
isoNumCountryCode
optionalstring
isoalpha2CountryCode
optionalstring
isoalpha3CountryCode
optionalstring
name
optionalstring
postCodePattern
optionalstring
postCodeValifation
optionalstring
CountryISONumByCountryCodeDTO
Name Schema countryISONumByCountryCode
optionalstring
CountryNameByLangDTO
Name Schema countryNameByLang
optionalstring
CrBaseInputData
Name Schema collectionDate
optionalstring (date-time)
collectionPlace
optionalrequestingBu
optionalstring
requestingCountry
optionalstring
CrCollectionDataAndRouteResultDTO
Name Schema collectionData
optionalrouteResult
optionalCrCollectionDataDTO
Name Schema collectingBu
optionalstring
collectingDepot
optionalstring
warningList
optional< GeoWarning > array
workingDayDate
optionalstring (date-time)
CrCollectionDataWithSoAsDTO
Name Schema asCode
optionalstring
collectingBu
optionalstring
collectingDepot
optionalstring
soCode
optionalstring
warningList
optional< GeoWarning > array
workingDayDate
optionalstring (date-time)
CrInputData
Name Schema collectionDate
optionalstring (date-time)
collectionPlace
optionaldeliveryAsCode
optionalstring
deliverySoCode
optionalstring
requestingBu
optionalstring
requestingCountry
optionalstring
DBVersionDTO
Name Schema version
optionalstring
Depot
Name Schema address2
optionalstring
address3
optionalstring
addressPostCode
optionalstring
buCode
optionalstring
building
optionalstring
cityName
optionalstring
companyName
optionalstring
companyName2
optionalstring
countrycode
optionalstring
depotstr
optionalstring
dummyDepot
optionalstring
fax
optionalstring
floor
optionalstring
geopostDepotnumber
optionalstring
groupId
optionalstring
iataLikeCode
optionalstring
mail
optionalstring
phone
optionalstring
postcode
optionalstring
propNum
optionalstring
sgpsLong
optionalstring
sgpslat
optionalstring
state
optionalstring
street
optionalstring
web
optionalstring
DepotCodeDTO
Name Schema depotCode
optionalstring
DepotNumberListDTO
Name Schema depotNumbers
optional< string > array
DepotWithExtendedFields
Name Schema address2
optionalstring
address3
optionalstring
addressPostCode
optionalstring
buCode
optionalstring
building
optionalstring
cityName
optionalstring
companyName
optionalstring
companyName2
optionalstring
countrycode
optionalstring
deliveryDepot
optionalstring
depotstr
optionalstring
dummyDepot
optionalstring
fax
optionalstring
floor
optionalstring
geopostDepotnumber
optionalstring
groupId
optionalstring
iataLikeCode
optionalstring
location
optionalstring
mail
optionalstring
phone
optionalstring
pickupDepot
optionalstring
postcode
optionalstring
propNum
optionalstring
scanningDepot
optionalstring
sgpsLong
optionalstring
sgpslat
optionalstring
state
optionalstring
street
optionalstring
web
optionalstring
ElementCodeAndLangDTO
Name Schema elementCode
optionalstring
lang
optionalstring
ElementCodeDTO
Name Schema elementCode
optionalstring
ElementDescByLangDTO
Name Schema elementDescByLang
optionalstring
ElementObj
Name Schema elementCode
optionalstring
elementShortCut
optionalstring
elementType
optionalstring
ElementStringDTO
Name Schema elements
optional< string > array
Exception
Name Schema cause
optionallocalizedMessage
optionalstring
message
optionalstring
stackTrace
optional< StackTraceElement > array
suppressed
optional< Throwable > array
GeoWarning
Name Schema dataValue
optionalstring
errorCode
optionalenum (shortcode: CR101 enName: No collection BU found (C1CBU), shortcode: CR102 enName: Not allowed collection request. (CALLOW), shortcode: CR103 enName: No collection depot found (C2CDEPOT), shortcode: F101 enName: Input file open error, shortcode: F102 enName: Input file read error, shortcode: F103 enName: File has no #END; string, file is not complete, shortcode: F104 enName: Undefined subtype found, shortcode: F105 enName: File close error, shortcode: F106 enName: Number of data not equals in db and in file, shortcode: I101 enName: com.geopostgroup.GeoRouting.dbtype not recognised, shortcode: I102 enName: com.geopostgroup.GeoRouting.reduceTo not recognised, shortcode: IM101 enName: Exploderule type not recognised, shortcode: IV101 enName: Input validation mandatory field Destination country not filled, shortcode: IV102 enName: Input validation mandatory field dpostcode not filled, shortcode: IV103 enName: Input validation mandatory field socode not filled, shortcode: IV104 enName: Input validation mandatory field date not filled, shortcode: IV105 enName: Input validation mandatory field origin depot not filled, shortcode: IV106 enName: Input validation postal code not matching with destination country postcode pattern, shortcode: IV107 enName: Input validation postal code is not valid, and for this country only valid postal code is accepted., shortcode: IV108 enName: Input validation city name is not valid, and for this country only valid city names are accepted, shortcode: IV109 enName: Input validation ASCODE is mandatory for the selected SOCOODE, but it is not specified, shortcode: IV110 enName: Input validation network table returned more than one row for input, shortcode: IV111 enName: Input validation network table returned more than one row for input, shortcode: IV112 enName: Input validation destination countrycode is not valid., shortcode: IV113 enName: Input validation BUSINESSUNIT table returned more than one row for input, shortcode: IV114 enName: Input validation bucode is not valid., shortcode: IV115 enName: Input validation SOCODES table returned more than one row for input, shortcode: IV116 enName: Input validation SOCODE is not valid., shortcode: IV117 enName: Input validation ASCODES table returned more than one row for input, shortcode: IV118 enName: Input validation ASCODE is not valid., shortcode: IV119 enName: Input validation DEPOTS table returned more than one row for input, shortcode: IV120 enName: Input validation DEPOT is not valid., shortcode: IV121 enName: Input validation IC table returned more than one row for input, shortcode: IV122 enName: Input validation subcode is not valid., shortcode: IV123 enName: Input validation VERSION table returned more than one row for input, shortcode: IV124 enName: Input validation no valid GeoRouting database is found, shortcode: IV125 enName: Input validation Destination depot is not set, shortcode: IV126 enName: Input validation CustomerId and SubCode is filled out together., shortcode: IV127 enName: Input validation ElementCode is invalid., shortcode: IV128 enName: Input validation input postal code is not valid., shortcode: IV129 enName: No SoCode found for the elements, shortcode: IV130 enName: Input validation mandatory field Collection Country not filled, shortcode: IV131 enName: Input validation mandatory field CollectionPostCode not filled, shortcode: IV132 enName: Input validation mandatory field RequestingBu not filled, shortcode: IV133 enName: Input validation mandatory field RequestingCountry not filled, shortcode: IV134 enName: Input validation mandatory field Date is not valid, shortcode: IV135 enName: Input validation RouteInput is null, shortcode: R101 enName: Routing problem, No BU found for this destination (R1DBU), shortcode: R102 enName: Routing problem, No Destination Depot found for this destination (R2ROUTE), shortcode: R103 enName: Service accredition problem, this service is not allowed for this destination (SOCODE), shortcode: R104 enName: Service accredition problem, this service is not allowed for this destination (SOASCODE), shortcode: R105 enName: Networkplan not found, shortcode: R106 enName: P0Properties not found, shortcode: S101 enName: SQL Database creation error., shortcode: S102 enName: SQL Database connection error., shortcode: S103 enName: SQL Database Disconnect error, shortcode: S104 enName: Create base tables error, shortcode: S105 enName: Commit failed, shortcode: S106 enName: Base data insert failed, shortcode: S107 enName: Child table fill select query failed, shortcode: S108 enName: Delete from table failed, shortcode: S109 enName: Child table fill insert query failed, shortcode: S110 enName: select query failed, shortcode: S111 enName: Query actual Geordb failed, shortcode: S112 enName: Unable to find matching SQL database, shortcode: S113 enName: Could not close prepared statement or result set, shortcode: S114 enName: GeoVersions table cannot be found, shortcode: U101 enName: Unknown exception happened, shortcode: W101 enName: Info: Postal code not matching with pattern, shortcode: W102 enName: Info: City name not found in the list., shortcode: W103 enName: Info: Postal code not found in postalcode table, shortcode: X999 enName: Unknown, shortcode: G001 enName: Sql no result row., shortcode: G002 enName: Character length validation error, shortcode: G003 enName: Country Alpha2 validation error, shortcode: G004 enName: Date parse failed., shortcode: G005 enName: Depot group list is malformed, shortcode: G006 enName: Input data format is invalid.)
sourceObj
optionalstring
sourceStep
optionalstring
GeoroutingValidDateDTO
Name Schema date
optionalstring
GetAllStatesByCountryCodeDTO
Name Schema allStatesByCountryCode
optional< string, < State > array > map
GetSpecifiedNumberOfWorkingDaysInput
Name Schema asCode
optionalstring
date
optionalstring
dpdWorkType
optionalenum (PICKUP, DELIVERY)
nonWorkingDayPlace
optionalnumberOfWorkingDaysToGet
optionalinteger (int32)
soCode
optionalstring
GetWorkingDaysBetweenSpecifiedPeriodInput
Name Schema asCode
optionalstring
date
optionalstring
dpdWorkType
optionalenum (PICKUP, DELIVERY)
endDate
optionalstring
nonWorkingDayPlace
optionalsoCode
optionalstring
ISONumDTO
Name Schema isoNum
optionalstring
IsServiceCodeNeededDTO
Name Schema serviceCodeNeeded
optionalboolean
IsUpToDateDTO
Name Schema upToDate
optionalboolean
IsWorkingDayInput
Name Schema asCode
optionalstring
date
optionalstring
dpdWorkType
optionalenum (PICKUP, DELIVERY)
nonWorkingDayPlace
optionalsoCode
optionalstring
IsWorkingDayOutput
Name Schema workingDay
optionalstring
LangDTO
Name Schema language
optionalstring
LanguagesByCountryCodeDTO
Name Schema countryLanguages
optional< string > array
Map«string,string»
Type : < string, string > map
NOPSElement
Name Schema asCode
optionalstring
elements
optional< string > array
nops
optional< string > array
soCode
optionalstring
NOPSSetDTO
Name Schema asCode
optionalstring
obu
optionalstring
soCode
optionalstring
Network
Name Schema buCode
optionalstring
countryCode
optionalstring
networkCode
optionalstring
networkName
optionalstring
NetworkCodeDTO
Name Schema networkCode
optionalstring
NonWorkingDayPlace
Name Schema bu
optionalstring
city
optionalstring
country
optionalstring
depot
optionalstring
postcode
optionalstring
OnlyCsortDTO
Name Schema csort
optionalstring
OnlyCsortList
Name Schema onlycsortList
optional< string > array
OnlyDsortDTO
Name Schema onlyDsort
optionalstring
OnlyDsortList
Name Schema dsortList
optional< string > array
OnlyOsorList
Name Schema osortList
optional< string > array
OnlyOsort
Name Schema osort
optionalstring
PickupRouteResult
Name Schema exception
optionalpickupDepot
optionalstring
pickupInfo
optionalstring
PostalCodePatternByCountryCodeDTO
Name Schema postalCodePattern
optional< string > array
PostalCodeWithCity
Name Schema cityName
optionalstring
postalCodeFrom
optionalstring
postalCodeTo
optionalstring
postcodeType
optionalstring
Postalcode
Name Schema beginPostCode
optionalstring
countryCode
optionalstring
endPostCode
optionalstring
postCodeType
optionalstring
PrefixDTO
Name Schema prefix
optionalstring
ProductSelectionResult
Type : object
ProductSelectionResultDTO
Type : object
ProductSelectionResultWithError
Type : object
RCodeDTO
Name Schema rcode
optionalstring
RCodeData
Name Schema address2
optionalstring
address3
optionalstring
buCode
optionalstring
cityName
optionalstring
companyName1
optionalstring
companyName2
optionalstring
countryCode
optionalstring
fax
optionalstring
floor
optionalstring
geopostDepotNumber
optionalstring
mail
optionalstring
phone
optionalstring
postCode
optionalstring
raadress2
optionalstring
raadress3
optionalstring
rabuilding
optionalstring
racityName
optionalstring
racompanyName1
optionalstring
racompanyName2
optionalstring
racountryCode
optionalstring
radepartment
optionalstring
rafloor
optionalstring
ragpsLocation
optionalstring
rapostCode
optionalstring
rastreet
optionalstring
rcode
optionalstring
socode
optionalstring
street
optionalstring
ReturnDigitDTO
Name Schema returnDigit
optionalstring
RouteInputDataDTO
Name Schema asCode
optionalstring
cityname
optionalstring
date
optionalstring
dcountry
optionalstring
ddepot
optionalstring
dnetwork
optionalstring
dpostcode
optionalstring
odepot
optionalstring
soCode
optionalstring
subCode
optionalstring
tradeStatus
optionalstring
RouteInputDataForCollectionRequest
Name Schema cityname
optionalstring
dCountry
optionalstring
dNetwork
optionalstring
dPostCode
optionalstring
subCode
optionalstring
tradeStatus
optionalstring
RouteInputDataForCollectionRequestWithDeliveryBu
Name Schema cityname
optionalstring
dCountry
optionalstring
dNetwork
optionalstring
dPostCode
optionalstring
deliveryBu
optionalstring
subCode
optionalstring
tradeStatus
optionalstring
RouteInputDataListDTO
Name Schema domestic
optionalboolean
routeInputDataList
optional< RouteInputDataDTO > array
RouteInputDataNElementStringDTO
Name Schema asCode
optionalstring
cityname
optionalstring
date
optionalstring
dcountry
optionalstring
ddepot
optionalstring
dnetwork
optionalstring
dpostcode
optionalstring
elementStringDTO
optionalexactMatchOnElements
optionalboolean
odepot
optionalstring
soCode
optionalstring
subCode
optionalstring
tradeStatus
optionalstring
RouteInputDataWithCustomerIDDTO
Name Schema asCode
optionalstring
cityname
optionalstring
customerId
optionalstring
date
optionalstring
dcountry
optionalstring
ddepot
optionalstring
dnetwork
optionalstring
dpostcode
optionalstring
odepot
optionalstring
soCode
optionalstring
subCode
optionalstring
tradeStatus
optionalstring
RouteInputDataWithElementListDTO
Name Schema cityname
optionalstring
date
optionalstring
dcountry
optionalstring
dnetwork
optionalstring
dpostcode
optionalstring
elementList
optional< string > array
odepot
optionalstring
subCode
optionalstring
tradeStatus
optionalstring
RouteInputDataWithMaxWeightDTO
Name Schema asCode
optionalstring
cityname
optionalstring
date
optionalstring
dcountry
optionalstring
ddepot
optionalstring
dnetwork
optionalstring
dpostcode
optionalstring
maxWeight
optionalstring
odepot
optionalstring
soCode
optionalstring
subCode
optionalstring
tradeStatus
optionalstring
RouteInputDataWithPCodeWarning
Name Schema asCode
optionalstring
cityname
optionalstring
date
optionalstring
dcountry
optionalstring
ddepot
optionalstring
dnetwork
optionalstring
dpostcode
optionalstring
odepot
optionalstring
pcodeWarning
optionalboolean
soCode
optionalstring
subCode
optionalstring
tradeStatus
optionalstring
RouteInputWithAdditionalElementsDto
Name Schema additionalElements
optional< string > array
routeInputData
optionalRouteInputWithFillElementsAndAdditionalElementsDto
Name Schema additionalElements
optional< string > array
routeInputDataWithFillElements
optionalRouteResult
Type : object
RouteResultWithBUSpecific
Type : object
RouteResultWithError
Type : object
RouteResultWithLabelData
Type : object
RouteResultWithServiceCodes
Type : object
SOFieldInfosByLangDTO
Name Schema soFieldInfosByLang
optionalstring
ServiceInfo
Name Schema id
optionalinteger (int32)
soCode
optionalstring
soFieldInfo
optionalstring
ServiceMarkDTO
Name Schema serviceMark
optionalstring
ServicetextDTO
Name Schema servicetext
optionalstring
SoCode
Name Schema asCodeNeeded
optionalstring
elementCodes
optionalstring
elements
optional< ElementObj > array
serviceInfo
optionalserviceMark
optionalstring
serviceText
optionalstring
soCode
optionalstring
SoCodeDTO
Name Schema soCode
optionalstring
StackTraceElement
Name Schema className
optionalstring
fileName
optionalstring
lineNumber
optionalinteger (int32)
methodName
optionalstring
nativeMethod
optionalboolean
State
Name Schema countryCode
optionalstring
regionCode
optionalstring
stateCode
optionalstring
StateCodeAndLangDTO
Name Schema lang
optionalstring
stateCode
optionalstring
StateForLang
Name Schema countryCode
optionalstring
regionCode
optionalstring
stateCode
optionalstring
stateName
optionalstring
StateNameByLangDTO
Name Schema stateNameByLang
optionalstring
Throwable
Name Schema cause
optionallocalizedMessage
optionalstring
message
optionalstring
stackTrace
optional< StackTraceElement > array
suppressed
optional< Throwable > array
Last updated 2021-05-21 15:08:01 +0200 -
CSS style sheet
/* Based on Readable from Bootswatch (http://bootswatch.com/readable/) */
@import url(“https://fonts.googleapis.com/css?family=Raleway:400,700”);/* document body (contains all content) */
body {
font-family: Georgia, “Times New Roman”, Times, serif;
font-size: 16px;
line-height: 1.42857143;
color: #333333;
background-color: #ffffff;
margin-left: 10%;
margin-right: 10%;
}.sectionbody .sect2 {
border-top: 3px double #8c8b8b;
padding-bottom: 20px;
}/* document header (contains title etc) */
#header {
width: 100%;
}
#header>h1 {
border-bottom: 1px solid #ddddd8;
padding-bottom: 8px;
}/* headings */
h1,
h2,
h3,
h4,
h5,
h6 {
font-family: “Raleway”, “Helvetica Neue”, Helvetica, Arial, sans-serif;
font-weight: bold;
line-height: 1.1;
color: inherit;
padding-bottom: 8px;
}
h1,
h2,
h3 {
margin-top: 22px;
margin-bottom: 11px;
}
h4,
h5,
h6 {
margin-top: 11px;
margin-bottom: 11px;
}
h1 {
font-size: 4em;
/* font-size: 41px; */
}
h2 {
font-size: 34px;
}
h3 {
font-size: 28px;
}
h4 {
font-size: 20px;
}
h5 {
font-size: 16px;
}
h6 {
font-size: 14px;
}/* plain paragraph text */
.paragraph {
/* font-family: sans-serif; */
margin: 0 0 11px;
}
p {
/* font-family: sans-serif; */
margin: 0 0 11px;
}/* blockquote text */
.quoteblock {
font-style: italic;
}
blockquote {
padding: 11px 22px;
margin: 0 0 22px;
font-size: 20px;
border-left: 5px solid #4582ec;
}
blockquote p:last-child,
blockquote ul:last-child,
blockquote ol:last-child {
margin-bottom: 0;
}
.blockquote-reverse,
blockquote.pull-right {
padding-right: 15px;
padding-left: 0;
border-right: 5px solid #4582ec;
border-left: 0;
text-align: right;
}
.blockquote-reverse footer:before,
blockquote.pull-right footer:before,
.blockquote-reverse small:before,
blockquote.pull-right small:before,
.blockquote-reverse .small:before,
blockquote.pull-right .small:before {
content: ”;
}
.blockquote-reverse footer:after,
blockquote.pull-right footer:after,
.blockquote-reverse small:after,
blockquote.pull-right small:after,
.blockquote-reverse .small:after,
blockquote.pull-right .small:after {
content: ‘\00A0 \2014’;
}/* blockquote attribution text */
.attribution,
.cite,
blockquote footer,
blockquote small,
blockquote .small {
display: block;
font-size: 80%;
line-height: 1.42857143;
color: #333333;
}
.attribution:before,
blockquote footer:before,
blockquote small:before,
blockquote .small:before {
content: ‘\2014 \00A0’;
}/* unordered list */
ul, ol {
margin-top: 0;
margin-bottom: 11px;
}
ul ul,
ol ul,
ul ol,
ol ol {
margin-bottom: 0;
}/* links */
a {
color: #4582ec;
background-color: transparent;
text-decoration: none;
}
a:hover,
a:focus {
color: #134fb8;
text-decoration: underline;
}
a:focus {
outline: 5px auto -webkit-focus-ring-color;
outline-offset: -2px;
}/* horizontal rules */
hr {
margin-top: 22px;
margin-bottom: 22px;
border: 0;
border-top: 1px solid #eeeeee;
}/* table */
table {
background-color: transparent;
width: 100%;
max-width: 100%;
margin-bottom: 22px;
border-collapse: collapse;
}
table col[class*=”col-“] {
position: static;
float: none;
display: table-column;
}
table td[class*=”col-“],
table th[class*=”col-“] {
position: static;
float: none;
display: table-cell;
}/* table caption */
caption {
padding-top: 8px;
padding-bottom: 8px;
color: #b3b3b3;
text-align: left;
}/* table header row */
thead {
border-bottom: 2px solid #dddddd;
}/* table header cell */
th {
text-align: left;
padding-left: 8px;
}/* table footer */
tfoot {
color: #807F81;
border-top: 1px solid #dddddd;
}/* table cell */
td {
border-top: 1px solid #dddddd;
}
td p {
margin: auto;
padding: 8px;
}/* table body */
tbody > tr:nth-of-type(odd) {
background-color: #f9f9f9;
}
tbody > tr:hover {
background-color: #f5f5f5;
}/* inline code */
code,
kbd,
pre,
samp {
font-family: Menlo, Monaco, Consolas, “Courier New”, monospace;
}
code {
padding: 2px 4px;
font-size: 90%;
color: #c7254e;
background-color: #f9f2f4;
border-radius: 4px;
}
kbd {
padding: 2px 4px;
font-size: 90%;
color: #ffffff;
background-color: #333333;
border-radius: 0;
-webkit-box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.25);
box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.25);
}
kbd kbd {
padding: 0;
font-size: 100%;
font-weight: bold;
-webkit-box-shadow: none;
box-shadow: none;
}
pre {
display: block;
padding: 10.5px;
margin: 0 0 11px;
font-size: 15px;
line-height: 1.42857143;
word-break: break-all;
word-wrap: break-word;
color: #333333;
background-color: #f5f5f5;
border: 1px solid #cccccc;
border-radius: 4px;
}
pre code {
padding: 0;
font-size: inherit;
color: inherit;
white-space: pre-wrap;
background-color: transparent;
border-radius: 0;
}/* image */
img {
max-width: 100%;
vertical-align: middle;
}/* footer section */
#footer {
margin-top: 22px;
padding: 14px 16px;
color: white;
background-color: #4582ec;
}/* responsiveness fixes */
video {
max-width: 100%;
}/* table of Contents sidebar */
#toctitle {
color: #ffffff;
}#toc ul {
display: inline;
list-style-type: none;
margin: 0;
padding: 0;
overflow: hidden;
}#toc li {
display: block;
}#toc a {
background-color: #4582ec;
float: left;
color: white;
text-align: center;
padding: 14px 16px;
text-decoration: none;
}#toc li a:hover {
background-color: #1863e6;
text-decoration: none;
}#toc:after {
content: ” “;
visibility: hidden;
display: block;
height: 0;
clear: both;
}@media all and (max-width: 600px) {
table {
width: 55vw!important;
font-size: 3vw;
}.tableblock p{
font-size: 20px
}