Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Get Locations

    Panel
    bordertrue
    borderStyledashed

    Request :

    GET  https://{lr_service}/locations/list/{level}?updatedSince={ISO8601 formatted date}&limit={limit}&offset={offset}

    Headers :

    X-Auth-Token : {auth token assigned while user registration in HRM}
    client_id : {client id of requester in Identity Service Provider}

    The level field can contain one of the following :

    1. division

    2. district

    3. upazila

    4. paurasava

    5. union

    6. ward

    js

    Sample Response :

    Expandcode
    Code Block
    language
    languagejs
    titleSample Response
    collapsetrue
    [
      {
        "code": "1020",
        "id": "1020",
        "name": "Example Location",
        "name_BN": "",
        "type": "district",
        "active": 1,
        "updatedAt": "2016-10-02 13:19:57",
        "hierarchy": [
          {
            "code": "10",
            "name": "Example Parent Location",
            "name_BN": "",
            "type": "division"
          },
          {
            "code": "20",
            "name": "Example Location",
            "name_BN": "",
            "type": "district"
          }
        ]
      }
    ]



  2. Get Single Location Information

    Panel
    bordertrue
    borderStyledashed

    Request :

    GET http://hrmtest.dghs.gov.bd/api/1.0/locations/{geoCode}.json

    Headers :

    X-Auth-Token : {auth token assigned while user registration in HRM}
    client_id : {client id of requester in Identity Service Provider}
    expandjs

    Sample Response :

    Code Block
    language
    Code Block
    language
    js
    titleSample Response
    collapsetrue
    {
        "code": "1020",
        "id": "1020",
        "name": "Example Location",
        "name_BN": "",
        "type": "district",
        "active": 1,
        "updatedAt": "2016-10-02 13:19:57",
        "hierarchy": [
          {
            "code": "10",
            "name": "Example Parent Location",
            "name_BN": "",
            "type": "division"
          },
          {
            "code": "20",
            "name": "Example Location",
            "name_BN": "",
            "type": "district"
          }
        ]
      }



BHIE

For Bangladesh, the geographical codes for locations are unique for a specific hierarchy.

...