Geo data

Supported Methods

get countries
get regions for a country
get provinces for a region
get get cities for a province
get local zones for a city
get geo data using multiple criteria

Get countries

This method will return the list of available countries.
Response is not paginated, you get all values in one call.

Call

GET integrator/1005001/geodata/countries

Request

GET http://rexapi.gryphtech.com/api/v1/integrator/1005001/geodata/countries HTTP/1.1

Accept: application/xml; charset=utf-8
Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+a", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619"

Response XML

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8

<RexApiList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HasNextPage>false</HasNextPage>
  <HasPreviousPage>false</HasPreviousPage>
  <PageIndex>1</PageIndex>
  <PageSize>245</PageSize>
  <TotalCount>245</TotalCount>
  <TotalPageCount>1</TotalPageCount>
  <Items>
    <Geodata>
      <CountryID>53</CountryID>
      <CountryName>Albania</CountryName>
    </Geodata>
    <Geodata>
      <CountryID>255</CountryID>
      <CountryName>Angola</CountryName>
    </Geodata>
    .....
  </Items>
</RexApiList>

Response JSON

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
 "HasNextPage": false,
 "HasPreviousPage": false,
 "PageIndex": 1,
 "PageSize": 245,
 "TotalCount": 245,
 "TotalPageCount": 1,
 "Items": [
  {
   "CountryID": 53,
   "CountryName": "Albania"
  },
  {
   "CountryID": 255,
   "CountryName": "Angola"
  },
  .....
 ]
}

Get regions for a country

This method returns all regions for a specific country.
Response is not paginated, you get all values in one call.

Call

GET integrator/{integratorID}/geodata/countries/{countryID}/regions

Optional parameters

countryID: The ID of the country you want to return regions from

Request

GET http://rexapi.gryphtech.com/api/v1/integrator/1005001/geodata/countries/3/regions HTTP/1.1

Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+a", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619"
Accept: application/xml; charset=utf-8

Response XML

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8

<RexApiList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HasNextPage>false</HasNextPage>
  <HasPreviousPage>false</HasPreviousPage>
  <PageIndex>1</PageIndex>
  <PageSize>20</PageSize>
  <TotalCount>20</TotalCount>
  <TotalPageCount>1</TotalPageCount>
  <Items>
    <Geodata>
      <CountryID>3</CountryID>
      <CountryName>Italy</CountryName>
      <RegionID>16</RegionID>
      <RegionName>Abruzzo</RegionName>
    </Geodata>
    <Geodata>
      <CountryID>3</CountryID>
      <CountryName>Italy</CountryName>
      <RegionID>20</RegionID>
      <RegionName>Emilia Romagna</RegionName>
    </Geodata>
    .....
  </Items>
</RexApiList>

Response JSON

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
 "HasNextPage": false,
 "HasPreviousPage": false,
 "PageIndex": 1,
 "PageSize": 20,
 "TotalCount": 20,
 "TotalPageCount": 1,
 "Items": [
  {
   "CountryID": 3,
   "CountryName": "Italy",
   "RegionID": 19,
   "RegionName": "Campania"
  },
  {
   "CountryID": 3,
   "CountryName": "Italy",
   "RegionID": 23,
   "RegionName": "Liguria"
  },
  .....
 ]
}

Get provinces for a region

This method returns all provinces for a specific region.
Response is not paginated, you get all values in one call.

Call

GET integrator/{integratorID}/geodata/countries/{countryID}/regions/{regionID}/provinces

Required parameters

countryID: The ID of the country you want to return provinces from
regionID: The ID of the region you want to return provinces from

Request

GET http://rexapi.gryphtech.com/api/v1/integrator/1005001/geodata/countries/3/regions/16/provinces HTTP/1.1

Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+a", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619"
Accept: application/xml; charset=utf-8

Response XML

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8

<RexApiList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HasNextPage>false</HasNextPage>
  <HasPreviousPage>false</HasPreviousPage>
  <PageIndex>1</PageIndex>
  <PageSize>4</PageSize>
  <TotalCount>4</TotalCount>
  <TotalPageCount>1</TotalPageCount>
  <Items>
    <Geodata>
      <CountryID>3</CountryID>
      <CountryName>Italy</CountryName>
      <ProvinceID>1136</ProvinceID>
      <ProvinceName>L'Aquila</ProvinceName>
      <RegionID>16</RegionID>
      <RegionName>Abruzzo</RegionName>
    </Geodata>
    <Geodata>
      <CountryID>3</CountryID>
      <CountryName>Italy</CountryName>
      <ProvinceID>169</ProvinceID>
      <ProvinceName>Chieti</ProvinceName>
      <RegionID>16</RegionID>
      <RegionName>Abruzzo</RegionName>
    </Geodata>
    .....
  </Items>
