Directory Listing
Get Directory listing by Level
Returns list of directories at a given level in the Map Repository. The Map Repository has two directories at the root level:
- Standard Maps: These are those maps which are either based on the M49 Area coding convention or any DevInfo adaptation hosted on www.devinfo.org catalog which is not following M49 coding.
- Non-Standard Maps: These are those maps which are not based on M49 Area coding convention and are also not available on www.devinfo.org catalog. In a rare case it may be true that a DevInfo adaptation maybe available on www.devinfo.org catalog but is still part of the non-standard maps. This would be the case when there are similar Areas in the Standard Maps folder strucutre with the M49 coding convention being followed.
GET: {App Key}/directories/level/{Level Number}
| Parameter | Required | Description |
|---|---|---|
| App Key | Yes | This is the application key used for accessing API. |
| Level Number | No | When level number is not present the API would return all the directories present under the root folder. |
INPUT:
{{hostUrl}}{App Key}/directories/level/2
OUTPUT:
Get Directory listing by folder path
Returns list of directories under a given folder path.
GET: {App Key}/directories/sub/{Folder Path}
| Parameter | Required | Description |
|---|---|---|
| App Key | Yes | This is the application key used for accessing API. |
| FolderPath | Yes | Folder path of the directory for which the sub directories are required. |
INPUT:
{{hostUrl}}{App Key}/directories/sub/1SPDML Standard Maps/1SMREG Regions
OUTPUT:
Get Maps
Get Maps under a given folder path
Returns all the maps present under a given folder path.
GET: {App Key}/getmaps/{Folder Path}
| Parameter | Required | Description |
|---|---|---|
| App Key | Yes | This is the application key used for accessing API. |
| Folder Path | Yes | Folder path of the directory for which the maps are required. |
INPUT:
{{hostUrl}}{appKey}/getmaps/1SPDML Standard Maps/1SMREG Regions/IND India
OUTPUT:
Get GeoJSON for a given Map
Returns the geoJSON object for a given map present under a given folder path.
GET: {App Key}/getmap/geojson/{Folder Path}/{Map Name}
| Parameter | Required | Description |
|---|---|---|
| App Key | Yes | This is the application key used for accessing API. |
| Folder Path | Yes | Folder path of the directory which contains the map file. |
| Map Name | Yes | Name of the Map under a given FolderPath whose geoJSON is required. |
INPUT:
{{hostUrl}}{App Key}/getmap/geojson/1SPDML Standard Maps/1SMREG Regions/IND India/ind l02 2011-3000 national.json
OUTPUT:
Get GeoJSON for a given Area and Time Period
Returns the geoJSON object for a given Area and Time Period present under a given folder path.
GET: {App Key}/getmap/geojson-tp/areaid={Area ID}/tp={Time Period}/arealvl={Area Level}/{Folder Path}
| Parameter | Required | Description |
|---|---|---|
| App Key | Yes | This is the application key used for accessing API. |
| Area ID | Yes | Area ID for which the map needs to be retrieved. |
| Time Period | Yes | Time Period for which the Map is required. |
| Area Level | No | Area Level for the Area for which the map needs to be retrieved. |
| Folder Path | Yes | Folder path of the directory which contains the map file. |
INPUT:
{{hostUrl}}{App Key}/getmap/geojson-tp/areaid=ind/tp=2013/arealvl=3/1SPDML Standard Maps/1SMREG Regions/IND India
OUTPUT:
Get Drilled down map
Returns the relevant map for the drilled down area id.
GET: {App Key}/getmap/drill/areaid={Area ID}/tp={Time Period}/{Folder Path}
| Parameter | Required | Description |
|---|---|---|
| App Key | Yes | This is the application key used for accessing API. |
| Folder Path | Yes | Folder path of the directory which contains the current map file. |
| Area ID | Yes | Area ID of the drill down map being requested. |
| Time Period | No | Time period for the drill down map being requested. |
INPUT:
{{hostUrl}}{App Key}/getmap/drill/areaid=IND029/tp=/1SPDML Standard Maps/1SMREG Regions/IND India
OUTPUT:
Extras
Get Areas for a given Map
Returns the list of area present in a given map present under a given folder path.
GET: {App Key}/getmap/arealist/{Folder Path}/{Map Name}
| Parameter | Required | Description |
|---|---|---|
| App Key | Yes | This is the application key used for accessing API. |
| Folder Path | Yes | Folder path of the directory which contains the map file. |
| Map Name | Yes | Name of the Map under a given FolderPath whose geoJSON is required. |
INPUT:
{{hostUrl}}/{App Key}/getmap/arealist/1SPDML Standard Maps/1SMREG Regions/IND India/ind 03 2011-2013 subnational1.json
OUTPUT:
Search Maps under a given folder
Returns all the maps present under the folder path, if the current map is not found entire map repository is searched for the most relevant map.
GET: {App Key}/directories/search/{Keyword}/{Folder Path}
| Parameter | Required | Description |
|---|---|---|
| App Key | Yes | This is the application key used for accessing API. |
| Folder Path | Yes | Folder path of the directory in which the map files are to be searched. |
| Keyword | Yes | Keyword used to search map. |
INPUT:
{{hostUrl}}{App Key}/directories/search/ind/1SPDML Standard Maps/1SMREG Regions
OUTPUT:
