Impact Analysis of Migrating from Geo v1 API to Geo V2 API in the Reference Data API.
Geo V2 API Functional Changes:
Functional Changes
- Active Flag Parameter - There is a parameter called active flag which is isActive if we pass true we get only active data if we pass false we get only inactive data.
- New Parameters - Search the data using RKTS, LNS code etc..
- Additional properties in response like alternative codes, aliases - minor response changes.
Non-Functional Changes
Pagination applied - Maximum 100 objects per request.
The different APIs used from GEO include.
- city-summaries
- country-summaries
- postalcode-summaries
Data Analysis like how many objects are there in v1 and how many are there in v2.
For City Summaries:
v1 → 18 attributes
v2 → 15 top level attributes + nested attributes
- parents contains 3 sub-attributes
- alternateCodes contains multiple objects with 2 attributes each
- timezone has 4 sub-attributes
- nameAliases is a list.
Key-difference
v1 has flat structure, while V2 has nested objects. (parents, alternateCodes, timezone).
For BDA
v1 attributes → 26 top-level attributes.
sub-attributes inside nested objects
- alternateNames → 4 attributes
- alternateCodes → 3 attributes
- parents → 4 attributes
- bda → 5 attributes
- bdaLocations → 6 attributes
Total count for v1:
- Top-level attributes: 23
- Nested attributes: (4 + 3 + 4 + 5 + 6) = 22
- Total attributes in V1: 45
- Total objects in V1: 5 (alternateNames, alternateCodes, parents, bdas, bdaLocations)
V2 attributes → 23 top-level attributes
sub-attributes inside nested objects
- alternateCodes → 2 attributes
- parents → 4 attributes
- alternatecode inside parents → 2 attributes
Total count for v2:
- Top-level attributes: 27
- Nested attributes: (2 + 4 + 2) = 8
- Total attributes in V2: 35
- Total objects in V2: 4 (alternateCodes, parents, subCityParents, bdas, bdaLocations)
| Version | Total Attributes | Total Objects |
|---|---|---|
| V1 | 45 | 5 |
| V2 | 35 | 4 |
For Continent Summary:
V1 Attributes → 22
- top-level attributes → 3
- sub-attributes inside search-summaries → 19
- object → 1
V2 attributes → 16
- top-level attributes → 11
- sub-attributes inside nested objects:
- alternateCodes → 4 attributes
- nameAliases → 1 attribute
- total objects → 2 (alternateCode, nameAliases)
| Version | Total Attributes | Total Objects |
|---|---|---|
| V1 | 22 | 1 |
| V2 | 16 | 2 |
For Postal Codes:
v1 Attributes → 50
top-level attributes → 28 attributes
sub-attributes
alternateNames → 4
alternateCodes → 3
parents → 4
bdas → 5
bdaLocations → 6
Total objects in v1: 1
v2
top-level attributes → 2
sub-level attributes → 30 in geography.