</RexApiList>

Response JSON

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
 "HasNextPage": false,
 "HasPreviousPage": false,
 "PageIndex": 1,
 "PageSize": 4,
 "TotalCount": 4,
 "TotalPageCount": 1,
 "Items": [
  {
   "CountryID": 3,
   "CountryName": "Italy",
   "RegionID": 16,
   "RegionName": "Abruzzo",
   "ProvinceID": 171,
   "ProvinceName": "Terni"
  },
  {
   "CountryID": 3,
   "CountryName": "Italy",
   "RegionID": 16,
   "RegionName": "Abruzzo",
   "ProvinceID": 169,
   "ProvinceName": "Chieti"
  },
  .....
 ]
}

Get cities for a province

This method returns all cities for a specific province.
Response is not paginated, you get all values in one call.

Call

GET integrator/{integratorID}/geodata/countries/{countryID}/regions/{regionID}/provinces/{provinceID}/cities

Required parameters

countryID: The ID of the country you want to return cities from
regionID: The ID of the region you want to return cities from
provinceID: The ID of the province you want to return cities from

Request

GET http://rexapi.gryphtech.com/api/v1/integrator/1005001/geodata/countries/3/regions/16/provinces/171/cities HTTP/1.1

Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+a", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619"
Accept: application/xml; charset=utf-8

Response XML

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8

<RexApiList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HasNextPage>false</HasNextPage>
  <HasPreviousPage>false</HasPreviousPage>
  <PageIndex>1</PageIndex>
  <PageSize>144</PageSize>
  <TotalCount>144</TotalCount>
  <TotalPageCount>1</TotalPageCount>
  <Items>
    <Geodata>
      <CityID>102720</CityID>
      <CityName>Ancarano</CityName>
      <CountryID>3</CountryID>
      <CountryName>Italy</CountryName>
      <HasLocalZones>false</HasLocalZones>
      <ProvinceID>171</ProvinceID>
      <ProvinceName>Terni</ProvinceName>
      <RegionID>16</RegionID>
      <RegionName>Abruzzo</RegionName>
    </Geodata>
    <Geodata>
      <CityID>102727</CityID>
      <CityName>Bisenti</CityName>
      <CountryID>3</CountryID>
      <CountryName>Italy</CountryName>
      <HasLocalZones>false</HasLocalZones>
      <ProvinceID>171</ProvinceID>
      <ProvinceName>Terni</ProvinceName>
      <RegionID>16</RegionID>
      <RegionName>Abruzzo</RegionName>
    </Geodata>
    .....
  </Items>
</RexApiList>

Response JSON

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
 "HasNextPage": false,
 "HasPreviousPage": false,
 "PageIndex": 1,
 "PageSize": 144,
 "TotalCount": 144,
 "TotalPageCount": 1,
 "Items": [
  {
   "CountryID": 3,
   "CountryName": "Italy",
   "RegionID": 16,
   "RegionName": "Abruzzo",
   "ProvinceID": 171,
   "ProvinceName": "Terni",
   "CityID": 102720,
   "CityName": "Ancarano",
   "HasLocalZones": false
  },
  {
   "CountryID": 3,
   "CountryName": "Italy",
   "RegionID": 16,
   "RegionName": "Abruzzo",
   "ProvinceID": 171,
   "ProvinceName": "Terni",
   "CityID": 102727,
   "CityName": "Bisenti",
   "HasLocalZones": false
  },
  .....
 ]
}

Get local zones for a city

This method returns all local zones for a specific city.
Response is not paginated, you get all values in one call.

Call

GET integrator/{integratorID}/geodata/countries/{countryID}/regions/{regionID}/provinces/{provinceID}/cities/{cityID}/localzones

Required parameters

countryID: The ID of the country you want to return local zones from
regionID: The ID of the region you want to return local zones from
provinceID: The ID of the province you want to return local zones from
cityID: The ID of the city you want to return local zones from

Request

GET http://rexapi.gryphtech.com/api/v1/integrator/1005001/geodata/countries/3/regions/16/provinces/171/cities/98866/localzones HTTP/1.1

Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+a", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619"
Accept: application/xml; charset=utf-8

Response XML

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8

