Open APIs

 View Only

Geographic Address - components dictionaries

  • 1.  Geographic Address - components dictionaries

    Posted Jun 12, 2023 03:48
    Edited by Tomasz Ruchała Jun 12, 2023 03:48

    Hi all,

    I have a question regarding dictionaries for Geographic Address fields.
    On the Geographic Adress entity, we store components as text, but of course, some of the fields can have values from a closed list of values.

    Is TM forum specified what entity should be used to provide valid values for these fields? Or does not impose anything here?
    Will it be ok to use a Geographic Address for this purpose (e.g. Their own Geographic Address Id for city/street name) or it should be some separate entity?


    Context:
    There are a few possibilities for specified Geographic addresses:
    1. Choose a Location from the presented map
    System presents a map with Locations (e.g. Store)
    Users can choose one of the presented Location
    System based on the relation between Geographic Location and Geographic Address determines what Groagraphid Address was chosen.

    2. Type an address in the free text field
    Users can type in free text some part of the address (e.g. Street, building number).
    The system presents some Geographic Addresses that match the typed text. 
    Users can choose one of the Geographic Addresses from the hints list.

    3. Type all address fields separately.
    Some fields can be free text/number, but some of them can be a closed list of values (e.g. city/street name).
    This is of course possible only if we store or have some integration with a system that contains all possible combinations.
    In this case, we must expose to the customer these values. Is Open API suggest here some type of entity?


    Analyse based on available TM forum materials:

    TMF673_Geographic_Address_Management_API_User_Guide_v4.0.0.pdf
    "Finally, it can be used to look for a geographic address by: searching an area as a start (city, town …), then zooming
    on the streets of this area, and finally listing all the street segments (numbers) in a street."

    TMF620_Product_Catalog_Management_API_REST_Specification_v4-1-0.pdf
      "place": [
        {
          "id": "9979",
          "href": "https://mycsp.com:8080/tmf-api/geographicAddressManagement/v4/geographicAddress/9979",
          "name": "San Francisco Bay Area",
          "@referredType": "GeographicAddress",
          "@type": "PlaceRef",
          "@baseType": "",
          "@schemaLocation": "https://mycsp.com:8080/tmf-api/schemas/Common/PlaceRef.schema.json"
        }
      ]

    It looks like the Geographic address may be also some Region, not always a detailed address with Street name and number. Maybe also cities or streets can have their own Geographic Address id?



    ------------------------------
    Tomasz Ruchała
    Comarch S.A.
    ------------------------------