<RexApiList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HasNextPage>false</HasNextPage>
  <HasPreviousPage>false</HasPreviousPage>
  <PageIndex>1</PageIndex>
  <PageSize>27</PageSize>
  <TotalCount>27</TotalCount>
  <TotalPageCount>1</TotalPageCount>
  <Items>
    <Geodata>
      <CityID>98866</CityID>
      <CityName>Pescara</CityName>
      <CountryID>3</CountryID>
      <CountryName>Italy</CountryName>
      <HasLocalZones>true</HasLocalZones>
      <LocalZoneID>22381</LocalZoneID>
      <LocalZoneName>Pescara-Colle Innamorati</LocalZoneName>
      <ProvinceID>170</ProvinceID>
      <ProvinceName>Pescara</ProvinceName>
      <RegionID>16</RegionID>
      <RegionName>Abruzzo</RegionName>
    </Geodata>
    <Geodata>
      <CityID>98866</CityID>
      <CityName>Pescara</CityName>
      <CountryID>3</CountryID>
      <CountryName>Italy</CountryName>
      <HasLocalZones>true</HasLocalZones>
      <LocalZoneID>22399</LocalZoneID>
      <LocalZoneName>Pescara-Fontanelle</LocalZoneName>
      <ProvinceID>170</ProvinceID>
      <ProvinceName>Pescara</ProvinceName>
      <RegionID>16</RegionID>
      <RegionName>Abruzzo</RegionName>
    </Geodata>
    .....
  </Items>
</RexApiList>

Response JSON

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
 "HasNextPage": false,
 "HasPreviousPage": false,
 "PageIndex": 1,
 "PageSize": 27,
 "TotalCount": 27,
 "TotalPageCount": 1,
 "Items": [
  {
   "CountryID": 3,
   "CountryName": "Italy",
   "RegionID": 16,
   "RegionName": "Abruzzo",
   "ProvinceID": 170,
   "ProvinceName": "Pescara",
   "CityID": 98866,
   "CityName": "Pescara",
   "HasLocalZones": true,
   "LocalZoneID": 22381,
   "LocalZoneName": "Pescara-Colle Innamorati"
  },
  {
   "CountryID": 3,
   "CountryName": "Italy",
   "RegionID": 16,
   "RegionName": "Abruzzo",
   "ProvinceID": 170,
   "ProvinceName": "Pescara",
   "CityID": 98866,
   "CityName": "Pescara",
   "HasLocalZones": true,
   "LocalZoneID": 22399,
   "LocalZoneName": "Pescara-Fontanelle"
  },
  .....
 ]
}

Get geo data using multiple criteria

This method returns geo data based on multiple selection criteria.
Response is paginated, you will not get all values in one call.

Call

GET integrator/{integratorID}/geodata?page={page}&take={take}
	&geoLevel={geoLevel}&clientRegionID={clientRegionID}&countryID={countryID}
	&regionID={regionID}&provinceID={provinceID}&cityID={cityID}

Required parameters

page: Page number to be returned
take: Size of the page to be returned. Minimum 1, maximum 100

Optional parameters

geoLevel: One of following values: countries, provinces, regions, cities, localzones
clientRegionID: The ID of the Client Region you want to return geo data from
countryID: The ID of the country you want to return geo data from
regionID: The ID of the geographycal region you want to return geo data from
provinceID: The ID of the province you want to return geo data from
cityID: The ID of the city you want to return geo data from

Request

GET http://rexapi.gryphtech.com/api/v1/integrator/1005001/geodata?page=1&take=100&geoLevel=countries HTTP/1.1

Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+a", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619"
Accept: application/xml; charset=utf-8

Response XML

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8

<RexApiList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <HasNextPage>true</HasNextPage>
  <HasPreviousPage>false</HasPreviousPage>
  <PageIndex>1</PageIndex>
  <PageSize>100</PageSize>
  <TotalCount>245</TotalCount>
  <TotalPageCount>3</TotalPageCount>
  <Items>
    <Geodata>
      <CountryID>250</CountryID>
      <CountryName>Afghanistan</CountryName>
    </Geodata>
    <Geodata>
      <CountryID>53</CountryID>
      <CountryName>Albania</CountryName>
    </Geodata>
    .....
  </Items>
</RexApiList>

Response JSON

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
 "HasNextPage": true,
 "HasPreviousPage": false,
 "PageIndex": 1,
 "PageSize": 100,
 "TotalCount": 245,
 "TotalPageCount": 3,
 "Items": [
  {
   "CountryID": 250,
   "CountryName": "Afghanistan"
  },
  {
   "CountryID": 53,
   "CountryName": "Albania"
  },
  .....
 ]
}