{"openapi":"3.1.0","info":{"title":"Mappls generation-aware API contract atlas","version":"2026-08-16","description":"A source-derived interoperability document for the Mappls contract catalog. OpenAPI paths contain the preferred version-labelled source declaration because the standard cannot represent multiple operations with the same method and path. Every retained variant and migration comparison remains available in x-mappls-contract-generations. Preferred source evidence is not proof of support, entitlement, compatibility, or availability.","termsOfService":"https://about.mappls.com/api/terms-%26-conditions","contact":{"name":"Mappls","url":"https://about.mappls.com/contact-us"}},"externalDocs":{"description":"Mappls Developer Platform","url":"https://developer.mappls.com/api-reference"},"tags":[{"name":"Core Maps, Search & Routing","description":"21 normalized stateless operations · legacy-source"},{"name":"InTouch Telematics","description":"53 normalized stateful operations · legacy-source"},{"name":"Workmate Workforce","description":"13 normalized stateful operations · legacy-source"},{"name":"SkyDNN AI & Vision","description":"4 normalized hybrid operations · current-source"},{"name":"Geo-Analytics Listing","description":"1 normalized stateless operations · legacy-source"},{"name":"mGIS Analytics","description":"53 normalized stateful operations · source-snapshot"},{"name":"Mappls AI / ML","description":"17 normalized hybrid operations · source-snapshot"}],"paths":{"/api/places/woodpecker":{"get":{"operationId":"core-location-get-api-places-woodpecker-address-standardization-api","summary":"Address Standardization API","description":"Address Standardization API is a process to convert the non formatted address into the user readable format by omitting unnecessary information in the address. MapmyIndia address standardization API provides real addresses along with admin and other information. This APIs follow OAuth2 based security. To know more on how to create your authorization tokens, please use our authorization token URL. More details available here. Live Demo","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://atlas.mapmyindia.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-api-places-woodpecker-address-standardization-api"},"parameters":[{"name":"address","in":"query","required":true,"description":"The full human readable address that needs to be standardized","schema":{"type":"string","description":"The full human readable address that needs to be standardized","example":"237 Okhla industrial estate phase 3 new Delhi, Delhi 110020"}},{"name":"bias","in":"query","required":false,"description":"parameter value can be set to get the bias result towards the urban or rural side. (Default is 1.5 : urban). Where 1 is neutral and 1 is Urban biased.","schema":{"type":"number","description":"parameter value can be set to get the bias result towards the urban or rural side. (Default is 1.5 : urban). Where 1 is neutral and 1 is Urban biased.","example":1.5}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"inputAddress":{"type":"string","description":"this is the address entered by the user.","example":"237, MapmyIndia Head Office, Okhla Phase 3, New Delhi, Delhi 110010","x-mappls-field-path":"inputAddress"},"remainingAddress":{"type":"string","description":"this is the address striked out by the API.","example":"mapmyindia head office, okhla new","x-mappls-field-path":"remainingAddress"},"referentialInformation":{"type":"object","example":"example","x-mappls-field-path":"referentialInformation"},"referentialInformation.pincodes":{"type":"string","description":"PIN code tagged from input address if found any.","example":"110010","x-mappls-field-path":"referentialInformation.pincodes"},"referentialInformation.floors":{"type":"string","description":"Floor info tagged from input address if found any.","example":"Floor No 1","x-mappls-field-path":"referentialInformation.floors"},"referentialInformation.roads":{"type":"string","description":"Road tagged from the input address if found any.","example":"Okhla Road","x-mappls-field-path":"referentialInformation.roads"},"referentialInformation.postOffices":{"type":"string","description":"Post offices tagged from the input address if found any.","x-mappls-field-path":"referentialInformation.postOffices"},"referentialInformation.careOfs":{"type":"string","description":"Care of (C/O) tagged from the input address if found any.","x-mappls-field-path":"referentialInformation.careOfs"},"referentialInformation.landmarks":{"type":"string","description":"Landmark tagged from the input address if found any.","x-mappls-field-path":"referentialInformation.landmarks"},"referentialInformation.houseNumbers":{"type":"object","description":"House number information tagged from the input address if found any.","example":"example","x-mappls-field-path":"referentialInformation.houseNumbers"},"referentialInformation.houseNumbers.prefix":{"type":"string","x-mappls-field-path":"referentialInformation.houseNumbers.prefix"},"referentialInformation.houseNumbers.houseNo":{"type":"string","example":"237","x-mappls-field-path":"referentialInformation.houseNumbers.houseNo"},"referentialInformation.houseNumbers.formatted":{"type":"string","example":"237","x-mappls-field-path":"referentialInformation.houseNumbers.formatted"},"addressInformation":{"type":"object","example":"example","x-mappls-field-path":"addressInformation"},"addressInformation.adminDetails":{"type":"object","example":"example","x-mappls-field-path":"addressInformation.adminDetails"},"addressInformation.adminDetails.state":{"type":"object","example":"1700000000000","x-mappls-field-path":"addressInformation.adminDetails.state"},"addressInformation.adminDetails.state.originalName":{"type":"string","example":"Delhi","x-mappls-field-path":"addressInformation.adminDetails.state.originalName"},"addressInformation.adminDetails.locality":{"type":"object","example":"example","x-mappls-field-path":"addressInformation.adminDetails.locality"},"addressInformation.adminDetails.locality.originalName":{"type":"string","example":"New Moti Nagar","x-mappls-field-path":"addressInformation.adminDetails.locality.originalName"},"addressInformation.adminDetails.city":{"type":"object","example":"example","x-mappls-field-path":"addressInformation.adminDetails.city"},"addressInformation.adminDetails.city.originalName":{"type":"string","example":"New Delhi","x-mappls-field-path":"addressInformation.adminDetails.city.originalName"},"addressInformation.adminDetails.sublocality":{"type":"object","example":"example","x-mappls-field-path":"addressInformation.adminDetails.sublocality"},"addressInformation.adminDetails.sublocality.originalName":{"type":"string","example":"Phase 3","x-mappls-field-path":"addressInformation.adminDetails.sublocality.originalName"},"addressInformation.adminDetails.subsublocality":{"type":"object","example":"example","x-mappls-field-path":"addressInformation.adminDetails.subsublocality"},"addressInformation.adminDetails.subsublocality.originalName":{"type":"string","example":"Okhla","x-mappls-field-path":"addressInformation.adminDetails.subsublocality.originalName"},"addressInformation.adminPattern":{"type":"array","items":{"type":"string"},"example":["state","city","locality","subLocality"],"x-mappls-field-path":"addressInformation.adminPattern"}},"required":["inputAddress","remainingAddress","referentialInformation","referentialInformation.pincodes","referentialInformation.floors","referentialInformation.roads","referentialInformation.postOffices","referentialInformation.careOfs","referentialInformation.landmarks","referentialInformation.houseNumbers","referentialInformation.houseNumbers.prefix","referentialInformation.houseNumbers.houseNo","referentialInformation.houseNumbers.formatted","addressInformation","addressInformation.adminDetails","addressInformation.adminDetails.state","addressInformation.adminDetails.state.originalName","addressInformation.adminDetails.locality","addressInformation.adminDetails.locality.originalName","addressInformation.adminDetails.city","addressInformation.adminDetails.city.originalName","addressInformation.adminDetails.sublocality","addressInformation.adminDetails.sublocality.originalName","addressInformation.adminDetails.subsublocality","addressInformation.adminDetails.subsublocality.originalName","addressInformation.adminPattern"]},"example":{"inputAddress":"237, MapmyIndia Head Office, Okhla Phase 3, New Delhi, Delhi 110010","remainingAddress":"mapmyindia head office, okhla new","referentialInformation":{"pincodes":"110010","floors":"Floor No 1","roads":"Okhla Road","postOffices":"","careOfs":"","landmarks":"","houseNumbers":{"prefix":"","houseNo":"237","formatted":"237"}},"addressInformation":{"adminDetails":{"state":{"originalName":"Delhi"},"locality":{"originalName":"New Moti Nagar"},"city":{"originalName":"New Delhi"},"sublocality":{"originalName":"Phase 3"},"subsublocality":{"originalName":"Okhla"}},"adminPattern":["state","city","locality","subLocality"]}}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/woodpecker.yml","x-mappls-source-fingerprint":"3f28b55a402736d962c9a4249a77738d2435dc61d2274164b43e440892aee908","x-mappls-evidence-score":35,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-api-places-woodpecker-690bbb30d1","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/api/places/search/json":{"get":{"operationId":"core-location-get-api-places-search-json-autosuggest-api","summary":"AutoSuggest API","description":"The Autosuggest API helps users to complete queries faster by adding intelligent search capabilities to your web or mobile app. This API returns a list of results as well as suggested queries as the user types in the search field. This API also supports Hindi language. If a user enters query in hindi language he will get results in Hindi. This APIs follow OAuth2 based security. To know more on how to create your authorization tokens, please use our authorization token URL. More details available here. Live Demo | Download Sample Code","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://atlas.mapmyindia.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-api-places-search-json-autosuggest-api"},"parameters":[{"name":"query","in":"query","required":true,"description":"Enter the query on which the search has to be done.","schema":{"type":"string","description":"Enter the query on which the search has to be done.","example":"mapmyindia"}},{"name":"location","in":"query","required":false,"description":"Location is required to get location biased autosuggest results.","schema":{"type":"string","description":"Location is required to get location biased autosuggest results.","example":"28.612964,77.229463"}},{"name":"region","in":"query","required":false,"description":"It takes in the country code. Possible values are listed in a table here. Default is India (IND).","schema":{"type":"string","description":"It takes in the country code. Possible values are listed in a table here. Default is India (IND).","example":"IND"}},{"name":"tokenizeAddress","in":"query","required":false,"description":"It is the valueless parameter provides the different address attributes in a structured object.","schema":{"type":"boolean","description":"It is the valueless parameter provides the different address attributes in a structured object.","example":"YOUR_ACCESS_TOKEN"}},{"name":"pod","in":"query","required":false,"description":"It takes in the place type code which helps in restricting the results to certain chosen type. This optional parameter & its related effect on response is not applicable for regions apart from India (IND). Below mentioned are the codes for the pod: SLC: Sublocality LC: Locality CITY: City VLG: Village SDIST: Subdistrict DIST: District STATE: State SSLC: Subsublocality","schema":{"type":"string","description":"It takes in the place type code which helps in restricting the results to certain chosen type. This optional parameter & its related effect on response is not applicable for regions apart from India (IND). Below mentioned are the codes for the pod: SLC: Sublocality LC: Locality CITY: City VLG: Village SDIST: Subdistrict DIST: District STATE: State SSLC: Subsublocality","example":"CITY"}},{"name":"filter","in":"query","required":false,"description":"This parameter helps you restrict the result either by mentioning a bounded area or to certain eloc (6 digit code to any poi, locality, city, etc.). This optional parameter & its related effect on response is not applicable for regions apart from India (IND). Below mentioned are the available types: filter = pin:It takes pincode/postal code of an area{e.g. filter=pin:110055} filter = bounds lat1,lng1;lat2,lng2(latitude,longitude){e.g. filter=bounds 28.598882, 77.212407; 28.467375, 77.353513} filter = cop {eloc} (string) {e.g. filter=cop:YMCZ0J}","schema":{"type":"string","description":"This parameter helps you restrict the result either by mentioning a bounded area or to certain eloc (6 digit code to any poi, locality, city, etc.). This optional parameter & its related effect on response is not applicable for regions apart from India (IND). Below mentioned are the available types: filter = pin:It takes pincode/postal code of an area{e.g. filter=pin:110055} filter = bounds lat1,lng1;lat2,lng2(latitude,longitude){e.g. filter=bounds 28.598882, 77.212407; 28.467375, 77.353513} filter = cop {eloc} (string) {e.g. filter=cop:YMCZ0J}","example":"pin:110001"}},{"name":"bridge","in":"query","required":false,"description":"(Valueless)It initiates a bridge to be created to provide applicable nearby API searches in the suggestedSearches response object. This optional parameter & its related effect on response is not applicable for regions apart from India (IND).","schema":{"type":"boolean","description":"(Valueless)It initiates a bridge to be created to provide applicable nearby API searches in the suggestedSearches response object. This optional parameter & its related effect on response is not applicable for regions apart from India (IND).","example":"true"}},{"name":"hyperLocal","in":"query","required":false,"description":"(valueless): This parameter lets the search give results that are hyper-localized to the reference location passed in the location parameter. This means that nearby results are given higher ranking than results far from the reference location. Highly prominent results will still appear in the search results, however they will be lower in the list of results. This parameter will work ONLY in conjunction with the location parameter. This optional parameter & its related effect on response is not applicable for regions apart from India (IND).","schema":{"type":"boolean","description":"(valueless): This parameter lets the search give results that are hyper-localized to the reference location passed in the location parameter. This means that nearby results are given higher ranking than results far from the reference location. Highly prominent results will still appear in the search results, however they will be lower in the list of results. This parameter will work ONLY in conjunction with the location parameter. This optional parameter & its related effect on response is not applicable for regions apart from India (IND).","example":"true"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"suggestedLocations":{"type":"array","items":{"type":"object"},"example":"28.612964,77.229463","x-mappls-field-path":"suggestedLocations"},"suggestedLocations[].type":{"type":"string","description":"This is the type whether the results is POI or any building point.","example":"POI","x-mappls-field-path":"suggestedLocations[].type"},"suggestedLocations[].typeX":{"type":"integer","description":"Type attribute for internal use only for MapmyIndia.","example":7,"x-mappls-field-path":"suggestedLocations[].typeX"},"suggestedLocations[].placeAddress":{"type":"string","description":"Address of the location.","example":"Yippee Rooms, Sector 56, Gurugram, Haryana, 122011","x-mappls-field-path":"suggestedLocations[].placeAddress"},"suggestedLocations[].latitude":{"type":"number","description":"It shows us the latitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"suggestedLocations[].latitude"},"suggestedLocations[].longitude":{"type":"number","description":"It shows us the longitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"suggestedLocations[].longitude"},"suggestedLocations[].eLoc":{"type":"string","description":"It is the Six or eight digit unique code offered only by mapmyindia to search for any address through this eLoc.","example":"MMI000","x-mappls-field-path":"suggestedLocations[].eLoc"},"suggestedLocations[].entryLatitude":{"type":"number","description":"It shows us the entry latitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"suggestedLocations[].entryLatitude"},"suggestedLocations[].entryLongitude":{"type":"number","description":"It shows us the entry longitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"suggestedLocations[].entryLongitude"},"suggestedLocations[].placeName":{"type":"string","description":"This shows the name of the POI","example":"OYO Hotel","x-mappls-field-path":"suggestedLocations[].placeName"},"suggestedLocations[].alternateName":{"type":"string","description":"This shows the alternate name of the POI","example":"OyoRooms,OYO 40400 Yippe Rooms,OYO Rooms Hotel","x-mappls-field-path":"suggestedLocations[].alternateName"},"suggestedLocations[].keywords":{"type":"array","items":{"type":"object"},"description":"The keywords/category codes associated with the given result.","example":"example","x-mappls-field-path":"suggestedLocations[].keywords"},"suggestedLocations[].addressTokens":{"type":"object","example":"YOUR_ACCESS_TOKEN","x-mappls-field-path":"suggestedLocations[].addressTokens"},"suggestedLocations[].addressTokens.houseNumber":{"type":"string","description":"House Number of the POI.","example":"237","x-mappls-field-path":"suggestedLocations[].addressTokens.houseNumber"},"suggestedLocations[].addressTokens.houseName":{"type":"string","description":"House Name of the POI.","example":"MMI Building","x-mappls-field-path":"suggestedLocations[].addressTokens.houseName"},"suggestedLocations[].addressTokens.poi":{"type":"string","description":"Name of the POI.","example":"MapmyIndia Head Office","x-mappls-field-path":"suggestedLocations[].addressTokens.poi"},"suggestedLocations[].addressTokens.street":{"type":"string","description":"Name of the street.","x-mappls-field-path":"suggestedLocations[].addressTokens.street"},"suggestedLocations[].addressTokens.subSubLocality":{"type":"string","description":"Name of the subsublocality.","x-mappls-field-path":"suggestedLocations[].addressTokens.subSubLocality"},"suggestedLocations[].addressTokens.subLocality":{"type":"string","description":"Name of the sublocality.","x-mappls-field-path":"suggestedLocations[].addressTokens.subLocality"},"suggestedLocations[].addressTokens.locality":{"type":"string","description":"Name of the locality.","example":"Okhla industrial phase 3","x-mappls-field-path":"suggestedLocations[].addressTokens.locality"},"suggestedLocations[].addressTokens.village":{"type":"string","description":"Name of the village.","example":"Okhla Vilage","x-mappls-field-path":"suggestedLocations[].addressTokens.village"},"suggestedLocations[].addressTokens.subDistrict":{"type":"string","description":"Name of the subDistrict.","x-mappls-field-path":"suggestedLocations[].addressTokens.subDistrict"},"suggestedLocations[].addressTokens.district":{"type":"string","description":"Name of the District.","example":"South Delhi","x-mappls-field-path":"suggestedLocations[].addressTokens.district"},"suggestedLocations[].addressTokens.city":{"type":"string","description":"Name of the city.","example":"New Delhi","x-mappls-field-path":"suggestedLocations[].addressTokens.city"},"suggestedLocations[].addressTokens.state":{"type":"string","description":"Name of the STATE.","example":"1700000000000","x-mappls-field-path":"suggestedLocations[].addressTokens.state"},"suggestedLocations[].addressTokens.pincode":{"type":"integer","description":"PINcode of the location.","example":"110010","x-mappls-field-path":"suggestedLocations[].addressTokens.pincode"},"suggestedLocations[].p":{"type":"integer","description":"This shows the priority of the POI","example":11663,"x-mappls-field-path":"suggestedLocations[].p"},"suggestedLocations[].orderIndex":{"type":"integer","description":"This shows the order of the search results priority wise.","example":1,"x-mappls-field-path":"suggestedLocations[].orderIndex"},"suggestedLocations[].score":{"type":"number","description":"This shows the score of the POI.","example":1.5075794782130676,"x-mappls-field-path":"suggestedLocations[].score"},"suggestedLocations[].suggester":{"type":"string","description":"This shows on which basis the search results has been found.","example":"alternateName","x-mappls-field-path":"suggestedLocations[].suggester"},"suggestedLocations[].richInfo":{"type":"array","items":{"type":"object"},"description":"This shows the rich info associated with the given result.","x-mappls-field-path":"suggestedLocations[].richInfo"},"userAddedLocation":{"type":"array","items":{"type":"object"},"example":"28.612964,77.229463","x-mappls-field-path":"userAddedLocation"},"userAddedLocation[].eLoc":{"type":"string","description":"It is the Six or eight digit unique code offered only by mapmyindia to search for any address through this eLoc.","example":"MMI000","x-mappls-field-path":"userAddedLocation[].eLoc"},"userAddedLocation[].entryLatitude":{"type":"number","description":"latitude of the entrance of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"userAddedLocation[].entryLatitude"},"userAddedLocation[].entryLongitude":{"type":"number","description":"longitude of the entrance of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"userAddedLocation[].entryLongitude"},"userAddedLocation[].latitude":{"type":"number","description":"It shows us the latitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"userAddedLocation[].latitude"},"userAddedLocation[].longitude":{"type":"number","description":"It shows us the longitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"userAddedLocation[].longitude"},"userAddedLocation[].orderIndex":{"type":"integer","description":"This shows the order of the search results priority wise.","example":1,"x-mappls-field-path":"userAddedLocation[].orderIndex"},"userAddedLocation[].placeAddress":{"type":"string","description":"This is the address of the text searched by you.","example":"Yippee Rooms, Sector 56, Gurugram, Haryana, 122011","x-mappls-field-path":"userAddedLocation[].placeAddress"},"userAddedLocation[].placeName":{"type":"string","description":"This shows the name of the POI.","example":"OYO Hotel","x-mappls-field-path":"userAddedLocation[].placeName"},"userAddedLocation[].resultType":{"type":"string","description":"It Shows the the category of result falling into. For eg. UAP","example":"UAP","x-mappls-field-path":"userAddedLocation[].resultType"},"userAddedLocation[].type":{"type":"string","x-mappls-field-path":"userAddedLocation[].type"},"userAddedLocation[].userName":{"type":"string","description":"It shows the UserID of the person who added the location.","example":"usr1577100139i799918080","x-mappls-field-path":"userAddedLocation[].userName"},"suggestedSearches":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"suggestedSearches"},"suggestedSearches[].keyword":{"type":"string","description":"It shows the result keyword","example":"corona testing lab","x-mappls-field-path":"suggestedSearches[].keyword"},"suggestedSearches[].identifier":{"type":"string","description":"on what basis the results shown","example":"near","x-mappls-field-path":"suggestedSearches[].identifier"},"suggestedSearches[].location":{"type":"string","description":"location near the results are shown","example":"28.612964,77.229463","x-mappls-field-path":"suggestedSearches[].location"},"suggestedSearches[].hyperlink":{"type":"string","description":"direct link of the poi.","example":"https://atlas.mapmyindia.com/api/places/nearby/json?explain&richData&username=atlasuser&refLocation=28.550592,77.26877&keywords=hsptst","x-mappls-field-path":"suggestedSearches[].hyperlink"},"suggestedSearches[].orderIndex":{"type":"integer","description":"This shows the order of the search results priority wise.","example":0,"x-mappls-field-path":"suggestedSearches[].orderIndex"},"suggestedSearches[].eLoc":{"type":"string","description":"It is the Six or eight digit unique code offered only by mapmyindia to search for any address through this eLoc.","example":"MMI000","x-mappls-field-path":"suggestedSearches[].eLoc"},"lang":{"type":"string","description":"Used to indicate if the response is in some language other than the default(which is en). Valid values are hi, which indicates Hindi response.","example":"hi","x-mappls-field-path":"lang"}},"required":["suggestedLocations","suggestedLocations[].type","suggestedLocations[].typeX","suggestedLocations[].placeAddress","suggestedLocations[].latitude","suggestedLocations[].longitude","suggestedLocations[].eLoc","suggestedLocations[].entryLatitude","suggestedLocations[].entryLongitude","suggestedLocations[].placeName","suggestedLocations[].alternateName","suggestedLocations[].keywords","suggestedLocations[].addressTokens","suggestedLocations[].addressTokens.district","suggestedLocations[].addressTokens.city","suggestedLocations[].addressTokens.state","suggestedLocations[].p","suggestedLocations[].orderIndex","suggestedLocations[].score","suggestedLocations[].suggester","suggestedLocations[].richInfo","userAddedLocation","userAddedLocation[].eLoc","userAddedLocation[].entryLatitude","userAddedLocation[].entryLongitude","userAddedLocation[].latitude","userAddedLocation[].longitude","userAddedLocation[].orderIndex","userAddedLocation[].placeAddress","userAddedLocation[].placeName","userAddedLocation[].resultType","userAddedLocation[].type","userAddedLocation[].userName","suggestedSearches","suggestedSearches[].keyword","suggestedSearches[].identifier","suggestedSearches[].location","suggestedSearches[].hyperlink","suggestedSearches[].orderIndex","suggestedSearches[].eLoc","lang"]},"example":{"suggestedLocations":[{"type":"POI","typeX":7,"placeAddress":"Yippee Rooms, Sector 56, Gurugram, Haryana, 122011","latitude":"RESTRICTED","longitude":"RESTRICTED","eLoc":"2LH9OC","entryLatitude":"RESTRICTED","entryLongitude":"RESTRICTED","placeName":"OYO Hotel","alternateName":"OyoRooms,OYO 40400 Yippe Rooms,OYO Rooms Hotel","keywords":["FINATM"],"addressTokens":{"district":"South Delhi","city":"New Delhi","state":"Delhi"},"p":11663,"orderIndex":1,"score":1.5075794782130676,"suggester":"alternateName","richInfo":""}],"userAddedLocation":[{"eLoc":"2LH9OC","entryLatitude":"RESTRICTED","entryLongitude":"RESTRICTED","latitude":"RESTRICTED","longitude":"RESTRICTED","orderIndex":1,"placeAddress":"Yippee Rooms, Sector 56, Gurugram, Haryana, 122011","placeName":"OYO Hotel","resultType":"UAP","type":"","userName":"usr1577100139i799918080"}],"suggestedSearches":[{"keyword":"corona testing lab","identifier":"near","location":"me","hyperlink":"https://atlas.mapmyindia.com/api/places/nearby/json?explain&richData&username=atlasuser&refLocation=28.550592,77.26877&keywords=hsptst","orderIndex":0,"eLoc":"null"}],"lang":"hi"}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/autosuggest.yml","x-mappls-source-fingerprint":"853e2a51f94cc6cc10291bdfdfbd49d57c6cbe56b91a8ab7893a66639a595cf4","x-mappls-evidence-score":66,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-api-places-search-json-7661a987fe","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{rest-key}/{resources}/{profile}/{geopositions}":{"get":{"operationId":"core-location-get-rest-key-resources-profile-geopositions-distance-matrix-api","summary":"Distance Matrix API","description":"This REST API computes the distance and durations in a matrix of routes between a set of source/primary positions (geographical coordinates) and a set of all supplied secondary positions. Please note that maximum number of points are limited to 100 only including source and secondary positions. Live Demo | Download Sample Code","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-rest-key-resources-profile-geopositions-distance-matrix-api"},"parameters":[{"name":"rest-key","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}},{"name":"resources","in":"path","required":true,"description":"The different resources available within MapmyIndia Distance Matrix API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources distancematrix to calculate a route & its duration without considering traffic conditions. distancematrixeta to get the updated duration of a route considering live traffic; Applicable for India only “region=ind” and “rtype=1” is not supported. This is different from distancematrixtraffic ; this resource balances between a preferred path and aggressive traffic","schema":{"type":"string","description":"The different resources available within MapmyIndia Distance Matrix API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources distancematrix to calculate a route & its duration without considering traffic conditions. distancematrixeta to get the updated duration of a route considering live traffic; Applicable for India only “region=ind” and “rtype=1” is not supported. This is different from distancematrixtraffic ; this resource balances between a preferred path and aggressive traffic","enum":["distance_matrix","distance_matrix_eta","distance_matrix_traffic"],"example":"distance_matrix_eta"}},{"name":"profile","in":"path","required":true,"description":"The different profiles available within MapmyIndia Distance Matrix API. These profiles have their own individual transport modes and not all are allocated for evalulations be default. For allocating particular profiles on your API credentials, please contact apisupport@mapmyindia.com Table 2. Profiles Element Value Description Profiles driving Meant for 4-wheeler/passenger car routing. biking Meant for two-wheeler routing. Routing with this profile is restricted to distancematrix only. region & rtype request parameters are not supported in two-wheeler routing. walking Meant for pedestrian routing. Routing with this profile is restricted to distancematrix only. region & rtype request paramete","schema":{"type":"string","description":"The different profiles available within MapmyIndia Distance Matrix API. These profiles have their own individual transport modes and not all are allocated for evalulations be default. For allocating particular profiles on your API credentials, please contact apisupport@mapmyindia.com Table 2. Profiles Element Value Description Profiles driving Meant for 4-wheeler/passenger car routing. biking Meant for two-wheeler routing. Routing with this profile is restricted to distancematrix only. region & rtype request parameters are not supported in two-wheeler routing. walking Meant for pedestrian routing. Routing with this profile is restricted to distancematrix only. region & rtype request paramete","enum":["driving","biking","walking","trucking"],"example":"driving"}},{"name":"geopositions","in":"path","required":true,"description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be considered as origin point (mandatory); and rest of the geopositions will be considered as destination points (mandatory). Example: 77.983936,28.255904;77.05993,28.487555 OR mmi000 . Geoposition separator is a semicolon ; .","schema":{"type":"string","description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be considered as origin point (mandatory); and rest of the geopositions will be considered as destination points (mandatory). Example: 77.983936,28.255904;77.05993,28.487555 OR mmi000 . Geoposition separator is a semicolon ; .","example":"28.612964,77.229463"}},{"name":"sources","in":"query","required":false,"description":"To specify which of the coordinates supplied in the URL are to be treated as source position for many to many distance matrix calculation, indicate that coordinate pair's index. E.g. 0;1 means that 0th and 1st coordinate pairs are source points. Default value is 0 . The indexes must be semi-colon separated. e.g: 0;1;2;...","schema":{"type":"string","description":"To specify which of the coordinates supplied in the URL are to be treated as source position for many to many distance matrix calculation, indicate that coordinate pair's index. E.g. 0;1 means that 0th and 1st coordinate pairs are source points. Default value is 0 . The indexes must be semi-colon separated. e.g: 0;1;2;...","example":"0;1;2"}},{"name":"rtype","in":"query","required":false,"description":"type of route (integer) required for navigation, where values mean: 0 optimal (default) 1 shortest (it will calculate route by excluding access penalties like private roads, etc.)","schema":{"type":"integer","description":"type of route (integer) required for navigation, where values mean: 0 optimal (default) 1 shortest (it will calculate route by excluding access penalties like private roads, etc.)","enum":[0,1],"example":0}},{"name":"destinations","in":"query","required":false,"description":"To specify which of the coordinates supplied in the URL are to be treated as destination position for many to many distance matrix calculation, indicate that coordinate pair's index. E.g. 2;3 means that 0th and 1st coordinate pairs are destination points. Default value is all . The indexes must be semi-colon separated. e.g: 3;4;5;...","schema":{"type":"string","description":"To specify which of the coordinates supplied in the URL are to be treated as destination position for many to many distance matrix calculation, indicate that coordinate pair's index. E.g. 2;3 means that 0th and 1st coordinate pairs are destination points. Default value is all . The indexes must be semi-colon separated. e.g: 3;4;5;...","example":"3;4;5"}},{"name":"region","in":"query","required":false,"description":"This parameter is optional for India; for other countries (such as Sri Lanka, Nepal, Bangladesh, Bhutan + many more) this parameter is mandatory. Possible values are listed in a table here.","schema":{"type":"string","description":"This parameter is optional for India; for other countries (such as Sri Lanka, Nepal, Bangladesh, Bhutan + many more) this parameter is mandatory. Possible values are listed in a table here.","example":"IND"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"Server":{"type":"string","description":"Gives Information on active service's server.","example":"ETA-5100","x-mappls-field-path":"Server"},"version":{"type":"string","description":"API’s version information.","example":"250.19.5222","x-mappls-field-path":"version"},"responseCode":{"type":"integer","description":"See the service dependent and general status codes","example":200,"x-mappls-field-path":"responseCode"},"results":{"type":"object","example":"example","x-mappls-field-path":"results"},"results.code":{"type":"string","description":"if request is successful, response is ‘ok’. Else, see the service dependent and general status codes as available in the enum. In case of error, “NoRoute” code is supported (in addition to the general ones) which means “no route found”. Ok : Request could be processed as expected. InvalidUrl : URL string is invalid. InvalidService: Service name is invalid. InvalidVersion : Version is not found. InvalidOptions : Options are invalid. InvalidQuery : The query string is synctactically malformed. Inv","example":"Ok","x-mappls-field-path":"results.code"},"results.distances":{"type":"array","items":{"type":"object"},"description":"array of float distances in metres.","example":"example","x-mappls-field-path":"results.distances"},"results.durations":{"type":"array","items":{"type":"object"},"description":"array of float durations in seconds.","example":"example","x-mappls-field-path":"results.durations"}},"required":["Server","version","responseCode","results","results.code","results.distances","results.durations"]},"example":{"Server":"ETA-5100","version":"250.19.5222","responseCode":200,"results":{"code":"Ok","distances":[[14076.1,30927.6]],"durations":[[1884.9,2644.1]]}}}}},"204":{"description":"DB Connection error."},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"412":{"description":"Precondition Failed, i.e. Some existing pre-condition in formulating a valid API request was not fulfilled."},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/distanceMatrix.yml","x-mappls-source-fingerprint":"bc3f5585c2351e756400d1280beeb69393a98e5b607c26cde62248e2deb6743d","x-mappls-evidence-score":24,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-rest-key-resources-profile-geopositions-4d28552b20","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{REST_KEY}/distance_matrix_predictive/driving/{coordinates}":{"get":{"operationId":"core-location-get-rest-key-distance-matrix-predictive-driving-coordinates-distance-matrix-predictive-eta-api","summary":"Distance Matrix Predictive ETA API","description":"This API computes the distance and duration of a route between a source/primary position (geographical coordinates) and a list of all supplied secondary positions. Optionally one can input the deptime parameter and get the distance and duration optimized for that part of the day of a week. Time based functionality is available for selected cities only. Please note that maximum number of points are limited to 100 only including source and secondary positions. PREMIUM API","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-rest-key-distance-matrix-predictive-driving-coordinates-distance-matrix-predictive-eta-api"},"parameters":[{"name":"REST_KEY","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}},{"name":"coordinates","in":"path","required":true,"description":"Coordinates are pair of comma separated longitude & latitude values. First coordinate will be consider as start point (mandatory); a last coordinate will be considered as end point (mandatory) and those in between are via points (optional). Example: {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] (part of URL).","schema":{"type":"string","description":"Coordinates are pair of comma separated longitude & latitude values. First coordinate will be consider as start point (mandatory); a last coordinate will be considered as end point (mandatory) and those in between are via points (optional). Example: {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] (part of URL).","example":"28.612964,77.229463"}},{"name":"dep_time","in":"query","required":false,"description":"the UNIX timestamp of departure in seconds. Distance and ETA will be optimized as per given time.","schema":{"type":"integer","description":"the UNIX timestamp of departure in seconds. Distance and ETA will be optimized as per given time.","example":"1700000000000"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"check":{"type":"string","description":"internal response (for MMI internal purposes only)","example":5025,"x-mappls-field-path":"check"},"version":{"type":"string","description":"API’s version information.","example":"250.19.5222","x-mappls-field-path":"version"},"responseCode":{"type":"string","description":"See the service dependent and general status codes","example":"200","x-mappls-field-path":"responseCode"},"results":{"type":"object","example":"example","x-mappls-field-path":"results"},"results.code":{"type":"string","description":"if request is successful, response is ‘ok’. Else, see the service dependent and general status codes as available in the enum. In case of error, “NoRoute” code is supported (in addition to the general ones) which means “no route found”. Ok : Request could be processed as expected. InvalidUrl : URL string is invalid. InvalidService: Service name is invalid. InvalidVersion : Version is not found. InvalidOptions : Options are invalid. InvalidQuery : The query string is synctactically malformed. Inv","example":"Ok","x-mappls-field-path":"results.code"},"results.distances":{"type":"array","items":{"type":"object"},"description":"array of float distances in metres.","example":"example","x-mappls-field-path":"results.distances"},"results.durations":{"type":"array","items":{"type":"object"},"description":"array of float durations in seconds.","example":"example","x-mappls-field-path":"results.durations"}},"required":["check","version","responseCode","results","results.code","results.distances","results.durations"]},"example":{"check":5025,"version":"250.19.5222","responseCode":"200","results":{"code":"Ok","distances":[[14076.1,30927.6]],"durations":[[1884.9,2644.1]]}}}}},"204":{"description":"DB Connection error."},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"412":{"description":"Precondition Failed, i.e. Some existing pre-condition in formulating a valid API request was not fulfilled."},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/predictiveETA.yml","x-mappls-source-fingerprint":"aad00df644a08aeaa60cbfd3065f11c0a6d86d6cb410c5239d47b6cd3fbcd70e","x-mappls-evidence-score":19,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-rest-key-distance-matrix-predictive-driving-coordinates-1668dd2d4b","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{REST_KEY}/elevation":{"get":{"operationId":"core-location-get-rest-key-elevation-elevation-api","summary":"Elevation API","description":"The Elevation API provides elevation data above the sea level for location on Earth’s surface. The Elevation API allows you to retrieve sampled elevation data along a path. This API can be useful for biking, trucking & in other routing applications.","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-rest-key-elevation-elevation-api"},"parameters":[{"name":"REST_KEY","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}},{"name":"locations","in":"query","required":true,"description":"The location coordinates are expressed in pairs of (latitude,longitude|latitude,longitude)","schema":{"type":"string","description":"The location coordinates are expressed in pairs of (latitude,longitude|latitude,longitude)","example":"28.612964,77.229463"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"responseCode":{"type":"integer","description":"This shows the response code of the results.","example":200,"x-mappls-field-path":"responseCode"},"version":{"type":"string","description":"This shows the API version","example":"211.18","x-mappls-field-path":"version"},"results":{"type":"array","items":{"type":"object"},"description":"The object contains the results of the Elevation API.","example":"example","x-mappls-field-path":"results"},"results[].longitude":{"type":"integer","description":"It shows us the longitude of the location serached","example":"77.229463","x-mappls-field-path":"results[].longitude"},"results[].latitude":{"type":"integer","description":"It shows us the latitude of the location searched","example":"28.612964","x-mappls-field-path":"results[].latitude"},"results[].elevation":{"type":"integer","description":"The elevation of the location","example":523,"x-mappls-field-path":"results[].elevation"}},"required":["responseCode","version","results","results[].longitude","results[].latitude","results[].elevation"]},"example":{"responseCode":200,"version":"211.18","results":[{"longitude":76.998825,"latitude":9.53835,"elevation":523}]}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/Elevation-API.yml","x-mappls-source-fingerprint":"6db3e99ab47abbb74165fae787760a3776568476cc4a4e6cf9f8e8040bba3a93","x-mappls-evidence-score":15,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-rest-key-elevation-5422d506dc","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/api/places/geocode":{"get":{"operationId":"core-location-get-api-places-geocode-geocode-api","summary":"Geocode API","description":"All mapping APIs that are used in mobile or web apps need some geo-position coordinates to refer to any given point on the map. Our Geocoding API converts real addresses into these geographic reference positions to be placed on a map, be it for any street, area, postal code, POI or a house number etc. This APIs follow OAuth2 based security. To know more on how to create your authorization tokens, please use our authorization token URL. More details available here. Live Demo | Download Sample Code","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://atlas.mapmyindia.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-api-places-geocode-geocode-api"},"parameters":[{"name":"region","in":"query","required":false,"description":"'It takes in the country code. Possible values are listed in a table here. Default is India (IND).'","schema":{"type":"string","description":"'It takes in the country code. Possible values are listed in a table here. Default is India (IND).'","example":"ind"}},{"name":"address","in":"query","required":true,"description":"address to be geocoded","schema":{"type":"string","description":"address to be geocoded","example":"237 Okhla industrial estate phase 3 new delhi, delhi 110020"}},{"name":"itemCount","in":"query","required":false,"description":"parameter can be set to get maximum number of result items from the API (default: 1).","schema":{"type":"integer","description":"parameter can be set to get maximum number of result items from the API (default: 1).","example":1}},{"name":"bias","in":"query","required":false,"description":"This parameter can be used to set Urban or Rural bias. A positive value sets the Urban bias and a negative value sets Rural bias. This optional parameter & its related effect on response is not applicable for regions apart from India (IND). Allowed values are: 0 : Default: (No bias) -1 : Rural 1 : Urban","schema":{"type":"integer","description":"This parameter can be used to set Urban or Rural bias. A positive value sets the Urban bias and a negative value sets Rural bias. This optional parameter & its related effect on response is not applicable for regions apart from India (IND). Allowed values are: 0 : Default: (No bias) -1 : Rural 1 : Urban","example":0}},{"name":"podFilter","in":"query","required":false,"description":"This parameter can be used to set admin level restriction. The result will be either the given admin level or equivalent admin or higher in the hierarchy. No lower admin will be considered for geocoding.This optional parameter & its related effect on response is not applicable for regions apart from India (IND). Allowed values are: hno : house number hna : house name poi : point of interest street : street sslc : sub sub locality village : village slc : sub locality sdist : sub district loc : locality city : city dist : district pincode :pincode state : state","schema":{"type":"string","description":"This parameter can be used to set admin level restriction. The result will be either the given admin level or equivalent admin or higher in the hierarchy. No lower admin will be considered for geocoding.This optional parameter & its related effect on response is not applicable for regions apart from India (IND). Allowed values are: hno : house number hna : house name poi : point of interest street : street sslc : sub sub locality village : village slc : sub locality sdist : sub district loc : locality city : city dist : district pincode :pincode state : state","example":"example"}},{"name":"bound","in":"query","required":false,"description":"This parameter can be used to set admin boundary, which means geocoding will be done within the given admin. The allowed admin bounds are Sub-District, District, City, State and Pincode. The parameter accepts the admin eLoc as value. This optional parameter & its related effect on response is not applicable for regions apart from India (IND). Note: Please note that podFilter & bound parameters are mutually exclusive. They cannot be used together in an API call.","schema":{"type":"string","description":"This parameter can be used to set admin boundary, which means geocoding will be done within the given admin. The allowed admin bounds are Sub-District, District, City, State and Pincode. The parameter accepts the admin eLoc as value. This optional parameter & its related effect on response is not applicable for regions apart from India (IND). Note: Please note that podFilter & bound parameters are mutually exclusive. They cannot be used together in an API call.","example":"TAVI5S"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"copResults":{"type":"object","example":"example","x-mappls-field-path":"copResults"},"copResults.houseNumber":{"type":"string","description":"House Number of the POI.","example":"237","x-mappls-field-path":"copResults.houseNumber"},"copResults.houseName":{"type":"string","description":"House Name of the POI.","example":"MMI Building","x-mappls-field-path":"copResults.houseName"},"copResults.poi":{"type":"string","description":"Name of the POI.","example":"MapmyIndia Head Office","x-mappls-field-path":"copResults.poi"},"copResults.street":{"type":"string","description":"Name of the street.","x-mappls-field-path":"copResults.street"},"copResults.subSubLocality":{"type":"string","description":"Name of the subsublocality.","x-mappls-field-path":"copResults.subSubLocality"},"copResults.subLocality":{"type":"string","description":"Name of the sublocality.","x-mappls-field-path":"copResults.subLocality"},"copResults.locality":{"type":"string","description":"Name of the locality.","example":"Okhla industrial phase 3","x-mappls-field-path":"copResults.locality"},"copResults.village":{"type":"string","description":"Name of the village.","example":"Okhla Vilage","x-mappls-field-path":"copResults.village"},"copResults.subDistrict":{"type":"string","description":"Name of the subDistrict.","x-mappls-field-path":"copResults.subDistrict"},"copResults.district":{"type":"string","description":"Name of the District.","example":"South Delhi","x-mappls-field-path":"copResults.district"},"copResults.city":{"type":"string","description":"Name of the city.","example":"New Delhi","x-mappls-field-path":"copResults.city"},"copResults.state":{"type":"string","description":"Name of the State.","example":"1700000000000","x-mappls-field-path":"copResults.state"},"copResults.pincode":{"type":"integer","description":"Pincode of the location.","example":"110010","x-mappls-field-path":"copResults.pincode"},"copResults.formattedAddress":{"type":"string","description":"This shows the formatted address of the POI.","example":"237, MMI Building, MapmyIndia Head Office, Okhla industrial phase 3, Okhla Vilage, South Delhi, New Delhi, Delhi, 110010","x-mappls-field-path":"copResults.formattedAddress"},"copResults.eLoc":{"type":"string","description":"It is the Six or eight digit unique code offered only by mapmyindia to search for any address through this eLoc.","example":"MMI000","x-mappls-field-path":"copResults.eLoc"},"copResults.latitude":{"type":"integer","description":"It shows us the latitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"copResults.latitude"},"copResults.longitude":{"type":"integer","description":"It shows us the longitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"copResults.longitude"},"copResults.geocodeLevel":{"type":"string","description":"This shows the level of the geocode means on which basis the poi has been geocoded.","example":"houseNumber","x-mappls-field-path":"copResults.geocodeLevel"},"copResults.confidenceScore":{"type":"integer","description":"The confidence for current of geocodelevel.","example":0.4,"x-mappls-field-path":"copResults.confidenceScore"}},"required":["copResults","copResults.district","copResults.city","copResults.state","copResults.formattedAddress","copResults.eLoc","copResults.latitude","copResults.longitude","copResults.geocodeLevel","copResults.confidenceScore"]},"example":{"copResults":{"district":"South Delhi","city":"New Delhi","state":"Delhi","formattedAddress":"237, MMI Building, MapmyIndia Head Office, Okhla industrial phase 3, Okhla Vilage, South Delhi, New Delhi, Delhi, 110010","eLoc":"2LH9OC","latitude":"RESTRICTED","longitude":"RESTRICTED","geocodeLevel":"houseNumber","confidenceScore":0.4}}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/geocode.yml","x-mappls-source-fingerprint":"b1ce0d03e44035477f0d722d623b9d0ff2c5c392613f0f5106fa75392aeb3c05","x-mappls-evidence-score":33,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-api-places-geocode-a66a6b471a","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/api/places/nearby/json":{"get":{"operationId":"core-location-get-api-places-nearby-json-nearby-api","summary":"Nearby API","description":"Nearby Places API, enables you to add discovery and search of nearby POIs by searching for a generic keyword used to describe a category of places or via the unique code assigned to that category. This APIs follow OAuth2 based security. To know more on how to create your authorization tokens, please use our authorization token URL. More details available here. Live Demo | Download Sample Code","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://atlas.mapmyindia.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-api-places-nearby-json-nearby-api"},"parameters":[{"name":"keywords","in":"query","required":true,"description":"Enter the query on which the search has to be done. Operators in Keywords parameter To send multiple keywords in a request, we’ve defined a couple of operators that can help the developers wrap their applications around this functionality. Below are the operators: The “ ; ” Operator: This operator is an “or” operator. Defining multiple keywords separated with a “ ; ” would provide results that satisfies either of the keywords. The “ $ ” Operator: This operator is a “and” operator. Defining multiple keywords separated with a “ $ ” would provide results that satisfy all the provided keywords. (default). To use these operators, simple just send in the keywords parameter like below: &keywords=co","schema":{"type":"string","description":"Enter the query on which the search has to be done. Operators in Keywords parameter To send multiple keywords in a request, we’ve defined a couple of operators that can help the developers wrap their applications around this functionality. Below are the operators: The “ ; ” Operator: This operator is an “or” operator. Defining multiple keywords separated with a “ ; ” would provide results that satisfies either of the keywords. The “ $ ” Operator: This operator is a “and” operator. Defining multiple keywords separated with a “ $ ” would provide results that satisfy all the provided keywords. (default). To use these operators, simple just send in the keywords parameter like below: &keywords=co","example":"FODCOF"}},{"name":"refLocation","in":"query","required":true,"description":"Provides the location around which the search will be performed. e.g. refLocation=28.454,77.435. The refLocation parameter can also accept eLoc as reference location. This configuration is not active by default. Please contact MapmyIndia API support for further details. Example: refLocation=17ZUL7","schema":{"type":"string","description":"Provides the location around which the search will be performed. e.g. refLocation=28.454,77.435. The refLocation parameter can also accept eLoc as reference location. This configuration is not active by default. Please contact MapmyIndia API support for further details. Example: refLocation=17ZUL7","example":"28.612964,77.229463"}},{"name":"page","in":"query","required":false,"description":"provides number of the page to provide results from.","schema":{"type":"integer","description":"provides number of the page to provide results from.","example":1}},{"name":"region","in":"query","required":false,"description":"it takes in the country code. LKA, IND, BTN, BGD, NPL for Sri-Lanka, India, Bhutan, Bangladesh, Nepal respectively. Default is India (IND)","schema":{"type":"string","description":"it takes in the country code. LKA, IND, BTN, BGD, NPL for Sri-Lanka, India, Bhutan, Bangladesh, Nepal respectively. Default is India (IND)","example":"IND"}},{"name":"radius","in":"query","required":false,"description":"Provides the range of distance to search over (default 1000, min, 500, max, 10000)","schema":{"type":"integer","description":"Provides the range of distance to search over (default 1000, min, 500, max, 10000)","example":10000}},{"name":"bounds","in":"query","required":false,"description":"(x1,y1;x2,y2) Allows the developer to send in map bounds to provide a nearby search of the geobounds. where x1,y1 are the lat lng of the bound. The bounds are set from topLeft to bottomRight (North-West to South-East).","schema":{"type":"string","description":"(x1,y1;x2,y2) Allows the developer to send in map bounds to provide a nearby search of the geobounds. where x1,y1 are the lat lng of the bound. The bounds are set from topLeft to bottomRight (North-West to South-East).","example":"28.639256,77.211133;28.625214,77.237483"}},{"name":"filter","in":"query","required":false,"description":"It uses key:value pair(s) to fine tune discovery of places by filtering the results. e.g. categoryCode:FODCOF valid IDs for key value pairs are: categoryCode: can take in category codes as input","schema":{"type":"string","description":"It uses key:value pair(s) to fine tune discovery of places by filtering the results. e.g. categoryCode:FODCOF valid IDs for key value pairs are: categoryCode: can take in category codes as input","example":"categoryCode:FODCOF"}},{"name":"sortBy","in":"query","required":false,"description":"Provides configured sorting operations for the client on cloud. Below are the available sorts: dist:asc & dist:desc - will sort data in order of distance from the passed location (default). name:asc & name:desc - will sort the data on alphabetically bases. imp - will sort data in order of decreasing prominence of the place.","schema":{"type":"string","description":"Provides configured sorting operations for the client on cloud. Below are the available sorts: dist:asc & dist:desc - will sort data in order of distance from the passed location (default). name:asc & name:desc - will sort the data on alphabetically bases. imp - will sort data in order of decreasing prominence of the place.","example":"dist:asc"}},{"name":"searchBy","in":"query","required":false,"description":"provides configurable search operations for the client on cloud. Below are the available sorts: dist(default) - will sort data in order of distance from the passed location (default). imp - will search data in order of prominence of the place.","schema":{"type":"string","description":"provides configurable search operations for the client on cloud. Below are the available sorts: dist(default) - will sort data in order of distance from the passed location (default). imp - will search data in order of prominence of the place.","example":"dist"}},{"name":"pod","in":"query","required":false,"description":"It takes in the place type code which helps in restricting the results to certain chosen type. Access to this parameter is controlled from the backend. This parameter, if provided will override any values provided in keywords request param. Below mentioned are the available values for pod: SLC - Sublocality LC - Locality CITY - City STATE - State","schema":{"type":"string","description":"It takes in the place type code which helps in restricting the results to certain chosen type. Access to this parameter is controlled from the backend. This parameter, if provided will override any values provided in keywords request param. Below mentioned are the available values for pod: SLC - Sublocality LC - Locality CITY - City STATE - State","example":"LC"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"suggestedLocations":{"type":"array","items":{"type":"object"},"example":"28.612964,77.229463","x-mappls-field-path":"suggestedLocations"},"suggestedLocations[].addressTokens":{"type":"object","example":"YOUR_ACCESS_TOKEN","x-mappls-field-path":"suggestedLocations[].addressTokens"},"suggestedLocations[].addressTokens.houseNumber":{"type":"string","description":"House Number of the POI.","example":"237","x-mappls-field-path":"suggestedLocations[].addressTokens.houseNumber"},"suggestedLocations[].addressTokens.houseName":{"type":"string","description":"House Name of the POI.","example":"MMI Building","x-mappls-field-path":"suggestedLocations[].addressTokens.houseName"},"suggestedLocations[].addressTokens.poi":{"type":"string","description":"Name of the POI.","example":"MapmyIndia Head Office","x-mappls-field-path":"suggestedLocations[].addressTokens.poi"},"suggestedLocations[].addressTokens.street":{"type":"string","description":"Name of the street.","x-mappls-field-path":"suggestedLocations[].addressTokens.street"},"suggestedLocations[].addressTokens.subSubLocality":{"type":"string","description":"Name of the subsublocality.","x-mappls-field-path":"suggestedLocations[].addressTokens.subSubLocality"},"suggestedLocations[].addressTokens.subLocality":{"type":"string","description":"Name of the sublocality.","x-mappls-field-path":"suggestedLocations[].addressTokens.subLocality"},"suggestedLocations[].addressTokens.locality":{"type":"string","description":"Name of the locality.","example":"Okhla industrial phase 3","x-mappls-field-path":"suggestedLocations[].addressTokens.locality"},"suggestedLocations[].addressTokens.village":{"type":"string","description":"Name of the village.","example":"Okhla Vilage","x-mappls-field-path":"suggestedLocations[].addressTokens.village"},"suggestedLocations[].addressTokens.subDistrict":{"type":"string","description":"Name of the subDistrict.","x-mappls-field-path":"suggestedLocations[].addressTokens.subDistrict"},"suggestedLocations[].addressTokens.district":{"type":"string","description":"Name of the District.","example":"South Delhi","x-mappls-field-path":"suggestedLocations[].addressTokens.district"},"suggestedLocations[].addressTokens.city":{"type":"string","description":"Name of the city.","example":"New Delhi","x-mappls-field-path":"suggestedLocations[].addressTokens.city"},"suggestedLocations[].addressTokens.state":{"type":"string","description":"Name of the STATE.","example":"1700000000000","x-mappls-field-path":"suggestedLocations[].addressTokens.state"},"suggestedLocations[].addressTokens.pincode":{"type":"integer","description":"PINcode of the location.","example":"110010","x-mappls-field-path":"suggestedLocations[].addressTokens.pincode"},"suggestedLocations[].distance":{"type":"string","description":"provides the distance from the provided location bias in meters","example":64,"x-mappls-field-path":"suggestedLocations[].distance"},"suggestedLocations[].eloc":{"type":"string","description":"Place Id of the location 6-char alphanumeric","example":"MMI000","x-mappls-field-path":"suggestedLocations[].eloc"},"suggestedLocations[].email":{"type":"string","description":"Email for contact","example":"xyz@email.com","x-mappls-field-path":"suggestedLocations[].email"},"suggestedLocations[].entryLatitude":{"type":"number","description":"latitude of the entrance of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"suggestedLocations[].entryLatitude"},"suggestedLocations[].entryLongitude":{"type":"number","description":"longitude of the entrance of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"suggestedLocations[].entryLongitude"},"suggestedLocations[].hourOfOperation":{"type":"string","description":"The hours of operation of the POI in a day.","example":"poi","x-mappls-field-path":"suggestedLocations[].hourOfOperation"},"suggestedLocations[].keywords":{"type":"array","items":{"type":"object"},"description":"The keywords/category codes associated with the given result.","example":"example","x-mappls-field-path":"suggestedLocations[].keywords"},"suggestedLocations[].landlineNo":{"type":"number","description":"phone no for contact","example":911133107634,"x-mappls-field-path":"suggestedLocations[].landlineNo"},"suggestedLocations[].latitude":{"type":"number","description":"Latitude of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"suggestedLocations[].latitude"},"suggestedLocations[].longitude":{"type":"number","description":"longitude of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"suggestedLocations[].longitude"},"suggestedLocations[].mobileNo":{"type":"number","description":"Phone number for contact","example":919999827144,"x-mappls-field-path":"suggestedLocations[].mobileNo"},"suggestedLocations[].orderIndex":{"type":"integer","description":"the order where this result should be placed","example":1,"x-mappls-field-path":"suggestedLocations[].orderIndex"},"suggestedLocations[].placeAddress":{"type":"string","description":"Address of the location","example":"G-72, 1st Floor, Outer Circle, Connaught Place, New Delhi, Delhi, 110001","x-mappls-field-path":"suggestedLocations[].placeAddress"},"suggestedLocations[].placeName":{"type":"string","description":"Name of the location","example":"Lord of The Drinks","x-mappls-field-path":"suggestedLocations[].placeName"},"suggestedLocations[].type":{"type":"string","description":"Type of location POI or Country or City","example":"poi","x-mappls-field-path":"suggestedLocations[].type"},"pageInfo":{"type":"object","example":"example","x-mappls-field-path":"pageInfo"},"pageInfo.pageCount":{"type":"integer","description":"The number of pages with results.","example":1,"x-mappls-field-path":"pageInfo.pageCount"},"pageInfo.totalHits":{"type":"integer","description":"Total number of places in the results.","example":2730,"x-mappls-field-path":"pageInfo.totalHits"},"pageInfo.totalPages":{"type":"integer","description":"Total number of pages as per page size and no of results.","example":2730,"x-mappls-field-path":"pageInfo.totalPages"},"pageInfo.pageSize":{"type":"integer","description":"The number of results per page.","example":2730,"x-mappls-field-path":"pageInfo.pageSize"}},"required":["suggestedLocations","suggestedLocations[].addressTokens","suggestedLocations[].addressTokens.district","suggestedLocations[].addressTokens.city","suggestedLocations[].addressTokens.state","suggestedLocations[].distance","suggestedLocations[].eloc","suggestedLocations[].email","suggestedLocations[].entryLatitude","suggestedLocations[].entryLongitude","suggestedLocations[].hourOfOperation","suggestedLocations[].keywords","suggestedLocations[].landlineNo","suggestedLocations[].latitude","suggestedLocations[].longitude","suggestedLocations[].mobileNo","suggestedLocations[].orderIndex","suggestedLocations[].placeAddress","suggestedLocations[].placeName","suggestedLocations[].type","pageInfo","pageInfo.pageCount","pageInfo.totalHits","pageInfo.totalPages","pageInfo.pageSize"]},"example":{"suggestedLocations":[{"addressTokens":{"district":"South Delhi","city":"New Delhi","state":"Delhi"},"distance":64,"eloc":"CHZZ3S","email":"xyz@email.com","entryLatitude":"RESTRICTED","entryLongitude":"RESTRICTED","hourOfOperation":"poi","keywords":["FINATM"],"landlineNo":911133107634,"latitude":"RESTRICTED","longitude":"RESTRICTED","mobileNo":919999827144,"orderIndex":1,"placeAddress":"G-72, 1st Floor, Outer Circle, Connaught Place, New Delhi, Delhi, 110001","placeName":"Lord of The Drinks","type":"poi"}],"pageInfo":{"pageCount":1,"totalHits":2730,"totalPages":2730,"pageSize":2730}}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/nearby.yml","x-mappls-source-fingerprint":"4819a31c609c119f03f1db37e90ffc674ff1de4ae1a6336ec5872757bd5d0551","x-mappls-evidence-score":52,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-api-places-nearby-json-7daf645e41","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/api/places/along_route":{"post":{"operationId":"core-location-post-api-places-along-route-poi-along-the-route-api","summary":"POI Along the Route API","description":"With POI Along the Route API user will be able to get the details of POIs of a particular category along his set route. The main focus of this API is to provide convenience to the user and help him in locating the place of his interest on his set route. This APIs follow OAuth2 based security. To know more on how to create your authorization tokens, please use our authorization token URL. More details available here","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://atlas.mapmyindia.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-post-api-places-along-route-poi-along-the-route-api"},"requestBody":{"required":false,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","additionalProperties":true,"properties":{"path":{"type":"string","description":"This parameter takes the encoded route along which POIs to be searched.","example":"mfvmDcalvMB?B?@EB}@lABzABrBDAaAFoDFuCFuC@{@@m@DoAFu@D_@VmAFWHSHKBCFCbA]n@S`@IX?^BdAL|ANtCV~ANXBfBDfBBl@Bp@BrA@Pa@FKHMf@@`CHXDLBJFHJHRbD@`D@Z?h@@f@@h@@bAB^@jDDlBB~@BT@N?dDDV?x@Bt@@dCFdCFzB@nD?N?|BEzBEzBE`@AJ?lCOxCMfAClCGnCIlCIlCIhDKfDIhDIzCK|AG|AEbBG`A@d@FVD^FjARlBVn@D`AD|@Fn@DnCZnCZtBTH@J?V@`A@lC@nC@lCB`AGNCTCPEl@SRI|@a@~BqAb@OZGt@E|BEl@AxA?|@?pA@T?V@bCB`AJNBn@L^NpAl@t@`@d@V~BlA`CnA~BnA`A`@VJd@NXF~@JN@xBBL?hA?x@Ar@?x@A@?vCAvCAvCAxCAj@F`@Fd@Nf@RrAn@|@b@dBz@fBz@nBfAJF~Ax@`CfAXLRHp@XtCpAtCrAf@V|@Rf@Px@TxAZ\\F`BL`BLZEPERGNKPQR_@BaBPeEHeAXo@NcDLaDNaDNaDAkB?kAKqDIoD_@mAI{BI{BGgBIgBGiBCm@ASAi@Cu@Cc@Ag@Aa@GgBGgBGkBAu@IeCAUJARARA~@GB?f@C|AK`BIbBIt@IPCPCZO`@[FKLOR]Vk@Pi@DUL{@D[P}CP{C@i@@a@Ae@EiBCiBAyC?_ACaB?QAeBAgB?WB_@BSDSDOTu@dA{Cr@sBRi@JU^q@j@cATYZ_@TUbBsAHIhA}@jA_AlAaA`Ay@bAy@d@c@pAgAv@q@`AcA^_@tAoAVSVQLGdAg@f@Yz@e@W_@KSWIoAuCmAwCLMBCDCNE@AJ?H@F@v@fB\\GNGb@W\\YfAcALI@C@CBADCD@JBDBBBBD@D?DDLBFJNFDHDF@J@|CKbCItAEHCHA@EBEDCDABAF?D@DB@BDH@D?JADL@l@?j@BbAGGcAGiACc@Cm@C[","x-mappls-field-path":"path"},"category":{"type":"string","description":"The POI category code to be searched. Only one category input supported.","example":"FODCOF","x-mappls-field-path":"category"},"geometries":{"type":"string","description":"Type of geometry encoding, accepted values are polyline5 , polyline6 , and base64 . Default value is polyline5.","example":"polyline5","x-mappls-field-path":"geometries"},"buffer":{"type":"integer","description":"Buffer of the road. Minimum value is 25, maximum is 1000 and default is 25.","example":50,"x-mappls-field-path":"buffer"},"sort":{"type":"boolean","description":"Gets the sorted POIs along route. Valueless parameter.","example":"true","x-mappls-field-path":"sort"},"page":{"type":"integer","description":"Used for pagination. By default, a request returns maximum 10 results and to get the next 10 or so on pass the page value accordingly. Default is 1.","example":1,"x-mappls-field-path":"page"}},"required":["path","category"]},"example":{"path":"mfvmDcalvMB?B?@EB}@lABzABrBDAaAFoDFuCFuC@{@@m@DoAFu@D_@VmAFWHSHKBCFCbA]n@S`@IX?^BdAL|ANtCV~ANXBfBDfBBl@Bp@BrA@Pa@FKHMf@@`CHXDLBJFHJHRbD@`D@Z?h@@f@@h@@bAB^@jDDlBB~@BT@N?dDDV?x@Bt@@dCFdCFzB@nD?N?|BEzBEzBE`@AJ?lCOxCMfAClCGnCIlCIlCIhDKfDIhDIzCK|AG|AEbBG`A@d@FVD^FjARlBVn@D`AD|@Fn@DnCZnCZtBTH@J?V@`A@lC@nC@lCB`AGNCTCPEl@SRI|@a@~BqAb@OZGt@E|BEl@AxA?|@?pA@T?V@bCB`AJNBn@L^NpAl@t@`@d@V~BlA`CnA~BnA`A`@VJd@NXF~@JN@xBBL?hA?x@Ar@?x@A@?vCAvCAvCAxCAj@F`@Fd@Nf@RrAn@|@b@dBz@fBz@nBfAJF~Ax@`CfAXLRHp@XtCpAtCrAf@V|@Rf@Px@TxAZ\\F`BL`BLZEPERGNKPQR_@BaBPeEHeAXo@NcDLaDNaDNaDAkB?kAKqDIoD_@mAI{BI{BGgBIgBGiBCm@ASAi@Cu@Cc@Ag@Aa@GgBGgBGkBAu@IeCAUJARARA~@GB?f@C|AK`BIbBIt@IPCPCZO`@[FKLOR]Vk@Pi@DUL{@D[P}CP{C@i@@a@Ae@EiBCiBAyC?_ACaB?QAeBAgB?WB_@BSDSDOTu@dA{Cr@sBRi@JU^q@j@cATYZ_@TUbBsAHIhA}@jA_AlAaA`Ay@bAy@d@c@pAgAv@q@`AcA^_@tAoAVSVQLGdAg@f@Yz@e@W_@KSWIoAuCmAwCLMBCDCNE@AJ?H@F@v@fB\\GNGb@W\\YfAcALI@C@CBADCD@JBDBBBBD@D?DDLBFJNFDHDF@J@|CKbCItAEHCHA@EBEDCDABAF?D@DB@BDH@D?JADL@l@?j@BbAGGcAGiACc@Cm@C[","category":"FODCOF"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"suggestedPOIs":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"suggestedPOIs"},"suggestedPOIs[].distance":{"type":"integer","description":"distance of the POI.","example":1065,"x-mappls-field-path":"suggestedPOIs[].distance"},"suggestedPOIs[].place_id":{"type":"string","description":"eLoc of the POI","example":"MMI000","x-mappls-field-path":"suggestedPOIs[].place_id"},"suggestedPOIs[].poi":{"type":"string","description":"Name of the POI.","example":"Cafe Nescafe","x-mappls-field-path":"suggestedPOIs[].poi"},"suggestedPOIs[].subSubLocality":{"type":"string","description":"Subsublocality of the POI","example":"example","x-mappls-field-path":"suggestedPOIs[].subSubLocality"},"suggestedPOIs[].subLocality":{"type":"string","description":"Sublocality of the POI","example":"example","x-mappls-field-path":"suggestedPOIs[].subLocality"},"suggestedPOIs[].locality":{"type":"string","description":"Locality of the POI","example":"Pragati Maidan","x-mappls-field-path":"suggestedPOIs[].locality"},"suggestedPOIs[].city":{"type":"string","description":"City of the POI","example":"New Delhi","x-mappls-field-path":"suggestedPOIs[].city"},"suggestedPOIs[].subDistrict":{"type":"string","description":"Sub district of the POI","example":"Connaught Place","x-mappls-field-path":"suggestedPOIs[].subDistrict"},"suggestedPOIs[].district":{"type":"string","description":"District of the POI","example":"New Delhi District","x-mappls-field-path":"suggestedPOIs[].district"},"suggestedPOIs[].state":{"type":"string","description":"State of the POI","example":"1700000000000","x-mappls-field-path":"suggestedPOIs[].state"},"suggestedPOIs[].poplrName":{"type":"string","description":"Popular name of the POI","example":"Oberoi Hotel New Delhi","x-mappls-field-path":"suggestedPOIs[].poplrName"},"suggestedPOIs[].address":{"type":"string","description":"Address of the POI","example":"Khan Market, New Delhi, Delhi, 110003","x-mappls-field-path":"suggestedPOIs[].address"},"suggestedPOIs[].tel":{"type":"string","description":"Telephone number of the POI","example":"+911122205205","x-mappls-field-path":"suggestedPOIs[].tel"},"suggestedPOIs[].email":{"type":"string","description":"Email of the POI","example":"reservations@oberoigroup.com","x-mappls-field-path":"suggestedPOIs[].email"},"suggestedPOIs[].website":{"type":"string","description":"Website of the POI","example":"www.nescafe.com","x-mappls-field-path":"suggestedPOIs[].website"},"suggestedPOIs[].longitude":{"type":"number","description":"Longitude of the POI. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"suggestedPOIs[].longitude"},"suggestedPOIs[].latitude":{"type":"number","description":"Latitude of the POI. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"suggestedPOIs[].latitude"},"suggestedPOIs[].e_lng":{"type":"number","description":"Entry longitude of the POI. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"RESTRICTED","x-mappls-field-path":"suggestedPOIs[].e_lng"},"suggestedPOIs[].e_lat":{"type":"number","description":"Entry latitude of the POI. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"RESTRICTED","x-mappls-field-path":"suggestedPOIs[].e_lat"},"suggestedPOIs[].brand_code":{"type":"string","description":"Brand id of the POI","example":"0","x-mappls-field-path":"suggestedPOIs[].brand_code"}},"required":["suggestedPOIs","suggestedPOIs[].distance","suggestedPOIs[].place_id","suggestedPOIs[].poi","suggestedPOIs[].subSubLocality","suggestedPOIs[].subLocality","suggestedPOIs[].locality","suggestedPOIs[].city","suggestedPOIs[].subDistrict","suggestedPOIs[].district","suggestedPOIs[].state","suggestedPOIs[].poplrName","suggestedPOIs[].address","suggestedPOIs[].tel","suggestedPOIs[].email","suggestedPOIs[].website","suggestedPOIs[].longitude","suggestedPOIs[].latitude","suggestedPOIs[].e_lng","suggestedPOIs[].e_lat","suggestedPOIs[].brand_code"]},"example":{"suggestedPOIs":[{"distance":1065,"place_id":"74835C","poi":"Cafe Nescafe","subSubLocality":"example","subLocality":"example","locality":"Pragati Maidan","city":"New Delhi","subDistrict":"Connaught Place","district":"New Delhi District","state":"Delhi","poplrName":"Oberoi Hotel New Delhi","address":"Khan Market, New Delhi, Delhi, 110003","tel":"+911122205205","email":"reservations@oberoigroup.com","website":"www.nescafe.com","longitude":"RESTRICTED","latitude":"RESTRICTED","e_lng":"RESTRICTED","e_lat":"RESTRICTED","brand_code":"0"}]}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/alongRoute.yml","x-mappls-source-fingerprint":"e4b96b425a6607716c1739b3d7d3e384c3dbab7b354267da45f82e73f00910c9","x-mappls-evidence-score":34,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-post-api-places-along-route-a353418e56","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/apis/O2O/entity/{eLoc}":{"get":{"operationId":"core-location-get-apis-o2o-entity-eloc-place-detail-api","summary":"Place Detail API","description":"MapmyIndia eloc is a simple, standardized and precise pan-India digital address system. Every location has been assigned a unique digital address or an eLoc. Place Detail API can be used to extract the details of a place with the help of its eLoc i.e. a 6 digit code or a placeid. This APIs follow OAuth2 based security. To know more on how to create your authorization tokens, please use our authorization token URL. More details available here. The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for access token using their clientid and clientsecret to the OAuth API. Once validated from the OAuth API, the accesstoken and the tokentype need to be sent as Authorization header with the value: \"{tokentype} {accesstoken}”. Authorization : tokentype accesstoken.","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://explore.mapmyindia.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-apis-o2o-entity-eloc-place-detail-api"},"parameters":[{"name":"eLoc","in":"path","required":true,"description":"Six or Eight Digit unique code.","schema":{"type":"string","description":"Six or Eight Digit unique code.","example":"MMI000"}}],"responses":{"200":{"description":"This API is highly configurable API that enables to provision the required set of attributes to the user on the basis of their required use case. The default configuration with available with basic pay-as-you-go rates is that of General Details subtemplate.","content":{"application/json":{"schema":{},"example":{"eloc":"3F45CB","name":"The Lalit New Delhi","address":"15, Barakhamba Avenue, Connaught Place, New Delhi, Delhi, 110001"}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/placeDetail-adv.yml","x-mappls-source-fingerprint":"569fa6048fd4bcd14e00e727de4863ec5aae3b9a8318097a7e2125d32572b1a2","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-apis-o2o-entity-eloc-a77f98ec42","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{REST_KEY}/rev_geocode":{"get":{"operationId":"core-location-get-rest-key-rev-geocode-reverse-geocode-api","summary":"Reverse Geocode API","description":"Reverse Geocoding is a process to give the closest matching address to a provided geographical coordinates (latitude/longitude). MapmyIndia reverse geocoding API provides real addresses along with nearest popular landmark for any such geo-positions on the map. This API also works in Hindi language response. Live Demo | Download Sample Code","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-rest-key-rev-geocode-reverse-geocode-api"},"parameters":[{"name":"lat","in":"query","required":true,"description":"The latitude of the location","schema":{"type":"number","description":"The latitude of the location","example":"28.612964"}},{"name":"lng","in":"query","required":true,"description":"The longitude of the location","schema":{"type":"number","description":"The longitude of the location","example":"77.229463"}},{"name":"REST_KEY","in":"path","required":true,"description":"The rest key allocated to your account.","schema":{"type":"string","description":"The rest key allocated to your account.","example":"YOUR_REST_KEY"}},{"name":"region","in":"query","required":false,"description":"It takes in the country code. Possible values are listed in a table here. Default is India (IND).","schema":{"type":"string","description":"It takes in the country code. Possible values are listed in a table here. Default is India (IND).","example":"IND"}},{"name":"lang","in":"query","required":false,"description":"This parameter accepts the \"hi\" (ISO 639-1 Language Code for Hindi) as a value. This optional parameter & its related effect on response is not applicable for regions apart from India (IND).","schema":{"type":"string","description":"This parameter accepts the \"hi\" (ISO 639-1 Language Code for Hindi) as a value. This optional parameter & its related effect on response is not applicable for regions apart from India (IND).","example":"hi"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"responseCode":{"type":"integer","description":"This shows the response code of the results.","example":200,"x-mappls-field-path":"responseCode"},"version":{"type":"string","description":"This shows the API version","example":"211.19","x-mappls-field-path":"version"},"results":{"type":"array","items":{"type":"object"},"description":"The object contains the results of the reverse geocode API.","example":"example","x-mappls-field-path":"results"},"results[].houseNumber":{"type":"string","description":"House Number of the POI.","example":"237","x-mappls-field-path":"results[].houseNumber"},"results[].houseName":{"type":"string","description":"House Name of the POI.","example":"MMI Building","x-mappls-field-path":"results[].houseName"},"results[].poi":{"type":"string","description":"Name of the POI.","example":"MapmyIndia Head Office","x-mappls-field-path":"results[].poi"},"results[].poi_dist":{"type":"string","description":"The value of the poi district","example":"8","x-mappls-field-path":"results[].poi_dist"},"results[].street":{"type":"string","description":"Name of the street.","example":"Unnamed Road","x-mappls-field-path":"results[].street"},"results[].street_dist":{"type":"string","description":"The value of the street district.","example":"14","x-mappls-field-path":"results[].street_dist"},"results[].subSubLocality":{"type":"string","description":"Name of the subsublocality.","x-mappls-field-path":"results[].subSubLocality"},"results[].subLocality":{"type":"string","description":"Name of the sublocality.","x-mappls-field-path":"results[].subLocality"},"results[].locality":{"type":"string","description":"Name of the locality.","example":"Okhla industrial phase 3","x-mappls-field-path":"results[].locality"},"results[].village":{"type":"string","description":"Name of the village.","example":"Okhla Vilage","x-mappls-field-path":"results[].village"},"results[].subDistrict":{"type":"string","description":"Name of the subDistrict.","x-mappls-field-path":"results[].subDistrict"},"results[].city":{"type":"string","description":"Name of the city.","example":"New Delhi","x-mappls-field-path":"results[].city"},"results[].state":{"type":"string","description":"Name of the state.","example":"1700000000000","x-mappls-field-path":"results[].state"},"results[].pincode":{"type":"integer","description":"Pincode of the location.","example":"110010","x-mappls-field-path":"results[].pincode"},"results[].lat":{"type":"string","description":"It shows us the latitude of the location searched.","example":"28.612964","x-mappls-field-path":"results[].lat"},"results[].lng":{"type":"string","description":"It shows us the longitude of the location searched.","example":"77.229463","x-mappls-field-path":"results[].lng"},"results[].area":{"type":"string","description":"It shows the area on which the result has been found. for eg: India, Bangladesh, etc.","example":"India","x-mappls-field-path":"results[].area"},"results[].formatted_address":{"type":"string","description":"This shows the formatted address of the POI.","example":"237, MMI Building, MapmyIndia Head Office, Okhla industrial phase 3, Okhla Vilage, South Delhi, New Delhi, Delhi, 110010","x-mappls-field-path":"results[].formatted_address"}},"required":["responseCode","version","results","results[].city","results[].state","results[].lat","results[].lng","results[].formatted_address"]},"example":{"responseCode":200,"version":"211.19","results":[{"city":"New Delhi","state":"Delhi","lat":"28.426335","lng":"77.092001","formatted_address":"237, MMI Building, MapmyIndia Head Office, Okhla industrial phase 3, Okhla Vilage, South Delhi, New Delhi, Delhi, 110010"}]}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/revGeocode.yml","x-mappls-source-fingerprint":"fe7746feeb136f533afaf6048c5d0d69a8f193de3c71ade521c9aa6f412eb2b1","x-mappls-evidence-score":33,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-rest-key-rev-geocode-463e80bf6b","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{rest_key}/{resources}/{profile}/{geopositions}":{"get":{"operationId":"core-location-get-rest-key-resources-profile-geopositions-route-optimization-api","summary":"Route Optimization API","description":"Route Optimization is the process of determining the most cost-efficient route. It needs to include all relevant factors such as the number and location of all the required stops on the route. In other words, this API will solve the Traveling Salesman Problem of routing and the returned path does not have to be the fastest path. As TSP is NP-hard it only returns an approximation. Currently, not all combinations of roundtrip, source and destination are supported. Right now, the following combinations are possible: | roundtrip | source | destination | supported | | --- | --- | --- | --- | | true | first | last | yes | | true | first | any | yes | | true | any | last | yes | | true | any | any | yes | | false | first | last | yes | Live Demo | PREMIUM API","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-rest-key-resources-profile-geopositions-route-optimization-api"},"parameters":[{"name":"rest_key","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}},{"name":"resources","in":"path","required":true,"description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources tripoptimization to calculate a route & its duration without considering traffic conditions. tripoptimizationeta to get the updated duration of a route considering live traffic; Applicable for India only “region=ind” and “rtype=1” is not supported. This is different from tripoptimizationtraffic ; this resource balances between a preferred path and aggressive traffic c","schema":{"type":"string","description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources tripoptimization to calculate a route & its duration without considering traffic conditions. tripoptimizationeta to get the updated duration of a route considering live traffic; Applicable for India only “region=ind” and “rtype=1” is not supported. This is different from tripoptimizationtraffic ; this resource balances between a preferred path and aggressive traffic c","enum":["trip_optimization","trip_optimization_eta","trip_optimization_traffic"],"example":"trip_optimization_eta"}},{"name":"profile","in":"path","required":true,"description":"The different profiles available within MapmyIndia Routing API. These profiles have their own individual transport modes and not all are allocated for evalulations be default. For allocating particular profiles on your API credentials, please contact apisupport@mapmyindia.com Table 2. Profiles Element Value Description Profiles driving Meant for 4-wheeler/passenger car routing. biking Meant for two-wheeler routing. Routing with this profile is restricted to tripoptimization only. region & rtype request parameters are not supported in two-wheeler routing. walking Meant for pedestrian routing. Routing with this profile is restricted to tripoptimization only. region & rtype request parameters a","schema":{"type":"string","description":"The different profiles available within MapmyIndia Routing API. These profiles have their own individual transport modes and not all are allocated for evalulations be default. For allocating particular profiles on your API credentials, please contact apisupport@mapmyindia.com Table 2. Profiles Element Value Description Profiles driving Meant for 4-wheeler/passenger car routing. biking Meant for two-wheeler routing. Routing with this profile is restricted to tripoptimization only. region & rtype request parameters are not supported in two-wheeler routing. walking Meant for pedestrian routing. Routing with this profile is restricted to tripoptimization only. region & rtype request parameters a","enum":["driving","biking","walking","trucking"],"example":"driving"}},{"name":"geopositions","in":"path","required":true,"description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","schema":{"type":"string","description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","example":"28.612964,77.229463"}},{"name":"geometries","in":"query","required":false,"description":"This parameter used to change the route geometry format/density (influences overview and per step).","schema":{"type":"string","description":"This parameter used to change the route geometry format/density (influences overview and per step).","enum":["polyline","polyline6","geojson"],"example":"polyline"}},{"name":"source","in":"query","required":false,"description":"Use location with given index as source.","schema":{"type":"string","description":"Use location with given index as source.","enum":["first","last","any"],"example":"any"}},{"name":"destination","in":"query","required":false,"description":"Use location with given index as destination.","schema":{"type":"string","description":"Use location with given index as destination.","enum":["first","last","any"],"example":"any"}},{"name":"steps","in":"query","required":false,"description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","schema":{"type":"boolean","description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","enum":[true,false],"example":true}},{"name":"region","in":"query","required":false,"description":"This parameter is optional for India; for other countries (such as Sri Lanka, Nepal, Bangladesh, Bhutan + many more) this parameter is mandatory. Possible values are listed in a table here.","schema":{"type":"string","description":"This parameter is optional for India; for other countries (such as Sri Lanka, Nepal, Bangladesh, Bhutan + many more) this parameter is mandatory. Possible values are listed in a table here.","example":"IND"}},{"name":"roundtrip","in":"query","required":false,"description":"Returned route is a roundtrip (route returns to first location).","schema":{"type":"boolean","description":"Returned route is a roundtrip (route returns to first location).","enum":[true,false],"example":true}},{"name":"overview","in":"query","required":false,"description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","schema":{"type":"string","description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","enum":["simplified","full",false],"example":"simplified"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"trips":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"trips"},"trips[].legs":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"trips[].legs"},"trips[].legs[].steps":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"trips[].legs[].steps"},"trips[].legs[].steps[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"trips[].legs[].steps[].weight"},"trips[].legs[].steps[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"trips[].legs[].steps[].distance"},"trips[].legs[].steps[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"trips[].legs[].steps[].duration"},"trips[].legs[].steps[].geometry":{"type":"number","description":"The un-simplified geometry of the step segment, depends on the given geometries request parameter. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"trips[].legs[].steps[].geometry"},"trips[].legs[].steps[].intersections":{"type":"array","items":{"type":"object"},"description":"A list of Intersection objects(1) that are passed along the segment, the very first belonging to the StepManeuver(2). Note: An intersection gives a full representation of any cross-way the path passes bay. For every step, the very first intersection (intersections[0]) corresponds to the location of the StepManeuver. Further intersections are listed for every cross-way until the next turn instruction. An object type representing maneuver.","example":"example","x-mappls-field-path":"trips[].legs[].steps[].intersections"},"trips[].legs[].steps[].intersections[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the location of the intersection.","example":"28.612964,77.229463","x-mappls-field-path":"trips[].legs[].steps[].intersections[].location"},"trips[].legs[].steps[].intersections[].classes":{"type":"array","items":{"type":"string"},"description":"Categorised types of road segments e.g. Motorway","example":["motorway"],"x-mappls-field-path":"trips[].legs[].steps[].intersections[].classes"},"trips[].legs[].steps[].intersections[].bearings":{"type":"array","items":{"type":"integer"},"description":"A list of bearing values (e.g. [0,90,180,270]) that are available at the intersection. The bearings describe all available roads at the intersection.","example":[60,210,240],"x-mappls-field-path":"trips[].legs[].steps[].intersections[].bearings"},"trips[].legs[].steps[].intersections[].entry":{"type":"array","items":{"type":"boolean"},"description":"A list of entry flags, corresponding in a 1:1 relationship to the bearings. A value of true indicates that the respective road could be entered on a valid route. false indicates that the turn onto the respective road would violate a restriction.","example":[false,true,true],"x-mappls-field-path":"trips[].legs[].steps[].intersections[].entry"},"trips[].legs[].steps[].intersections[].in":{"type":"integer","description":"index into bearings/entry array. Used to calculate the bearing just before the turn. Namely, the clockwise angle from true north to the direction of travel immediately before the maneuver/passing the intersection. Bearings are given relative to the intersection. To get the bearing in the direction of driving, the bearing has to be rotated by a value of 180. The value is not supplied for depart maneuvers.","example":0,"x-mappls-field-path":"trips[].legs[].steps[].intersections[].in"},"trips[].legs[].steps[].intersections[].out":{"type":"integer","description":"index into the bearings/entry array. Used to extract the bearing just after the turn. Namely, The clockwise angle from true north to the direction of travel immediately after the maneuver/passing the intersection. The value is not supplied for arrive maneuvers.","example":2,"x-mappls-field-path":"trips[].legs[].steps[].intersections[].out"},"trips[].legs[].steps[].intersections[].lanes":{"type":"array","items":{"type":"object"},"description":"Array of Lane objects that denote the available turn lanes at the intersection. If no lane information is available for an intersection, the lanes property will not be present.","example":"example","x-mappls-field-path":"trips[].legs[].steps[].intersections[].lanes"},"trips[].legs[].steps[].driving_side":{"type":"number","description":"“Left” (default) for India, Sri Lanka, Nepal, Bangladesh & Bhutan.","example":"left","x-mappls-field-path":"trips[].legs[].steps[].driving_side"},"trips[].legs[].steps[].name":{"type":"string","description":"The name of the way along which travel proceeds.","example":"Safdar Hashmi Marg","x-mappls-field-path":"trips[].legs[].steps[].name"},"trips[].legs[].steps[].mode":{"type":"string","description":"signifies the mode of transportation; driving as default.","example":"driving","x-mappls-field-path":"trips[].legs[].steps[].mode"},"trips[].legs[].steps[].maneuver":{"type":"object","example":"example","x-mappls-field-path":"trips[].legs[].steps[].maneuver"},"trips[].legs[].steps[].maneuver.location":{"type":"array","items":{"type":"string"},"description":"A [longitude, latitude] pair describing the location of the turn.","example":"28.612964,77.229463","x-mappls-field-path":"trips[].legs[].steps[].maneuver.location"},"trips[].legs[].steps[].maneuver.bearing_before":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately before the maneuver.","example":357,"x-mappls-field-path":"trips[].legs[].steps[].maneuver.bearing_before"},"trips[].legs[].steps[].maneuver.bearing_after":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately after the maneuver.","example":254,"x-mappls-field-path":"trips[].legs[].steps[].maneuver.bearing_after"},"trips[].legs[].steps[].maneuver.modifier":{"type":"string","description":"An optional string indicating the direction change of the maneuver. To see the complete list of modifiers, please see article in wiki.","example":"left","x-mappls-field-path":"trips[].legs[].steps[].maneuver.modifier"},"trips[].legs[].steps[].maneuver.type":{"type":"string","description":"A string indicating the type of maneuver. New identifiers might be introduced without API change. Types unknown to the client should be handled like the ‘turn’ type, the existence of correct modifier values is guaranteed. To see the complete list of types, please see article in wiki.","example":"turn","x-mappls-field-path":"trips[].legs[].steps[].maneuver.type"},"trips[].legs[].summary":{"type":"number","description":"Parameter for internal purpose only.","example":"Patel Road, Bhagwan Mahavir Marg","x-mappls-field-path":"trips[].legs[].summary"},"trips[].legs[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"trips[].legs[].weight"},"trips[].legs[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"trips[].legs[].distance"},"trips[].legs[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"trips[].legs[].duration"},"trips[].weight_name":{"type":"number","description":"Parameter for internal purpose only.","example":"routability","x-mappls-field-path":"trips[].weight_name"},"trips[].geometry":{"type":"number","description":"Returns the whole geometry of the route as per given geometries request parameter. Default is encoded polyline with 5 digit accuracy (1e5) for positional coordinates. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"trips[].geometry"},"trips[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"trips[].weight"},"trips[].distance":{"type":"number","description":"The distance of travel, in float meters.","example":2282.2,"x-mappls-field-path":"trips[].distance"},"trips[].duration":{"type":"number","description":"The estimated travel time, in float number of seconds.","example":252.4,"x-mappls-field-path":"trips[].duration"},"waypoints":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"waypoints"},"waypoints[].hint":{"type":"string","description":"Unique internal identifier of the segment (ephemeral, not constant over data updates) This can be used on subsequent request to significantly speed up the query and to connect multiple services. E.g. you can use the hint value obtained by the nearest query as hint values for route inputs.","example":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","x-mappls-field-path":"waypoints[].hint"},"waypoints[].name":{"type":"string","description":"Name of the street the coordinate snapped to.","example":"Delhi Gurgaon Expressway","x-mappls-field-path":"waypoints[].name"},"waypoints[].distance":{"type":"number","description":"distance to snapped location from actual location.","example":4.033839,"x-mappls-field-path":"waypoints[].distance"},"waypoints[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the snapped location of the waypoint.","example":"28.612964,77.229463","x-mappls-field-path":"waypoints[].location"},"code":{"type":"string","description":"if request is successful, response is ‘ok’. Else, see the service dependent and general status codes as available in the enum. In case of error, “NoRoute” code is supported (in addition to the general ones) which means “no route found”. Ok : Request could be processed as expected. InvalidUrl : URL string is invalid. InvalidService: Service name is invalid. InvalidVersion : Version is not found. InvalidOptions : Options are invalid. InvalidQuery : The query string is synctactically malformed. Inv","enum":["Ok","InvalidUrl","InvalidService","InvalidVersion","InvalidOptions","InvalidQuery","InvalidValue","NoSegment","TooBig","NoRoute"],"example":"Ok","x-mappls-field-path":"code"},"Server":{"type":"string","description":"Gives Information on active service's server.","example":"ETA-5100","x-mappls-field-path":"Server"}},"required":["trips","trips[].legs","trips[].legs[].steps","trips[].legs[].steps[].weight","trips[].legs[].steps[].distance","trips[].legs[].steps[].duration","trips[].legs[].steps[].geometry","trips[].legs[].steps[].intersections","trips[].legs[].steps[].intersections[].location","trips[].legs[].steps[].intersections[].classes","trips[].legs[].steps[].intersections[].bearings","trips[].legs[].steps[].intersections[].entry","trips[].legs[].steps[].intersections[].in","trips[].legs[].steps[].intersections[].out","trips[].legs[].steps[].intersections[].lanes","trips[].legs[].steps[].driving_side","trips[].legs[].steps[].name","trips[].legs[].steps[].mode","trips[].legs[].steps[].maneuver","trips[].legs[].steps[].maneuver.location","trips[].legs[].steps[].maneuver.bearing_before","trips[].legs[].steps[].maneuver.bearing_after","trips[].legs[].steps[].maneuver.modifier","trips[].legs[].steps[].maneuver.type","trips[].legs[].summary","trips[].legs[].weight","trips[].legs[].distance","trips[].legs[].duration","trips[].weight_name","trips[].geometry","trips[].weight","trips[].distance","trips[].duration","waypoints","waypoints[].hint","waypoints[].name","waypoints[].distance","waypoints[].location","code","Server"]},"example":{"trips":[{"legs":[{"steps":"example","summary":"Patel Road, Bhagwan Mahavir Marg","weight":2282.2,"distance":2282.2,"duration":252.4}],"weight_name":"routability","geometry":"osgmDutwuMjA~@vEfGx@X~RlXLnAhGbJfHjQzBxDb@jEpAj@nAFt@`A?fAQn@aDbBcAhBmChQ","weight":2282.2,"distance":2282.2,"duration":252.4}],"waypoints":[{"hint":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","name":"Delhi Gurgaon Expressway","distance":4.033839,"location":[77.113089,28.544643]}],"code":"Ok","Server":"ETA-5100"}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/routeOpt.yml","x-mappls-source-fingerprint":"af458e128aba8f5264d3747175f1b5cfdf6929686fb4e12872d20d69b8fa7ac9","x-mappls-evidence-score":58,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-rest-key-resources-profile-geopositions-03d4b10931","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{REST_KEY}/{resources}/{profile}/{geopositions}":{"get":{"operationId":"core-location-get-rest-key-resources-profile-geopositions-routing-api","summary":"Routing API","description":"Routing and displaying driving directions on map, including instructions for navigation, distance to destination, traffic etc. are few of the most important parts of developing a map based application. This REST API calculates driving routes between specified locations including via points based on route calculation type(optimal or shortest). Please note that maximum number of points are limited to 100 only including source and secondary positions. Live Demo | Download Sample Code","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-rest-key-resources-profile-geopositions-routing-api"},"parameters":[{"name":"REST_KEY","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}},{"name":"resources","in":"path","required":true,"description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources routeadv to calculate a route & its duration without considering traffic conditions. routeeta to get the updated duration of a route considering live traffic; Applicable for India only “region=ind” and “rtype=1” is not supported. This is different from routetraffic ; this resource balances between a preferred path and aggressive traffic congestion avoidance. routetraf","schema":{"type":"string","description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources routeadv to calculate a route & its duration without considering traffic conditions. routeeta to get the updated duration of a route considering live traffic; Applicable for India only “region=ind” and “rtype=1” is not supported. This is different from routetraffic ; this resource balances between a preferred path and aggressive traffic congestion avoidance. routetraf","enum":["route_adv","route_eta","route_traffic"],"example":"route_eta"}},{"name":"profile","in":"path","required":true,"description":"The different profiles available within MapmyIndia Routing API. These profiles have their own individual transport modes and not all are allocated for evalulations be default. For allocating particular profiles on your API credentials, please contact apisupport@mapmyindia.com Table 2. Profiles Element Value Description Profiles driving Meant for 4-wheeler/passenger car routing. biking Meant for two-wheeler routing. Routing with this profile is restricted to routeadv only. region & rtype request parameters are not supported in two-wheeler routing. walking Meant for pedestrian routing. Routing with this profile is restricted to routeadv only. region & rtype request parameters are not supported","schema":{"type":"string","description":"The different profiles available within MapmyIndia Routing API. These profiles have their own individual transport modes and not all are allocated for evalulations be default. For allocating particular profiles on your API credentials, please contact apisupport@mapmyindia.com Table 2. Profiles Element Value Description Profiles driving Meant for 4-wheeler/passenger car routing. biking Meant for two-wheeler routing. Routing with this profile is restricted to routeadv only. region & rtype request parameters are not supported in two-wheeler routing. walking Meant for pedestrian routing. Routing with this profile is restricted to routeadv only. region & rtype request parameters are not supported","enum":["driving","biking","walking","trucking"],"example":"driving"}},{"name":"geopositions","in":"path","required":true,"description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","schema":{"type":"string","description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","example":"28.612964,77.229463"}},{"name":"geometries","in":"query","required":false,"description":"This parameter used to change the route geometry format/density (influences overview and per step).","schema":{"type":"string","description":"This parameter used to change the route geometry format/density (influences overview and per step).","enum":["polyline","polyline6","geojson"],"example":"polyline"}},{"name":"rtype","in":"query","required":false,"description":"type of route (integer) required for navigation, where values mean: 0 optimal (default) 1 shortest (it will calculate route by excluding access penalties like private roads, etc.)","schema":{"type":"integer","description":"type of route (integer) required for navigation, where values mean: 0 optimal (default) 1 shortest (it will calculate route by excluding access penalties like private roads, etc.)","enum":[0,1],"example":0}},{"name":"steps","in":"query","required":false,"description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","schema":{"type":"boolean","description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","enum":[true,false],"example":true}},{"name":"exclude","in":"query","required":false,"description":"Additive list of road classes to avoid, order does not matter. Possible values are toll, motorway & ferry. Multiple values can be sent separated by comma.","schema":{"type":"string","description":"Additive list of road classes to avoid, order does not matter. Possible values are toll, motorway & ferry. Multiple values can be sent separated by comma.","example":"ferry"}},{"name":"region","in":"query","required":false,"description":"This parameter is optional for India; for other countries (such as Sri Lanka, Nepal, Bangladesh, Bhutan + many more) this parameter is mandatory. Possible values are listed in a table here.","schema":{"type":"string","description":"This parameter is optional for India; for other countries (such as Sri Lanka, Nepal, Bangladesh, Bhutan + many more) this parameter is mandatory. Possible values are listed in a table here.","example":"IND"}},{"name":"bearings","in":"query","required":false,"description":"Limits the search to segments with given bearing in degrees. The referencing will be to the true north and in clockwise direction. (Part of premium offering)","schema":{"type":"integer","description":"Limits the search to segments with given bearing in degrees. The referencing will be to the true north and in clockwise direction. (Part of premium offering)","example":180}},{"name":"alternatives","in":"query","required":false,"description":"Search for alternative routes. Passing a number: e.g. alternatives=n searches for up to n alternative routes. Please note that even if alternative routes are requested, a result cannot be guaranteed.","schema":{"type":"integer","description":"Search for alternative routes. Passing a number: e.g. alternatives=n searches for up to n alternative routes. Please note that even if alternative routes are requested, a result cannot be guaranteed.","example":2}},{"name":"radiuses","in":"query","required":false,"description":"Limits the search to given radius in meters. For all way-points including start and end points. {radius};{radius}[;{radius} ...]. (Part of premium offering)","schema":{"type":"string","description":"Limits the search to given radius in meters. For all way-points including start and end points. {radius};{radius}[;{radius} ...]. (Part of premium offering)","example":"100;100"}},{"name":"overview","in":"query","required":false,"description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","schema":{"type":"string","description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","enum":["simplified","full",false],"example":"simplified"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"routes":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes"},"routes[].legs":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes[].legs"},"routes[].legs[].steps":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes[].legs[].steps"},"routes[].legs[].steps[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].legs[].steps[].weight"},"routes[].legs[].steps[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].legs[].steps[].distance"},"routes[].legs[].steps[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].legs[].steps[].duration"},"routes[].legs[].steps[].geometry":{"type":"number","description":"The un-simplified geometry of the step segment, depends on the given geometries request parameter. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].geometry"},"routes[].legs[].steps[].intersections":{"type":"array","items":{"type":"object"},"description":"A list of Intersection objects(1) that are passed along the segment, the very first belonging to the StepManeuver(2). Note: An intersection gives a full representation of any cross-way the path passes bay. For every step, the very first intersection (intersections[0]) corresponds to the location of the StepManeuver. Further intersections are listed for every cross-way until the next turn instruction. An object type representing maneuver.","example":"example","x-mappls-field-path":"routes[].legs[].steps[].intersections"},"routes[].legs[].steps[].intersections[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the location of the intersection.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].intersections[].location"},"routes[].legs[].steps[].intersections[].classes":{"type":"array","items":{"type":"string"},"description":"Categorised types of road segments e.g. Motorway","example":["motorway"],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].classes"},"routes[].legs[].steps[].intersections[].bearings":{"type":"array","items":{"type":"integer"},"description":"A list of bearing values (e.g. [0,90,180,270]) that are available at the intersection. The bearings describe all available roads at the intersection.","example":[60,210,240],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].bearings"},"routes[].legs[].steps[].intersections[].entry":{"type":"array","items":{"type":"boolean"},"description":"A list of entry flags, corresponding in a 1:1 relationship to the bearings. A value of true indicates that the respective road could be entered on a valid route. false indicates that the turn onto the respective road would violate a restriction.","example":[false,true,true],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].entry"},"routes[].legs[].steps[].intersections[].in":{"type":"integer","description":"index into bearings/entry array. Used to calculate the bearing just before the turn. Namely, the clockwise angle from true north to the direction of travel immediately before the maneuver/passing the intersection. Bearings are given relative to the intersection. To get the bearing in the direction of driving, the bearing has to be rotated by a value of 180. The value is not supplied for depart maneuvers.","example":0,"x-mappls-field-path":"routes[].legs[].steps[].intersections[].in"},"routes[].legs[].steps[].intersections[].out":{"type":"integer","description":"index into the bearings/entry array. Used to extract the bearing just after the turn. Namely, The clockwise angle from true north to the direction of travel immediately after the maneuver/passing the intersection. The value is not supplied for arrive maneuvers.","example":2,"x-mappls-field-path":"routes[].legs[].steps[].intersections[].out"},"routes[].legs[].steps[].intersections[].lanes":{"type":"array","items":{"type":"object"},"description":"Array of Lane objects that denote the available turn lanes at the intersection. If no lane information is available for an intersection, the lanes property will not be present.","example":"example","x-mappls-field-path":"routes[].legs[].steps[].intersections[].lanes"},"routes[].legs[].steps[].driving_side":{"type":"number","description":"“Left” (default) for India, Sri Lanka, Nepal, Bangladesh & Bhutan.","example":"left","x-mappls-field-path":"routes[].legs[].steps[].driving_side"},"routes[].legs[].steps[].name":{"type":"string","description":"The name of the way along which travel proceeds.","example":"Safdar Hashmi Marg","x-mappls-field-path":"routes[].legs[].steps[].name"},"routes[].legs[].steps[].mode":{"type":"string","description":"signifies the mode of transportation; driving as default.","example":"driving","x-mappls-field-path":"routes[].legs[].steps[].mode"},"routes[].legs[].steps[].maneuver":{"type":"object","example":"example","x-mappls-field-path":"routes[].legs[].steps[].maneuver"},"routes[].legs[].steps[].maneuver.location":{"type":"array","items":{"type":"string"},"description":"A [longitude, latitude] pair describing the location of the turn.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].maneuver.location"},"routes[].legs[].steps[].maneuver.bearing_before":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately before the maneuver.","example":357,"x-mappls-field-path":"routes[].legs[].steps[].maneuver.bearing_before"},"routes[].legs[].steps[].maneuver.bearing_after":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately after the maneuver.","example":254,"x-mappls-field-path":"routes[].legs[].steps[].maneuver.bearing_after"},"routes[].legs[].steps[].maneuver.modifier":{"type":"string","description":"An optional string indicating the direction change of the maneuver. To see the complete list of modifiers, please see article in wiki.","example":"left","x-mappls-field-path":"routes[].legs[].steps[].maneuver.modifier"},"routes[].legs[].steps[].maneuver.type":{"type":"string","description":"A string indicating the type of maneuver. New identifiers might be introduced without API change. Types unknown to the client should be handled like the ‘turn’ type, the existence of correct modifier values is guaranteed. To see the complete list of types, please see article in wiki.","example":"turn","x-mappls-field-path":"routes[].legs[].steps[].maneuver.type"},"routes[].legs[].summary":{"type":"number","description":"Parameter for internal purpose only.","example":"Patel Road, Bhagwan Mahavir Marg","x-mappls-field-path":"routes[].legs[].summary"},"routes[].legs[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].legs[].weight"},"routes[].legs[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].legs[].distance"},"routes[].legs[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].legs[].duration"},"routes[].weight_name":{"type":"number","description":"Parameter for internal purpose only.","example":"routability","x-mappls-field-path":"routes[].weight_name"},"routes[].geometry":{"type":"number","description":"Returns the whole geometry of the route as per given geometries request parameter. Default is encoded polyline with 5 digit accuracy (1e5) for positional coordinates. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].geometry"},"routes[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].weight"},"routes[].distance":{"type":"number","description":"The distance of travel, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].distance"},"routes[].duration":{"type":"number","description":"The estimated travel time, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].duration"},"waypoints":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"waypoints"},"waypoints[].hint":{"type":"string","description":"Unique internal identifier of the segment (ephemeral, not constant over data updates) This can be used on subsequent request to significantly speed up the query and to connect multiple services. E.g. you can use the hint value obtained by the nearest query as hint values for route inputs.","example":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","x-mappls-field-path":"waypoints[].hint"},"waypoints[].name":{"type":"string","description":"Name of the street the coordinate snapped to.","example":"Delhi Gurgaon Expressway","x-mappls-field-path":"waypoints[].name"},"waypoints[].distance":{"type":"number","description":"distance to snapped location from actual location.","example":4.033839,"x-mappls-field-path":"waypoints[].distance"},"waypoints[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the snapped location of the waypoint.","example":"28.612964,77.229463","x-mappls-field-path":"waypoints[].location"},"code":{"type":"string","description":"if request is successful, response is ‘ok’. Else, see the service dependent and general status codes as available in the enum. In case of error, “NoRoute” code is supported (in addition to the general ones) which means “no route found”. Ok : Request could be processed as expected. InvalidUrl : URL string is invalid. InvalidService: Service name is invalid. InvalidVersion : Version is not found. InvalidOptions : Options are invalid. InvalidQuery : The query string is synctactically malformed. Inv","enum":["Ok","InvalidUrl","InvalidService","InvalidVersion","InvalidOptions","InvalidQuery","InvalidValue","NoSegment","TooBig","NoRoute"],"example":"Ok","x-mappls-field-path":"code"},"Server":{"type":"string","description":"Gives Information on active service's server.","example":"ETA-5100","x-mappls-field-path":"Server"}},"required":["routes","routes[].legs","routes[].legs[].steps","routes[].legs[].steps[].weight","routes[].legs[].steps[].distance","routes[].legs[].steps[].duration","routes[].legs[].steps[].geometry","routes[].legs[].steps[].intersections","routes[].legs[].steps[].intersections[].location","routes[].legs[].steps[].intersections[].classes","routes[].legs[].steps[].intersections[].bearings","routes[].legs[].steps[].intersections[].entry","routes[].legs[].steps[].intersections[].in","routes[].legs[].steps[].intersections[].out","routes[].legs[].steps[].intersections[].lanes","routes[].legs[].steps[].driving_side","routes[].legs[].steps[].name","routes[].legs[].steps[].mode","routes[].legs[].steps[].maneuver","routes[].legs[].steps[].maneuver.location","routes[].legs[].steps[].maneuver.bearing_before","routes[].legs[].steps[].maneuver.bearing_after","routes[].legs[].steps[].maneuver.modifier","routes[].legs[].steps[].maneuver.type","routes[].legs[].summary","routes[].legs[].weight","routes[].legs[].distance","routes[].legs[].duration","routes[].weight_name","routes[].geometry","routes[].weight","routes[].distance","routes[].duration","waypoints","waypoints[].hint","waypoints[].name","waypoints[].distance","waypoints[].location","code","Server"]},"example":{"routes":[{"legs":[{"steps":"example","summary":"Patel Road, Bhagwan Mahavir Marg","weight":2282.2,"distance":2282.2,"duration":252.4}],"weight_name":"routability","geometry":"osgmDutwuMjA~@vEfGx@X~RlXLnAhGbJfHjQzBxDb@jEpAj@nAFt@`A?fAQn@aDbBcAhBmChQ","weight":2282.2,"distance":2282.2,"duration":252.4}],"waypoints":[{"hint":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","name":"Delhi Gurgaon Expressway","distance":4.033839,"location":[77.113089,28.544643]}],"code":"Ok","Server":"ETA-5100"}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/routing.yml","x-mappls-source-fingerprint":"efefba560f229b668f0c6025b18c9d37b34e1e4582023b2e9d1149c6f3e34bfa","x-mappls-evidence-score":60,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-rest-key-resources-profile-geopositions-4184121e97","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{REST_KEY}/{resources}/biking/{geopositions}":{"get":{"operationId":"core-location-get-rest-key-resources-biking-geopositions-routing-api-with-biking-profile","summary":"Routing API with biking profile","description":"Routing and displaying driving directions on map, including instructions for navigation, distance to destination, traffic etc. are few of the most important parts of developing a map based application. This REST API calculates driving routes between specified locations including via points based on route calculation type(optimal or shortest). Please note that maximum number of points are limited to 100 only including source and secondary positions. The MapmyIndia Bike Routing API takes into consideration routes where bikes are allowed to travel as well as those roads which might be non-navigable to larger vehicles. Live Demo | Download Sample Code","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-rest-key-resources-biking-geopositions-routing-api-with-biking-profile"},"parameters":[{"name":"REST_KEY","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}},{"name":"resources","in":"path","required":true,"description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources routeadv to calculate a route & its duration without considering traffic conditions. routeeta Not applicable with biking profile. routetraffic Not applicable with biking profile.","schema":{"type":"string","description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources routeadv to calculate a route & its duration without considering traffic conditions. routeeta Not applicable with biking profile. routetraffic Not applicable with biking profile.","enum":["route_adv"],"example":"route_adv"}},{"name":"geopositions","in":"path","required":true,"description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","schema":{"type":"string","description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","example":"28.612964,77.229463"}},{"name":"geometries","in":"query","required":false,"description":"This parameter used to change the route geometry format/density (influences overview and per step).","schema":{"type":"string","description":"This parameter used to change the route geometry format/density (influences overview and per step).","enum":["polyline","polyline6","geojson"],"example":"polyline"}},{"name":"steps","in":"query","required":false,"description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","schema":{"type":"boolean","description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","enum":[true,false],"example":true}},{"name":"exclude","in":"query","required":false,"description":"Additive list of road classes to avoid, order does not matter. Possible values are toll, motorway & ferry. Multiple values can be sent separated by comma.","schema":{"type":"string","description":"Additive list of road classes to avoid, order does not matter. Possible values are toll, motorway & ferry. Multiple values can be sent separated by comma.","example":"ferry"}},{"name":"bearings","in":"query","required":false,"description":"Limits the search to segments with given bearing in degrees. The referencing will be to the true north and in clockwise direction. (Part of premium offering)","schema":{"type":"integer","description":"Limits the search to segments with given bearing in degrees. The referencing will be to the true north and in clockwise direction. (Part of premium offering)","example":180}},{"name":"alternatives","in":"query","required":false,"description":"Search for alternative routes. Passing a number: e.g. alternatives=n searches for up to n alternative routes. Please note that even if alternative routes are requested, a result cannot be guaranteed.","schema":{"type":"integer","description":"Search for alternative routes. Passing a number: e.g. alternatives=n searches for up to n alternative routes. Please note that even if alternative routes are requested, a result cannot be guaranteed.","example":2}},{"name":"radiuses","in":"query","required":false,"description":"Limits the search to given radius in meters. For all way-points including start and end points. {radius};{radius}[;{radius} ...]. (Part of premium offering)","schema":{"type":"string","description":"Limits the search to given radius in meters. For all way-points including start and end points. {radius};{radius}[;{radius} ...]. (Part of premium offering)","example":"100;100"}},{"name":"overview","in":"query","required":false,"description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","schema":{"type":"string","description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","enum":["simplified","full",false],"example":"simplified"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"routes":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes"},"routes[].legs":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes[].legs"},"routes[].legs[].steps":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes[].legs[].steps"},"routes[].legs[].steps[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].legs[].steps[].weight"},"routes[].legs[].steps[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].legs[].steps[].distance"},"routes[].legs[].steps[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].legs[].steps[].duration"},"routes[].legs[].steps[].geometry":{"type":"number","description":"The un-simplified geometry of the step segment, depends on the given geometries request parameter. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].geometry"},"routes[].legs[].steps[].intersections":{"type":"array","items":{"type":"object"},"description":"A list of Intersection objects(1) that are passed along the segment, the very first belonging to the StepManeuver(2). Note: An intersection gives a full representation of any cross-way the path passes bay. For every step, the very first intersection (intersections[0]) corresponds to the location of the StepManeuver. Further intersections are listed for every cross-way until the next turn instruction. An object type representing maneuver.","example":"example","x-mappls-field-path":"routes[].legs[].steps[].intersections"},"routes[].legs[].steps[].intersections[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the location of the intersection.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].intersections[].location"},"routes[].legs[].steps[].intersections[].classes":{"type":"array","items":{"type":"string"},"description":"Categorised types of road segments e.g. Motorway","example":["motorway"],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].classes"},"routes[].legs[].steps[].intersections[].bearings":{"type":"array","items":{"type":"integer"},"description":"A list of bearing values (e.g. [0,90,180,270]) that are available at the intersection. The bearings describe all available roads at the intersection.","example":[60,210,240],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].bearings"},"routes[].legs[].steps[].intersections[].entry":{"type":"array","items":{"type":"boolean"},"description":"A list of entry flags, corresponding in a 1:1 relationship to the bearings. A value of true indicates that the respective road could be entered on a valid route. false indicates that the turn onto the respective road would violate a restriction.","example":[false,true,true],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].entry"},"routes[].legs[].steps[].intersections[].in":{"type":"integer","description":"index into bearings/entry array. Used to calculate the bearing just before the turn. Namely, the clockwise angle from true north to the direction of travel immediately before the maneuver/passing the intersection. Bearings are given relative to the intersection. To get the bearing in the direction of driving, the bearing has to be rotated by a value of 180. The value is not supplied for depart maneuvers.","example":0,"x-mappls-field-path":"routes[].legs[].steps[].intersections[].in"},"routes[].legs[].steps[].intersections[].out":{"type":"integer","description":"index into the bearings/entry array. Used to extract the bearing just after the turn. Namely, The clockwise angle from true north to the direction of travel immediately after the maneuver/passing the intersection. The value is not supplied for arrive maneuvers.","example":2,"x-mappls-field-path":"routes[].legs[].steps[].intersections[].out"},"routes[].legs[].steps[].intersections[].lanes":{"type":"array","items":{"type":"object"},"description":"Array of Lane objects that denote the available turn lanes at the intersection. If no lane information is available for an intersection, the lanes property will not be present.","example":"example","x-mappls-field-path":"routes[].legs[].steps[].intersections[].lanes"},"routes[].legs[].steps[].driving_side":{"type":"number","description":"“Left” (default) for India, Sri Lanka, Nepal, Bangladesh & Bhutan.","example":"left","x-mappls-field-path":"routes[].legs[].steps[].driving_side"},"routes[].legs[].steps[].name":{"type":"string","description":"The name of the way along which travel proceeds.","example":"Safdar Hashmi Marg","x-mappls-field-path":"routes[].legs[].steps[].name"},"routes[].legs[].steps[].mode":{"type":"string","description":"signifies the mode of transportation; driving as default.","example":"biking","x-mappls-field-path":"routes[].legs[].steps[].mode"},"routes[].legs[].steps[].maneuver":{"type":"object","example":"example","x-mappls-field-path":"routes[].legs[].steps[].maneuver"},"routes[].legs[].steps[].maneuver.location":{"type":"array","items":{"type":"string"},"description":"A [longitude, latitude] pair describing the location of the turn.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].maneuver.location"},"routes[].legs[].steps[].maneuver.bearing_before":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately before the maneuver.","example":357,"x-mappls-field-path":"routes[].legs[].steps[].maneuver.bearing_before"},"routes[].legs[].steps[].maneuver.bearing_after":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately after the maneuver.","example":254,"x-mappls-field-path":"routes[].legs[].steps[].maneuver.bearing_after"},"routes[].legs[].steps[].maneuver.modifier":{"type":"string","description":"An optional string indicating the direction change of the maneuver. To see the complete list of modifiers, please see article in wiki.","example":"left","x-mappls-field-path":"routes[].legs[].steps[].maneuver.modifier"},"routes[].legs[].steps[].maneuver.type":{"type":"string","description":"A string indicating the type of maneuver. New identifiers might be introduced without API change. Types unknown to the client should be handled like the ‘turn’ type, the existence of correct modifier values is guaranteed. To see the complete list of types, please see article in wiki.","example":"turn","x-mappls-field-path":"routes[].legs[].steps[].maneuver.type"},"routes[].legs[].summary":{"type":"number","description":"Parameter for internal purpose only.","example":"Patel Road, Bhagwan Mahavir Marg","x-mappls-field-path":"routes[].legs[].summary"},"routes[].legs[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].legs[].weight"},"routes[].legs[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].legs[].distance"},"routes[].legs[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].legs[].duration"},"routes[].weight_name":{"type":"number","description":"Parameter for internal purpose only.","example":"routability","x-mappls-field-path":"routes[].weight_name"},"routes[].geometry":{"type":"number","description":"Returns the whole geometry of the route as per given geometries request parameter. Default is encoded polyline with 5 digit accuracy (1e5) for positional coordinates. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].geometry"},"routes[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].weight"},"routes[].distance":{"type":"number","description":"The distance of travel, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].distance"},"routes[].duration":{"type":"number","description":"The estimated travel time, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].duration"},"waypoints":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"waypoints"},"waypoints[].hint":{"type":"string","description":"Unique internal identifier of the segment (ephemeral, not constant over data updates) This can be used on subsequent request to significantly speed up the query and to connect multiple services. E.g. you can use the hint value obtained by the nearest query as hint values for route inputs.","example":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","x-mappls-field-path":"waypoints[].hint"},"waypoints[].name":{"type":"string","description":"Name of the street the coordinate snapped to.","example":"Delhi Gurgaon Expressway","x-mappls-field-path":"waypoints[].name"},"waypoints[].distance":{"type":"number","description":"distance to snapped location from actual location.","example":4.033839,"x-mappls-field-path":"waypoints[].distance"},"waypoints[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the snapped location of the waypoint.","example":"28.612964,77.229463","x-mappls-field-path":"waypoints[].location"},"code":{"type":"string","description":"if request is successful, response is ‘ok’. Else, see the service dependent and general status codes as available in the enum. In case of error, “NoRoute” code is supported (in addition to the general ones) which means “no route found”. Ok : Request could be processed as expected. InvalidUrl : URL string is invalid. InvalidService: Service name is invalid. InvalidVersion : Version is not found. InvalidOptions : Options are invalid. InvalidQuery : The query string is synctactically malformed. Inv","enum":["Ok","InvalidUrl","InvalidService","InvalidVersion","InvalidOptions","InvalidQuery","InvalidValue","NoSegment","TooBig","NoRoute"],"example":"Ok","x-mappls-field-path":"code"},"Server":{"type":"string","description":"Gives Information on active service's server.","example":"ETA-5100","x-mappls-field-path":"Server"}},"required":["routes","routes[].legs","routes[].legs[].steps","routes[].legs[].steps[].weight","routes[].legs[].steps[].distance","routes[].legs[].steps[].duration","routes[].legs[].steps[].geometry","routes[].legs[].steps[].intersections","routes[].legs[].steps[].intersections[].location","routes[].legs[].steps[].intersections[].classes","routes[].legs[].steps[].intersections[].bearings","routes[].legs[].steps[].intersections[].entry","routes[].legs[].steps[].intersections[].in","routes[].legs[].steps[].intersections[].out","routes[].legs[].steps[].intersections[].lanes","routes[].legs[].steps[].driving_side","routes[].legs[].steps[].name","routes[].legs[].steps[].mode","routes[].legs[].steps[].maneuver","routes[].legs[].steps[].maneuver.location","routes[].legs[].steps[].maneuver.bearing_before","routes[].legs[].steps[].maneuver.bearing_after","routes[].legs[].steps[].maneuver.modifier","routes[].legs[].steps[].maneuver.type","routes[].legs[].summary","routes[].legs[].weight","routes[].legs[].distance","routes[].legs[].duration","routes[].weight_name","routes[].geometry","routes[].weight","routes[].distance","routes[].duration","waypoints","waypoints[].hint","waypoints[].name","waypoints[].distance","waypoints[].location","code","Server"]},"example":{"routes":[{"legs":[{"steps":"example","summary":"Patel Road, Bhagwan Mahavir Marg","weight":2282.2,"distance":2282.2,"duration":252.4}],"weight_name":"routability","geometry":"osgmDutwuMjA~@vEfGx@X~RlXLnAhGbJfHjQzBxDb@jEpAj@nAFt@`A?fAQn@aDbBcAhBmChQ","weight":2282.2,"distance":2282.2,"duration":252.4}],"waypoints":[{"hint":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","name":"Delhi Gurgaon Expressway","distance":4.033839,"location":[77.113089,28.544643]}],"code":"Ok","Server":"ETA-5100"}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/routingBiking.yml","x-mappls-source-fingerprint":"4db4c71b1f52c6349ebb4018feb139069eed8fddc1c4ca977135570de36d6885","x-mappls-evidence-score":57,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-rest-key-resources-biking-geopositions-157cd574e1","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{REST_KEY}/{resources}/driving/{geopositions}":{"get":{"operationId":"core-location-get-rest-key-resources-driving-geopositions-routing-api-with-driving-profile","summary":"Routing API with driving profile","description":"Routing and displaying driving directions on map, including instructions for navigation, distance to destination, traffic etc. are few of the most important parts of developing a map based application. This REST API calculates driving routes between specified locations including via points based on route calculation type(optimal or shortest). Please note that maximum number of points are limited to 100 only including source and secondary positions. Live Demo | Download Sample Code","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-rest-key-resources-driving-geopositions-routing-api-with-driving-profile"},"parameters":[{"name":"REST_KEY","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}},{"name":"resources","in":"path","required":true,"description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources routeadv to calculate a route & its duration without considering traffic conditions. routeeta to get the updated duration of a route considering live traffic; Applicable for India only “region=ind” and “rtype=1” is not supported. This is different from routetraffic ; this resource balances between a preferred path and aggressive traffic congestion avoidance. routetraf","schema":{"type":"string","description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources routeadv to calculate a route & its duration without considering traffic conditions. routeeta to get the updated duration of a route considering live traffic; Applicable for India only “region=ind” and “rtype=1” is not supported. This is different from routetraffic ; this resource balances between a preferred path and aggressive traffic congestion avoidance. routetraf","enum":["route_adv","route_eta","route_traffic"],"example":"route_eta"}},{"name":"geopositions","in":"path","required":true,"description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","schema":{"type":"string","description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","example":"28.612964,77.229463"}},{"name":"geometries","in":"query","required":false,"description":"This parameter used to change the route geometry format/density (influences overview and per step).","schema":{"type":"string","description":"This parameter used to change the route geometry format/density (influences overview and per step).","enum":["polyline","polyline6","geojson"],"example":"polyline"}},{"name":"rtype","in":"query","required":false,"description":"type of route (integer) required for navigation, where values mean: 0 optimal (default) 1 shortest (it will calculate route by excluding access penalties like private roads, etc.)","schema":{"type":"integer","description":"type of route (integer) required for navigation, where values mean: 0 optimal (default) 1 shortest (it will calculate route by excluding access penalties like private roads, etc.)","enum":[0,1],"example":0}},{"name":"steps","in":"query","required":false,"description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","schema":{"type":"boolean","description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","enum":[true,false],"example":true}},{"name":"exclude","in":"query","required":false,"description":"Additive list of road classes to avoid, order does not matter. Possible values are toll, motorway & ferry. Multiple values can be sent separated by comma.","schema":{"type":"string","description":"Additive list of road classes to avoid, order does not matter. Possible values are toll, motorway & ferry. Multiple values can be sent separated by comma.","example":"ferry"}},{"name":"region","in":"query","required":false,"description":"This parameter is optional for India; for other countries (such as Sri Lanka, Nepal, Bangladesh, Bhutan + many more) this parameter is mandatory. Possible values are listed in a table here.","schema":{"type":"string","description":"This parameter is optional for India; for other countries (such as Sri Lanka, Nepal, Bangladesh, Bhutan + many more) this parameter is mandatory. Possible values are listed in a table here.","example":"IND"}},{"name":"bearings","in":"query","required":false,"description":"Limits the search to segments with given bearing in degrees. The referencing will be to the true north and in clockwise direction. (Part of premium offering)","schema":{"type":"integer","description":"Limits the search to segments with given bearing in degrees. The referencing will be to the true north and in clockwise direction. (Part of premium offering)","example":180}},{"name":"alternatives","in":"query","required":false,"description":"Search for alternative routes. Passing a number: e.g. alternatives=n searches for up to n alternative routes. Please note that even if alternative routes are requested, a result cannot be guaranteed.","schema":{"type":"integer","description":"Search for alternative routes. Passing a number: e.g. alternatives=n searches for up to n alternative routes. Please note that even if alternative routes are requested, a result cannot be guaranteed.","example":2}},{"name":"radiuses","in":"query","required":false,"description":"Limits the search to given radius in meters. For all way-points including start and end points. {radius};{radius}[;{radius} ...]. (Part of premium offering)","schema":{"type":"string","description":"Limits the search to given radius in meters. For all way-points including start and end points. {radius};{radius}[;{radius} ...]. (Part of premium offering)","example":"100;100"}},{"name":"overview","in":"query","required":false,"description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","schema":{"type":"string","description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","enum":["simplified","full",false],"example":"simplified"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"routes":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes"},"routes[].legs":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes[].legs"},"routes[].legs[].steps":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes[].legs[].steps"},"routes[].legs[].steps[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].legs[].steps[].weight"},"routes[].legs[].steps[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].legs[].steps[].distance"},"routes[].legs[].steps[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].legs[].steps[].duration"},"routes[].legs[].steps[].geometry":{"type":"number","description":"The un-simplified geometry of the step segment, depends on the given geometries request parameter. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].geometry"},"routes[].legs[].steps[].intersections":{"type":"array","items":{"type":"object"},"description":"A list of Intersection objects(1) that are passed along the segment, the very first belonging to the StepManeuver(2). Note: An intersection gives a full representation of any cross-way the path passes bay. For every step, the very first intersection (intersections[0]) corresponds to the location of the StepManeuver. Further intersections are listed for every cross-way until the next turn instruction. An object type representing maneuver.","example":"example","x-mappls-field-path":"routes[].legs[].steps[].intersections"},"routes[].legs[].steps[].intersections[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the location of the intersection.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].intersections[].location"},"routes[].legs[].steps[].intersections[].classes":{"type":"array","items":{"type":"string"},"description":"Categorised types of road segments e.g. Motorway","example":["motorway"],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].classes"},"routes[].legs[].steps[].intersections[].bearings":{"type":"array","items":{"type":"integer"},"description":"A list of bearing values (e.g. [0,90,180,270]) that are available at the intersection. The bearings describe all available roads at the intersection.","example":[60,210,240],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].bearings"},"routes[].legs[].steps[].intersections[].entry":{"type":"array","items":{"type":"boolean"},"description":"A list of entry flags, corresponding in a 1:1 relationship to the bearings. A value of true indicates that the respective road could be entered on a valid route. false indicates that the turn onto the respective road would violate a restriction.","example":[false,true,true],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].entry"},"routes[].legs[].steps[].intersections[].in":{"type":"integer","description":"index into bearings/entry array. Used to calculate the bearing just before the turn. Namely, the clockwise angle from true north to the direction of travel immediately before the maneuver/passing the intersection. Bearings are given relative to the intersection. To get the bearing in the direction of driving, the bearing has to be rotated by a value of 180. The value is not supplied for depart maneuvers.","example":0,"x-mappls-field-path":"routes[].legs[].steps[].intersections[].in"},"routes[].legs[].steps[].intersections[].out":{"type":"integer","description":"index into the bearings/entry array. Used to extract the bearing just after the turn. Namely, The clockwise angle from true north to the direction of travel immediately after the maneuver/passing the intersection. The value is not supplied for arrive maneuvers.","example":2,"x-mappls-field-path":"routes[].legs[].steps[].intersections[].out"},"routes[].legs[].steps[].intersections[].lanes":{"type":"array","items":{"type":"object"},"description":"Array of Lane objects that denote the available turn lanes at the intersection. If no lane information is available for an intersection, the lanes property will not be present.","example":"example","x-mappls-field-path":"routes[].legs[].steps[].intersections[].lanes"},"routes[].legs[].steps[].driving_side":{"type":"number","description":"“Left” (default) for India, Sri Lanka, Nepal, Bangladesh & Bhutan.","example":"left","x-mappls-field-path":"routes[].legs[].steps[].driving_side"},"routes[].legs[].steps[].name":{"type":"string","description":"The name of the way along which travel proceeds.","example":"Safdar Hashmi Marg","x-mappls-field-path":"routes[].legs[].steps[].name"},"routes[].legs[].steps[].mode":{"type":"string","description":"signifies the mode of transportation; driving as default.","example":"driving","x-mappls-field-path":"routes[].legs[].steps[].mode"},"routes[].legs[].steps[].maneuver":{"type":"object","example":"example","x-mappls-field-path":"routes[].legs[].steps[].maneuver"},"routes[].legs[].steps[].maneuver.location":{"type":"array","items":{"type":"string"},"description":"A [longitude, latitude] pair describing the location of the turn.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].maneuver.location"},"routes[].legs[].steps[].maneuver.bearing_before":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately before the maneuver.","example":357,"x-mappls-field-path":"routes[].legs[].steps[].maneuver.bearing_before"},"routes[].legs[].steps[].maneuver.bearing_after":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately after the maneuver.","example":254,"x-mappls-field-path":"routes[].legs[].steps[].maneuver.bearing_after"},"routes[].legs[].steps[].maneuver.modifier":{"type":"string","description":"An optional string indicating the direction change of the maneuver. To see the complete list of modifiers, please see article in wiki.","example":"left","x-mappls-field-path":"routes[].legs[].steps[].maneuver.modifier"},"routes[].legs[].steps[].maneuver.type":{"type":"string","description":"A string indicating the type of maneuver. New identifiers might be introduced without API change. Types unknown to the client should be handled like the ‘turn’ type, the existence of correct modifier values is guaranteed. To see the complete list of types, please see article in wiki.","example":"turn","x-mappls-field-path":"routes[].legs[].steps[].maneuver.type"},"routes[].legs[].summary":{"type":"number","description":"Parameter for internal purpose only.","example":"Patel Road, Bhagwan Mahavir Marg","x-mappls-field-path":"routes[].legs[].summary"},"routes[].legs[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].legs[].weight"},"routes[].legs[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].legs[].distance"},"routes[].legs[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].legs[].duration"},"routes[].weight_name":{"type":"number","description":"Parameter for internal purpose only.","example":"routability","x-mappls-field-path":"routes[].weight_name"},"routes[].geometry":{"type":"number","description":"Returns the whole geometry of the route as per given geometries request parameter. Default is encoded polyline with 5 digit accuracy (1e5) for positional coordinates. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].geometry"},"routes[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].weight"},"routes[].distance":{"type":"number","description":"The distance of travel, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].distance"},"routes[].duration":{"type":"number","description":"The estimated travel time, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].duration"},"waypoints":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"waypoints"},"waypoints[].hint":{"type":"string","description":"Unique internal identifier of the segment (ephemeral, not constant over data updates) This can be used on subsequent request to significantly speed up the query and to connect multiple services. E.g. you can use the hint value obtained by the nearest query as hint values for route inputs.","example":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","x-mappls-field-path":"waypoints[].hint"},"waypoints[].name":{"type":"string","description":"Name of the street the coordinate snapped to.","example":"Delhi Gurgaon Expressway","x-mappls-field-path":"waypoints[].name"},"waypoints[].distance":{"type":"number","description":"distance to snapped location from actual location.","example":4.033839,"x-mappls-field-path":"waypoints[].distance"},"waypoints[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the snapped location of the waypoint.","example":"28.612964,77.229463","x-mappls-field-path":"waypoints[].location"},"code":{"type":"string","description":"if request is successful, response is ‘ok’. Else, see the service dependent and general status codes as available in the enum. In case of error, “NoRoute” code is supported (in addition to the general ones) which means “no route found”. Ok : Request could be processed as expected. InvalidUrl : URL string is invalid. InvalidService: Service name is invalid. InvalidVersion : Version is not found. InvalidOptions : Options are invalid. InvalidQuery : The query string is synctactically malformed. Inv","enum":["Ok","InvalidUrl","InvalidService","InvalidVersion","InvalidOptions","InvalidQuery","InvalidValue","NoSegment","TooBig","NoRoute"],"example":"Ok","x-mappls-field-path":"code"},"Server":{"type":"string","description":"Gives Information on active service's server.","example":"ETA-5100","x-mappls-field-path":"Server"}},"required":["routes","routes[].legs","routes[].legs[].steps","routes[].legs[].steps[].weight","routes[].legs[].steps[].distance","routes[].legs[].steps[].duration","routes[].legs[].steps[].geometry","routes[].legs[].steps[].intersections","routes[].legs[].steps[].intersections[].location","routes[].legs[].steps[].intersections[].classes","routes[].legs[].steps[].intersections[].bearings","routes[].legs[].steps[].intersections[].entry","routes[].legs[].steps[].intersections[].in","routes[].legs[].steps[].intersections[].out","routes[].legs[].steps[].intersections[].lanes","routes[].legs[].steps[].driving_side","routes[].legs[].steps[].name","routes[].legs[].steps[].mode","routes[].legs[].steps[].maneuver","routes[].legs[].steps[].maneuver.location","routes[].legs[].steps[].maneuver.bearing_before","routes[].legs[].steps[].maneuver.bearing_after","routes[].legs[].steps[].maneuver.modifier","routes[].legs[].steps[].maneuver.type","routes[].legs[].summary","routes[].legs[].weight","routes[].legs[].distance","routes[].legs[].duration","routes[].weight_name","routes[].geometry","routes[].weight","routes[].distance","routes[].duration","waypoints","waypoints[].hint","waypoints[].name","waypoints[].distance","waypoints[].location","code","Server"]},"example":{"routes":[{"legs":[{"steps":"example","summary":"Patel Road, Bhagwan Mahavir Marg","weight":2282.2,"distance":2282.2,"duration":252.4}],"weight_name":"routability","geometry":"osgmDutwuMjA~@vEfGx@X~RlXLnAhGbJfHjQzBxDb@jEpAj@nAFt@`A?fAQn@aDbBcAhBmChQ","weight":2282.2,"distance":2282.2,"duration":252.4}],"waypoints":[{"hint":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","name":"Delhi Gurgaon Expressway","distance":4.033839,"location":[77.113089,28.544643]}],"code":"Ok","Server":"ETA-5100"}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/routingDriving.yml","x-mappls-source-fingerprint":"5134fc7e305ab1b69eed37d863eba09a00e66d5b56be03c4d8a873277ee7c1b0","x-mappls-evidence-score":59,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-rest-key-resources-driving-geopositions-55fe3b1940","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{REST_KEY}/{resources}/trucking/{geopositions}":{"get":{"operationId":"core-location-get-rest-key-resources-trucking-geopositions-routing-api-with-trucking-profile","summary":"Routing API with trucking profile","description":"Routing and displaying driving directions on map, including instructions for navigation, distance to destination, traffic etc. are few of the most important parts of developing a map based application. This REST API calculates driving routes between specified locations including via points based on route calculation type(optimal or shortest). Please note that maximum number of points are limited to 100 only including source and secondary positions. MapmyIndia Truck Routing API calculates routes optimized for trucks and other commercial vehicles. Designed for professional transportation routing logistics, the API calculates safe and efficient routes that consider a vehicle’s attributes in relation to any route limitations. It also uses live traffic to determine precise ETAs, especially for areas that tend to be more congested. The routes include information such as route instructions, travel duration, and travel distance. Live Demo | Download Sample Code","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-rest-key-resources-trucking-geopositions-routing-api-with-trucking-profile"},"parameters":[{"name":"REST_KEY","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}},{"name":"resources","in":"path","required":true,"description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources routeadv to calculate a route & its duration without considering traffic conditions. routeeta Not applicable with trucking profile. routetraffic Not applicable with trucking profile.","schema":{"type":"string","description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources routeadv to calculate a route & its duration without considering traffic conditions. routeeta Not applicable with trucking profile. routetraffic Not applicable with trucking profile.","enum":["route_adv"],"example":"route_adv"}},{"name":"geopositions","in":"path","required":true,"description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","schema":{"type":"string","description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","example":"28.612964,77.229463"}},{"name":"geometries","in":"query","required":false,"description":"This parameter used to change the route geometry format/density (influences overview and per step).","schema":{"type":"string","description":"This parameter used to change the route geometry format/density (influences overview and per step).","enum":["polyline","polyline6","geojson"],"example":"polyline"}},{"name":"steps","in":"query","required":false,"description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","schema":{"type":"boolean","description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","enum":[true,false],"example":true}},{"name":"exclude","in":"query","required":false,"description":"Additive list of road classes to avoid, order does not matter. Possible values are toll, motorway & ferry. Multiple values can be sent separated by comma.","schema":{"type":"string","description":"Additive list of road classes to avoid, order does not matter. Possible values are toll, motorway & ferry. Multiple values can be sent separated by comma.","example":"ferry"}},{"name":"bearings","in":"query","required":false,"description":"Limits the search to segments with given bearing in degrees. The referencing will be to the true north and in clockwise direction. (Part of premium offering)","schema":{"type":"integer","description":"Limits the search to segments with given bearing in degrees. The referencing will be to the true north and in clockwise direction. (Part of premium offering)","example":180}},{"name":"alternatives","in":"query","required":false,"description":"Search for alternative routes. Passing a number: e.g. alternatives=n searches for up to n alternative routes. Please note that even if alternative routes are requested, a result cannot be guaranteed.","schema":{"type":"integer","description":"Search for alternative routes. Passing a number: e.g. alternatives=n searches for up to n alternative routes. Please note that even if alternative routes are requested, a result cannot be guaranteed.","example":2}},{"name":"radiuses","in":"query","required":false,"description":"Limits the search to given radius in meters. For all way-points including start and end points. {radius};{radius}[;{radius} ...]. (Part of premium offering)","schema":{"type":"string","description":"Limits the search to given radius in meters. For all way-points including start and end points. {radius};{radius}[;{radius} ...]. (Part of premium offering)","example":"100;100"}},{"name":"overview","in":"query","required":false,"description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","schema":{"type":"string","description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","enum":["simplified","full",false],"example":"simplified"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"routes":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes"},"routes[].legs":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes[].legs"},"routes[].legs[].steps":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes[].legs[].steps"},"routes[].legs[].steps[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].legs[].steps[].weight"},"routes[].legs[].steps[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].legs[].steps[].distance"},"routes[].legs[].steps[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].legs[].steps[].duration"},"routes[].legs[].steps[].geometry":{"type":"number","description":"The un-simplified geometry of the step segment, depends on the given geometries request parameter. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].geometry"},"routes[].legs[].steps[].intersections":{"type":"array","items":{"type":"object"},"description":"A list of Intersection objects(1) that are passed along the segment, the very first belonging to the StepManeuver(2). Note: An intersection gives a full representation of any cross-way the path passes bay. For every step, the very first intersection (intersections[0]) corresponds to the location of the StepManeuver. Further intersections are listed for every cross-way until the next turn instruction. An object type representing maneuver.","example":"example","x-mappls-field-path":"routes[].legs[].steps[].intersections"},"routes[].legs[].steps[].intersections[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the location of the intersection.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].intersections[].location"},"routes[].legs[].steps[].intersections[].classes":{"type":"array","items":{"type":"string"},"description":"Categorised types of road segments e.g. Motorway","example":["motorway"],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].classes"},"routes[].legs[].steps[].intersections[].bearings":{"type":"array","items":{"type":"integer"},"description":"A list of bearing values (e.g. [0,90,180,270]) that are available at the intersection. The bearings describe all available roads at the intersection.","example":[60,210,240],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].bearings"},"routes[].legs[].steps[].intersections[].entry":{"type":"array","items":{"type":"boolean"},"description":"A list of entry flags, corresponding in a 1:1 relationship to the bearings. A value of true indicates that the respective road could be entered on a valid route. false indicates that the turn onto the respective road would violate a restriction.","example":[false,true,true],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].entry"},"routes[].legs[].steps[].intersections[].in":{"type":"integer","description":"index into bearings/entry array. Used to calculate the bearing just before the turn. Namely, the clockwise angle from true north to the direction of travel immediately before the maneuver/passing the intersection. Bearings are given relative to the intersection. To get the bearing in the direction of driving, the bearing has to be rotated by a value of 180. The value is not supplied for depart maneuvers.","example":0,"x-mappls-field-path":"routes[].legs[].steps[].intersections[].in"},"routes[].legs[].steps[].intersections[].out":{"type":"integer","description":"index into the bearings/entry array. Used to extract the bearing just after the turn. Namely, The clockwise angle from true north to the direction of travel immediately after the maneuver/passing the intersection. The value is not supplied for arrive maneuvers.","example":2,"x-mappls-field-path":"routes[].legs[].steps[].intersections[].out"},"routes[].legs[].steps[].intersections[].lanes":{"type":"array","items":{"type":"object"},"description":"Array of Lane objects that denote the available turn lanes at the intersection. If no lane information is available for an intersection, the lanes property will not be present.","example":"example","x-mappls-field-path":"routes[].legs[].steps[].intersections[].lanes"},"routes[].legs[].steps[].driving_side":{"type":"number","description":"“Left” (default) for India, Sri Lanka, Nepal, Bangladesh & Bhutan.","example":"left","x-mappls-field-path":"routes[].legs[].steps[].driving_side"},"routes[].legs[].steps[].name":{"type":"string","description":"The name of the way along which travel proceeds.","example":"Safdar Hashmi Marg","x-mappls-field-path":"routes[].legs[].steps[].name"},"routes[].legs[].steps[].mode":{"type":"string","description":"signifies the mode of transportation; driving as default.","example":"trucking","x-mappls-field-path":"routes[].legs[].steps[].mode"},"routes[].legs[].steps[].maneuver":{"type":"object","example":"example","x-mappls-field-path":"routes[].legs[].steps[].maneuver"},"routes[].legs[].steps[].maneuver.location":{"type":"array","items":{"type":"string"},"description":"A [longitude, latitude] pair describing the location of the turn.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].maneuver.location"},"routes[].legs[].steps[].maneuver.bearing_before":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately before the maneuver.","example":357,"x-mappls-field-path":"routes[].legs[].steps[].maneuver.bearing_before"},"routes[].legs[].steps[].maneuver.bearing_after":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately after the maneuver.","example":254,"x-mappls-field-path":"routes[].legs[].steps[].maneuver.bearing_after"},"routes[].legs[].steps[].maneuver.modifier":{"type":"string","description":"An optional string indicating the direction change of the maneuver. To see the complete list of modifiers, please see article in wiki.","example":"left","x-mappls-field-path":"routes[].legs[].steps[].maneuver.modifier"},"routes[].legs[].steps[].maneuver.type":{"type":"string","description":"A string indicating the type of maneuver. New identifiers might be introduced without API change. Types unknown to the client should be handled like the ‘turn’ type, the existence of correct modifier values is guaranteed. To see the complete list of types, please see article in wiki.","example":"turn","x-mappls-field-path":"routes[].legs[].steps[].maneuver.type"},"routes[].legs[].summary":{"type":"number","description":"Parameter for internal purpose only.","example":"Patel Road, Bhagwan Mahavir Marg","x-mappls-field-path":"routes[].legs[].summary"},"routes[].legs[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].legs[].weight"},"routes[].legs[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].legs[].distance"},"routes[].legs[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].legs[].duration"},"routes[].weight_name":{"type":"number","description":"Parameter for internal purpose only.","example":"routability","x-mappls-field-path":"routes[].weight_name"},"routes[].geometry":{"type":"number","description":"Returns the whole geometry of the route as per given geometries request parameter. Default is encoded polyline with 5 digit accuracy (1e5) for positional coordinates. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].geometry"},"routes[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].weight"},"routes[].distance":{"type":"number","description":"The distance of travel, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].distance"},"routes[].duration":{"type":"number","description":"The estimated travel time, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].duration"},"waypoints":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"waypoints"},"waypoints[].hint":{"type":"string","description":"Unique internal identifier of the segment (ephemeral, not constant over data updates) This can be used on subsequent request to significantly speed up the query and to connect multiple services. E.g. you can use the hint value obtained by the nearest query as hint values for route inputs.","example":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","x-mappls-field-path":"waypoints[].hint"},"waypoints[].name":{"type":"string","description":"Name of the street the coordinate snapped to.","example":"Delhi Gurgaon Expressway","x-mappls-field-path":"waypoints[].name"},"waypoints[].distance":{"type":"number","description":"distance to snapped location from actual location.","example":4.033839,"x-mappls-field-path":"waypoints[].distance"},"waypoints[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the snapped location of the waypoint.","example":"28.612964,77.229463","x-mappls-field-path":"waypoints[].location"},"code":{"type":"string","description":"if request is successful, response is ‘ok’. Else, see the service dependent and general status codes as available in the enum. In case of error, “NoRoute” code is supported (in addition to the general ones) which means “no route found”. Ok : Request could be processed as expected. InvalidUrl : URL string is invalid. InvalidService: Service name is invalid. InvalidVersion : Version is not found. InvalidOptions : Options are invalid. InvalidQuery : The query string is synctactically malformed. Inv","enum":["Ok","InvalidUrl","InvalidService","InvalidVersion","InvalidOptions","InvalidQuery","InvalidValue","NoSegment","TooBig","NoRoute"],"example":"Ok","x-mappls-field-path":"code"},"Server":{"type":"string","description":"Gives Information on active service's server.","example":"ETA-5100","x-mappls-field-path":"Server"}},"required":["routes","routes[].legs","routes[].legs[].steps","routes[].legs[].steps[].weight","routes[].legs[].steps[].distance","routes[].legs[].steps[].duration","routes[].legs[].steps[].geometry","routes[].legs[].steps[].intersections","routes[].legs[].steps[].intersections[].location","routes[].legs[].steps[].intersections[].classes","routes[].legs[].steps[].intersections[].bearings","routes[].legs[].steps[].intersections[].entry","routes[].legs[].steps[].intersections[].in","routes[].legs[].steps[].intersections[].out","routes[].legs[].steps[].intersections[].lanes","routes[].legs[].steps[].driving_side","routes[].legs[].steps[].name","routes[].legs[].steps[].mode","routes[].legs[].steps[].maneuver","routes[].legs[].steps[].maneuver.location","routes[].legs[].steps[].maneuver.bearing_before","routes[].legs[].steps[].maneuver.bearing_after","routes[].legs[].steps[].maneuver.modifier","routes[].legs[].steps[].maneuver.type","routes[].legs[].summary","routes[].legs[].weight","routes[].legs[].distance","routes[].legs[].duration","routes[].weight_name","routes[].geometry","routes[].weight","routes[].distance","routes[].duration","waypoints","waypoints[].hint","waypoints[].name","waypoints[].distance","waypoints[].location","code","Server"]},"example":{"routes":[{"legs":[{"steps":"example","summary":"Patel Road, Bhagwan Mahavir Marg","weight":2282.2,"distance":2282.2,"duration":252.4}],"weight_name":"routability","geometry":"osgmDutwuMjA~@vEfGx@X~RlXLnAhGbJfHjQzBxDb@jEpAj@nAFt@`A?fAQn@aDbBcAhBmChQ","weight":2282.2,"distance":2282.2,"duration":252.4}],"waypoints":[{"hint":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","name":"Delhi Gurgaon Expressway","distance":4.033839,"location":[77.113089,28.544643]}],"code":"Ok","Server":"ETA-5100"}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/routingTrucking.yml","x-mappls-source-fingerprint":"2685329864843d46d1b427f3248758663730e771232253e94028a54e8c4e510a","x-mappls-evidence-score":57,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-rest-key-resources-trucking-geopositions-0ed7ab839f","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{REST_KEY}/{resources}/walking/{geopositions}":{"get":{"operationId":"core-location-get-rest-key-resources-walking-geopositions-routing-api-with-walking-profile","summary":"Routing API with walking profile","description":"Routing and displaying driving directions on map, including instructions for navigation, distance to destination, traffic etc. are few of the most important parts of developing a map based application. This REST API calculates driving routes between specified locations including via points based on route calculation type(optimal or shortest). Please note that maximum number of points are limited to 100 only including source and secondary positions. MapmyIndia Pedestrian Routing API calculates the best route for pedestrians. It takes into account how easy it is for pedestrians to maneuver between links in the route while disregarding traffic conditions. The API recommends actions that are relevant for pedestrians and the maneuver instructions contain texts that are suitable for someone who is walking. Live Demo | Download Sample Code","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-rest-key-resources-walking-geopositions-routing-api-with-walking-profile"},"parameters":[{"name":"REST_KEY","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}},{"name":"resources","in":"path","required":true,"description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources routeadv to calculate a route & its duration without considering traffic conditions. routeeta Not applicable with walking profile. routetraffic Not applicable with walking profile.","schema":{"type":"string","description":"The different resources available within MapmyIndia Routing API. These resources have their own individual allocations and not all are allocated for evalulations be default. For allocating particular resource on your API credentials, please contact apisupport@mapmyindia.com Table 1. Resources Element Value Description Resources routeadv to calculate a route & its duration without considering traffic conditions. routeeta Not applicable with walking profile. routetraffic Not applicable with walking profile.","enum":["route_adv"],"example":"route_adv"}},{"name":"geopositions","in":"path","required":true,"description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","schema":{"type":"string","description":"geopositions(part of URL) are either: pair of comma separated longitude & latitude values OR eLoc(s). First geoposition will be consider as start point (mandatory); a last geoposition will be considered as end point (mandatory) and those in between are via points (optional). {longitude1},{latitude1};{longitude2},{latitude2};eLoc1;eLoc2; ... (part of URL).","example":"28.612964,77.229463"}},{"name":"geometries","in":"query","required":false,"description":"This parameter used to change the route geometry format/density (influences overview and per step).","schema":{"type":"string","description":"This parameter used to change the route geometry format/density (influences overview and per step).","enum":["polyline","polyline6","geojson"],"example":"polyline"}},{"name":"steps","in":"query","required":false,"description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","schema":{"type":"boolean","description":"Return route steps for each route leg. Possible values are true/false. By default it will be used as false.","enum":[true,false],"example":true}},{"name":"exclude","in":"query","required":false,"description":"Additive list of road classes to avoid, order does not matter. Possible values are toll, motorway & ferry. Multiple values can be sent separated by comma.","schema":{"type":"string","description":"Additive list of road classes to avoid, order does not matter. Possible values are toll, motorway & ferry. Multiple values can be sent separated by comma.","example":"ferry"}},{"name":"bearings","in":"query","required":false,"description":"Limits the search to segments with given bearing in degrees. The referencing will be to the true north and in clockwise direction. (Part of premium offering)","schema":{"type":"integer","description":"Limits the search to segments with given bearing in degrees. The referencing will be to the true north and in clockwise direction. (Part of premium offering)","example":180}},{"name":"alternatives","in":"query","required":false,"description":"Search for alternative routes. Passing a number: e.g. alternatives=n searches for up to n alternative routes. Please note that even if alternative routes are requested, a result cannot be guaranteed.","schema":{"type":"integer","description":"Search for alternative routes. Passing a number: e.g. alternatives=n searches for up to n alternative routes. Please note that even if alternative routes are requested, a result cannot be guaranteed.","example":2}},{"name":"radiuses","in":"query","required":false,"description":"Limits the search to given radius in meters. For all way-points including start and end points. {radius};{radius}[;{radius} ...]. (Part of premium offering)","schema":{"type":"string","description":"Limits the search to given radius in meters. For all way-points including start and end points. {radius};{radius}[;{radius} ...]. (Part of premium offering)","example":"100;100"}},{"name":"overview","in":"query","required":false,"description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","schema":{"type":"string","description":"Add overview geometry either full, simplified according to highest zoom level it could be display on, or not at all. Possible values are simplified (default), full , false . (Part of premium offering)","enum":["simplified","full",false],"example":"simplified"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"routes":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes"},"routes[].legs":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes[].legs"},"routes[].legs[].steps":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"routes[].legs[].steps"},"routes[].legs[].steps[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].legs[].steps[].weight"},"routes[].legs[].steps[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].legs[].steps[].distance"},"routes[].legs[].steps[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].legs[].steps[].duration"},"routes[].legs[].steps[].geometry":{"type":"number","description":"The un-simplified geometry of the step segment, depends on the given geometries request parameter. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].geometry"},"routes[].legs[].steps[].intersections":{"type":"array","items":{"type":"object"},"description":"A list of Intersection objects(1) that are passed along the segment, the very first belonging to the StepManeuver(2). Note: An intersection gives a full representation of any cross-way the path passes bay. For every step, the very first intersection (intersections[0]) corresponds to the location of the StepManeuver. Further intersections are listed for every cross-way until the next turn instruction. An object type representing maneuver.","example":"example","x-mappls-field-path":"routes[].legs[].steps[].intersections"},"routes[].legs[].steps[].intersections[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the location of the intersection.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].intersections[].location"},"routes[].legs[].steps[].intersections[].classes":{"type":"array","items":{"type":"string"},"description":"Categorised types of road segments e.g. Motorway","example":["motorway"],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].classes"},"routes[].legs[].steps[].intersections[].bearings":{"type":"array","items":{"type":"integer"},"description":"A list of bearing values (e.g. [0,90,180,270]) that are available at the intersection. The bearings describe all available roads at the intersection.","example":[60,210,240],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].bearings"},"routes[].legs[].steps[].intersections[].entry":{"type":"array","items":{"type":"boolean"},"description":"A list of entry flags, corresponding in a 1:1 relationship to the bearings. A value of true indicates that the respective road could be entered on a valid route. false indicates that the turn onto the respective road would violate a restriction.","example":[false,true,true],"x-mappls-field-path":"routes[].legs[].steps[].intersections[].entry"},"routes[].legs[].steps[].intersections[].in":{"type":"integer","description":"index into bearings/entry array. Used to calculate the bearing just before the turn. Namely, the clockwise angle from true north to the direction of travel immediately before the maneuver/passing the intersection. Bearings are given relative to the intersection. To get the bearing in the direction of driving, the bearing has to be rotated by a value of 180. The value is not supplied for depart maneuvers.","example":0,"x-mappls-field-path":"routes[].legs[].steps[].intersections[].in"},"routes[].legs[].steps[].intersections[].out":{"type":"integer","description":"index into the bearings/entry array. Used to extract the bearing just after the turn. Namely, The clockwise angle from true north to the direction of travel immediately after the maneuver/passing the intersection. The value is not supplied for arrive maneuvers.","example":2,"x-mappls-field-path":"routes[].legs[].steps[].intersections[].out"},"routes[].legs[].steps[].intersections[].lanes":{"type":"array","items":{"type":"object"},"description":"Array of Lane objects that denote the available turn lanes at the intersection. If no lane information is available for an intersection, the lanes property will not be present.","example":"example","x-mappls-field-path":"routes[].legs[].steps[].intersections[].lanes"},"routes[].legs[].steps[].driving_side":{"type":"number","description":"“Left” (default) for India, Sri Lanka, Nepal, Bangladesh & Bhutan.","example":"left","x-mappls-field-path":"routes[].legs[].steps[].driving_side"},"routes[].legs[].steps[].name":{"type":"string","description":"The name of the way along which travel proceeds.","example":"Safdar Hashmi Marg","x-mappls-field-path":"routes[].legs[].steps[].name"},"routes[].legs[].steps[].mode":{"type":"string","description":"signifies the mode of transportation; driving as default.","example":"walking","x-mappls-field-path":"routes[].legs[].steps[].mode"},"routes[].legs[].steps[].maneuver":{"type":"object","example":"example","x-mappls-field-path":"routes[].legs[].steps[].maneuver"},"routes[].legs[].steps[].maneuver.location":{"type":"array","items":{"type":"string"},"description":"A [longitude, latitude] pair describing the location of the turn.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].legs[].steps[].maneuver.location"},"routes[].legs[].steps[].maneuver.bearing_before":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately before the maneuver.","example":357,"x-mappls-field-path":"routes[].legs[].steps[].maneuver.bearing_before"},"routes[].legs[].steps[].maneuver.bearing_after":{"type":"integer","description":"The clockwise angle from true north to the direction of travel immediately after the maneuver.","example":254,"x-mappls-field-path":"routes[].legs[].steps[].maneuver.bearing_after"},"routes[].legs[].steps[].maneuver.modifier":{"type":"string","description":"An optional string indicating the direction change of the maneuver. To see the complete list of modifiers, please see article in wiki.","example":"left","x-mappls-field-path":"routes[].legs[].steps[].maneuver.modifier"},"routes[].legs[].steps[].maneuver.type":{"type":"string","description":"A string indicating the type of maneuver. New identifiers might be introduced without API change. Types unknown to the client should be handled like the ‘turn’ type, the existence of correct modifier values is guaranteed. To see the complete list of types, please see article in wiki.","example":"turn","x-mappls-field-path":"routes[].legs[].steps[].maneuver.type"},"routes[].legs[].summary":{"type":"number","description":"Parameter for internal purpose only.","example":"Patel Road, Bhagwan Mahavir Marg","x-mappls-field-path":"routes[].legs[].summary"},"routes[].legs[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].legs[].weight"},"routes[].legs[].distance":{"type":"number","description":"The distance of travel in the leg, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].legs[].distance"},"routes[].legs[].duration":{"type":"number","description":"The estimated travel time in the leg, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].legs[].duration"},"routes[].weight_name":{"type":"number","description":"Parameter for internal purpose only.","example":"routability","x-mappls-field-path":"routes[].weight_name"},"routes[].geometry":{"type":"number","description":"Returns the whole geometry of the route as per given geometries request parameter. Default is encoded polyline with 5 digit accuracy (1e5) for positional coordinates. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"routes[].geometry"},"routes[].weight":{"type":"number","description":"Parameter for internal purpose only.","example":2282.2,"x-mappls-field-path":"routes[].weight"},"routes[].distance":{"type":"number","description":"The distance of travel, in float meters.","example":2282.2,"x-mappls-field-path":"routes[].distance"},"routes[].duration":{"type":"number","description":"The estimated travel time, in float number of seconds.","example":252.4,"x-mappls-field-path":"routes[].duration"},"waypoints":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"waypoints"},"waypoints[].hint":{"type":"string","description":"Unique internal identifier of the segment (ephemeral, not constant over data updates) This can be used on subsequent request to significantly speed up the query and to connect multiple services. E.g. you can use the hint value obtained by the nearest query as hint values for route inputs.","example":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","x-mappls-field-path":"waypoints[].hint"},"waypoints[].name":{"type":"string","description":"Name of the street the coordinate snapped to.","example":"Delhi Gurgaon Expressway","x-mappls-field-path":"waypoints[].name"},"waypoints[].distance":{"type":"number","description":"distance to snapped location from actual location.","example":4.033839,"x-mappls-field-path":"waypoints[].distance"},"waypoints[].location":{"type":"array","items":{"type":"string"},"description":"longitude, latitude pair describing the snapped location of the waypoint.","example":"28.612964,77.229463","x-mappls-field-path":"waypoints[].location"},"code":{"type":"string","description":"if request is successful, response is ‘ok’. Else, see the service dependent and general status codes as available in the enum. In case of error, “NoRoute” code is supported (in addition to the general ones) which means “no route found”. Ok : Request could be processed as expected. InvalidUrl : URL string is invalid. InvalidService: Service name is invalid. InvalidVersion : Version is not found. InvalidOptions : Options are invalid. InvalidQuery : The query string is synctactically malformed. Inv","enum":["Ok","InvalidUrl","InvalidService","InvalidVersion","InvalidOptions","InvalidQuery","InvalidValue","NoSegment","TooBig","NoRoute"],"example":"Ok","x-mappls-field-path":"code"},"Server":{"type":"string","description":"Gives Information on active service's server.","example":"ETA-5100","x-mappls-field-path":"Server"}},"required":["routes","routes[].legs","routes[].legs[].steps","routes[].legs[].steps[].weight","routes[].legs[].steps[].distance","routes[].legs[].steps[].duration","routes[].legs[].steps[].geometry","routes[].legs[].steps[].intersections","routes[].legs[].steps[].intersections[].location","routes[].legs[].steps[].intersections[].classes","routes[].legs[].steps[].intersections[].bearings","routes[].legs[].steps[].intersections[].entry","routes[].legs[].steps[].intersections[].in","routes[].legs[].steps[].intersections[].out","routes[].legs[].steps[].intersections[].lanes","routes[].legs[].steps[].driving_side","routes[].legs[].steps[].name","routes[].legs[].steps[].mode","routes[].legs[].steps[].maneuver","routes[].legs[].steps[].maneuver.location","routes[].legs[].steps[].maneuver.bearing_before","routes[].legs[].steps[].maneuver.bearing_after","routes[].legs[].steps[].maneuver.modifier","routes[].legs[].steps[].maneuver.type","routes[].legs[].summary","routes[].legs[].weight","routes[].legs[].distance","routes[].legs[].duration","routes[].weight_name","routes[].geometry","routes[].weight","routes[].distance","routes[].duration","waypoints","waypoints[].hint","waypoints[].name","waypoints[].distance","waypoints[].location","code","Server"]},"example":{"routes":[{"legs":[{"steps":"example","summary":"Patel Road, Bhagwan Mahavir Marg","weight":2282.2,"distance":2282.2,"duration":252.4}],"weight_name":"routability","geometry":"osgmDutwuMjA~@vEfGx@X~RlXLnAhGbJfHjQzBxDb@jEpAj@nAFt@`A?fAQn@aDbBcAhBmChQ","weight":2282.2,"distance":2282.2,"duration":252.4}],"waypoints":[{"hint":"bEADgP___39tAAAA6QAAAChAAAB4CAAASdEuQaohRUHInMxEeg6MQwYAAAANAAAArAMAAHwAAADoAAAAiu2YBNCsswFz7ZgE3ayzAQ8AXw3Mm4K5","name":"Delhi Gurgaon Expressway","distance":4.033839,"location":[77.113089,28.544643]}],"code":"Ok","Server":"ETA-5100"}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/routingWalking.yml","x-mappls-source-fingerprint":"dd614ed88ba528548b43633bcdf89d01b25ae8d906e32c00ab61fa3fe5b76d63","x-mappls-evidence-score":57,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-rest-key-resources-walking-geopositions-04688a170b","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{REST_KEY}/snapToRoad":{"post":{"operationId":"core-location-post-rest-key-snaptoroad-snap-to-road-api","summary":"Snap to Road API","description":"Snap-To-Road API, snaps given GPS points to the road network in the most plausible way. Maximum number of points are limited to 100 only. Our USP is to take GPS points collected along a route and return a similar set of corrected & aligned data with the points matched to the road with our intelligent Snap To Road API. Now seamlessly calculate accurate distances from points which follow the geometry of the road & show accurate positions on map. This API provides a critical feature that is immensely valuable when tracking assets and for data analytics of path traversed by vehicle, people or assets. Note : The request might result multiple sub-traces. Large jumps in the timestamps (> 60s) or improbable transitions lead to trace splits if a complete matching could not be found. The algorithm might not be able to match all points. Outliers are removed if they cannot be matched successfully. Live Demo","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-post-rest-key-snaptoroad-snap-to-road-api"},"parameters":[{"name":"REST_KEY","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}}],"requestBody":{"required":false,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","additionalProperties":true,"properties":{"pts":{"type":"string","description":"Coordinate is pair of comma separated longitude & latitude value, First coordinate will be consider as start point; a last coordinate will be as end points and between are via points; like {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...]. At present maximum number of points are limited to 100 in a single request.","example":"78.40573,17.37317;78.40958,17.37314;78.41845,17.37449;78.409992,17.37328;78.420460,17.377443;78.421350,17.380200","x-mappls-field-path":"pts"},"timestamps":{"type":"string","description":"Timestamps for the input locations in seconds since UNIX epoch. Timestamps need to be monotonically increasing. Values must be integer {timestamp};{timestamp};{timestamp} ...","example":"1700000000000","x-mappls-field-path":"timestamps"},"geometries":{"type":"string","description":"This parameter used to change the route geometry format/density (influences overview and per step). Default value is polyline with 5 digit precision; polyline6 for 6digit precision; geojson for geometries as geojson. Please note that “timestamps” parameter is mandatory for enabling geometries.","example":"polyline","x-mappls-field-path":"geometries"},"radiuses":{"type":"string","description":"Standard deviation of GPS precision used for map matching. If available use GPS accuracy in meters. Default value is 5 metres. Values must be integer {radius};{radius};{radius} ...","example":"50;50;50;50;50;50","x-mappls-field-path":"radiuses"},"region":{"type":"string","description":"This parameter is optional for India; for other countries (such as Sri Lanka, Nepal, Bangladesh, Bhutan + many more) this parameter is mandatory. Possible values are listed in a table here.","example":"IND","x-mappls-field-path":"region"}},"required":["pts"]},"example":{"pts":"78.40573,17.37317;78.40958,17.37314;78.41845,17.37449;78.409992,17.37328;78.420460,17.377443;78.421350,17.380200"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"Server":{"type":"string","description":"Gives Information on active service's server.","example":"Adv-5400","x-mappls-field-path":"Server"},"version":{"type":"string","description":"API’s version information.","example":"250.19.5222","x-mappls-field-path":"version"},"responseCode":{"type":"string","description":"See the service dependent and general status codes","example":"200","x-mappls-field-path":"responseCode"},"results":{"type":"object","example":"example","x-mappls-field-path":"results"},"results.snappedPoints":{"type":"array","items":{"type":"object"},"description":"Array of Waypoint objects representing all points of the trace in order. If the trace point was omitted by map matching because it is an outlier, the entry will be null.","example":"example","x-mappls-field-path":"results.snappedPoints"},"results.snappedPoints[].location":{"type":"array","items":{"type":"string"},"description":"Location of Matched point (Longitude, Latitude)","example":"28.612964,77.229463","x-mappls-field-path":"results.snappedPoints[].location"},"results.snappedPoints[].distance":{"type":"number","description":"Distance from the snapped point.","example":4.014843,"x-mappls-field-path":"results.snappedPoints[].distance"},"results.snappedPoints[].waypoint_index":{"type":"number","description":"Distance from the snapped point.","example":0,"x-mappls-field-path":"results.snappedPoints[].waypoint_index"},"results.matchings":{"type":"array","items":{"type":"object"},"description":"An array of Route objects that assemble the trace.","example":"example","x-mappls-field-path":"results.matchings"},"results.matchings[].geometry":{"type":"string","description":"Returns the whole geometry of the route as per given parameter ‘geometries’ default is encoded ‘polyline’ with 5 digit accuracy for positional coordinates. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964,77.229463","x-mappls-field-path":"results.matchings[].geometry"}},"required":["Server","version","responseCode","results","results.snappedPoints","results.snappedPoints[].location","results.snappedPoints[].distance","results.snappedPoints[].waypoint_index","results.matchings","results.matchings[].geometry"]},"example":{"Server":"Adv-5400","version":"250.19.5222","responseCode":"200","results":{"snappedPoints":[{"location":[77.113089,28.544643],"distance":4.014843,"waypoint_index":0}],"matchings":[{"geometry":"ie`iByrp}MN{HKeMXmOKuGq@}JaBaHaDmIgB{BuDcCuGeBeP{D"}]}}}}},"204":{"description":"DB Connection error."},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"412":{"description":"Precondition Failed, i.e. Some existing pre-condition in formulating a valid API request was not fulfilled."},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/snapToRoad.yml","x-mappls-source-fingerprint":"f05e344331821678f3463524df1c2729cabd344a994dd0a3877987cc6eb7b0e1","x-mappls-evidence-score":25,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-post-rest-key-snaptoroad-98309a5898","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{REST_KEY}/still_image":{"get":{"operationId":"core-location-get-rest-key-still-image-still-map-image-api","summary":"Still Map Image API","description":"The Still Map Image API creates a map based on URL parameters sent through a standard HTTP request and returns the map as an image which you can display on your application. The API lets you embed MapmyIndia Maps image according to geo-position, pixel size and zoom level of the map on your application without requiring any dynamic page loading. The image can be a retina image and markers can be added to the image to indicate position of any object.","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-rest-key-still-image-still-map-image-api"},"parameters":[{"name":"center","in":"query","required":true,"description":"A WGS-84 position coordinate that specifies the centre of the image requested.","schema":{"type":"string","description":"A WGS-84 position coordinate that specifies the centre of the image requested.","example":"28.5959394,77.2255611"}},{"name":"REST_KEY","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}},{"name":"zoom","in":"query","required":false,"description":"The zoom level for which the image is requested. Ranges from 4 to 18 with 18 being the highest zoomed in level.","schema":{"type":"integer","description":"The zoom level for which the image is requested. Ranges from 4 to 18 with 18 being the highest zoomed in level.","example":15}},{"name":"size","in":"query","required":false,"description":"The size of the image requested in pixels as width x height .","schema":{"type":"string","description":"The size of the image requested in pixels as width x height .","example":"400x400"}},{"name":"ssf","in":"query","required":false,"description":"scale factor indicating retina or non-retina tiles. 0 = non retina tiles 1 = retina tiles","schema":{"type":"integer","description":"scale factor indicating retina or non-retina tiles. 0 = non retina tiles 1 = retina tiles","enum":[0,1],"example":1}},{"name":"markers","in":"query","required":false,"description":"Optional markers that you may want to add to the map tile. Specified by WGS-84 position coordinates, seperated by semi-colon.","schema":{"type":"string","description":"Optional markers that you may want to add to the map tile. Specified by WGS-84 position coordinates, seperated by semi-colon.","example":"28.5959394,77.2255611"}},{"name":"markers_icon","in":"query","required":false,"description":"The URL of the Custom Marker.","schema":{"type":"string","description":"The URL of the Custom Marker.","example":"https://img.icons8.com/material-outlined/96/000000/truck.png"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"https://kunalbharti.github.io/mapmyindia-rest-api-beta/custom/stillMapImageResponse.png"}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/StillMapImageAPI.yml","x-mappls-source-fingerprint":"c8559a5aaab9a21da769cd84bbeb2c4c3611f3371f49d5520e47039cd724e755","x-mappls-evidence-score":14,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-rest-key-still-image-15b19a6e92","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/api/places/textsearch/json":{"get":{"operationId":"core-location-get-api-places-textsearch-json-text-search-api","summary":"Text Search API","description":"Text Search API is a service that aims to provide information about a list of places on the basis of a text string entered by the user. It uses the location information that is provided along with the query to try to understand the request. This API now supports Hindi language so you can now search queries in Hindi too. This APIs follow OAuth2 based security. To know more on how to create your authorization tokens, please use our authorization token URL. More details available here. Download Sample Code","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://atlas.mapmyindia.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-get-api-places-textsearch-json-text-search-api"},"parameters":[{"name":"query","in":"query","required":true,"description":"e.g. FODCOF, Shoes, Coffee, Versace, Gucci, H&M, Adidas, Starbucks, B130 {POI, House Number, keyword, tag}","schema":{"type":"string","description":"e.g. FODCOF, Shoes, Coffee, Versace, Gucci, H&M, Adidas, Starbucks, B130 {POI, House Number, keyword, tag}","example":"Where is Lajpat Nagar"}},{"name":"region","in":"query","required":false,"description":"It takes in the country code. LKA, IND, BTN, BGD, NPL for Sri-Lanka, India, Bhutan, Bangladesh, Nepal respectively. Default is India (IND)","schema":{"type":"string","description":"It takes in the country code. LKA, IND, BTN, BGD, NPL for Sri-Lanka, India, Bhutan, Bangladesh, Nepal respectively. Default is India (IND)","example":"IND"}},{"name":"location","in":"query","required":false,"description":"Provides the location around which the search will be performed. e.g. location=28.454,77.435 It is STRONGLY RECOMMENDED to use this parameter for accurate location biased results.","schema":{"type":"string","description":"Provides the location around which the search will be performed. e.g. location=28.454,77.435 It is STRONGLY RECOMMENDED to use this parameter for accurate location biased results.","example":"28.612964,77.229463"}},{"name":"filter","in":"query","required":false,"description":"Filter parameter helps you restrict the result by mentioning pincode. e.g. filter=pin:110020","schema":{"type":"string","description":"Filter parameter helps you restrict the result by mentioning pincode. e.g. filter=pin:110020","example":"pin:110020"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"suggestedLocation":{"type":"array","items":{"type":"object"},"example":"28.612964,77.229463","x-mappls-field-path":"suggestedLocation"},"suggestedLocation[].type":{"type":"string","description":"This is the type whether the results is POI or any building point.","example":"POI","x-mappls-field-path":"suggestedLocation[].type"},"suggestedLocation[].typeX":{"type":"integer","description":"Type attribute for internal use only for MapmyIndia.","example":7,"x-mappls-field-path":"suggestedLocation[].typeX"},"suggestedLocation[].placeAddress":{"type":"string","description":"Address of the location.","example":"Yippee Rooms, Sector 56, Gurugram, Haryana, 122011","x-mappls-field-path":"suggestedLocation[].placeAddress"},"suggestedLocation[].latitude":{"type":"number","description":"It shows us the latitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"suggestedLocation[].latitude"},"suggestedLocation[].longitude":{"type":"number","description":"It shows us the longitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"suggestedLocation[].longitude"},"suggestedLocation[].eLoc":{"type":"string","description":"It is the Six or eight digit unique code offered only by mapmyindia to search for any address through this eLoc.","example":"MMI000","x-mappls-field-path":"suggestedLocation[].eLoc"},"suggestedLocation[].entryLatitude":{"type":"number","description":"It shows us the entry latitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"suggestedLocation[].entryLatitude"},"suggestedLocation[].entryLongitude":{"type":"number","description":"It shows us the entry longitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"suggestedLocation[].entryLongitude"},"suggestedLocation[].placeName":{"type":"string","description":"This shows the name of the POI","example":"OYO Hotel","x-mappls-field-path":"suggestedLocation[].placeName"},"suggestedLocation[].alternateName":{"type":"string","description":"This shows the alternate name of the POI","example":"OyoRooms,OYO 40400 Yippe Rooms,OYO Rooms Hotel","x-mappls-field-path":"suggestedLocation[].alternateName"},"suggestedLocation[].keywords":{"type":"array","items":{"type":"object"},"description":"The keywords/category codes associated with the given result.","example":"example","x-mappls-field-path":"suggestedLocation[].keywords"},"suggestedLocation[].addressTokens":{"type":"object","example":"YOUR_ACCESS_TOKEN","x-mappls-field-path":"suggestedLocation[].addressTokens"},"suggestedLocation[].addressTokens.houseNumber":{"type":"string","description":"House Number of the POI.","example":"237","x-mappls-field-path":"suggestedLocation[].addressTokens.houseNumber"},"suggestedLocation[].addressTokens.houseName":{"type":"string","description":"House Name of the POI.","example":"MMI Building","x-mappls-field-path":"suggestedLocation[].addressTokens.houseName"},"suggestedLocation[].addressTokens.poi":{"type":"string","description":"Name of the POI.","example":"MapmyIndia Head Office","x-mappls-field-path":"suggestedLocation[].addressTokens.poi"},"suggestedLocation[].addressTokens.street":{"type":"string","description":"Name of the street.","x-mappls-field-path":"suggestedLocation[].addressTokens.street"},"suggestedLocation[].addressTokens.subSubLocality":{"type":"string","description":"Name of the subsublocality.","x-mappls-field-path":"suggestedLocation[].addressTokens.subSubLocality"},"suggestedLocation[].addressTokens.subLocality":{"type":"string","description":"Name of the sublocality.","x-mappls-field-path":"suggestedLocation[].addressTokens.subLocality"},"suggestedLocation[].addressTokens.locality":{"type":"string","description":"Name of the locality.","example":"Okhla industrial phase 3","x-mappls-field-path":"suggestedLocation[].addressTokens.locality"},"suggestedLocation[].addressTokens.village":{"type":"string","description":"Name of the village.","example":"Okhla Vilage","x-mappls-field-path":"suggestedLocation[].addressTokens.village"},"suggestedLocation[].addressTokens.subDistrict":{"type":"string","description":"Name of the subDistrict.","x-mappls-field-path":"suggestedLocation[].addressTokens.subDistrict"},"suggestedLocation[].addressTokens.district":{"type":"string","description":"Name of the District.","example":"South Delhi","x-mappls-field-path":"suggestedLocation[].addressTokens.district"},"suggestedLocation[].addressTokens.city":{"type":"string","description":"Name of the city.","example":"New Delhi","x-mappls-field-path":"suggestedLocation[].addressTokens.city"},"suggestedLocation[].addressTokens.state":{"type":"string","description":"Name of the STATE.","example":"1700000000000","x-mappls-field-path":"suggestedLocation[].addressTokens.state"},"suggestedLocation[].addressTokens.pincode":{"type":"integer","description":"PINcode of the location.","example":"110010","x-mappls-field-path":"suggestedLocation[].addressTokens.pincode"},"suggestedLocation[].p":{"type":"integer","description":"This shows the priority of the POI","example":11663,"x-mappls-field-path":"suggestedLocation[].p"},"suggestedLocation[].orderIndex":{"type":"integer","description":"This shows the order of the search results priority wise.","example":1,"x-mappls-field-path":"suggestedLocation[].orderIndex"},"suggestedLocation[].score":{"type":"number","description":"This shows the score of the POI.","example":1.5075794782130676,"x-mappls-field-path":"suggestedLocation[].score"},"suggestedLocation[].suggester":{"type":"string","description":"This shows on which basis the search results has been found.","example":"alternateName","x-mappls-field-path":"suggestedLocation[].suggester"},"suggestedLocation[].richInfo":{"type":"array","items":{"type":"object"},"description":"This shows the rich info associated with the given result.","x-mappls-field-path":"suggestedLocation[].richInfo"},"userAddedLocation":{"type":"array","items":{"type":"object"},"example":"28.612964,77.229463","x-mappls-field-path":"userAddedLocation"},"userAddedLocation[].eLoc":{"type":"string","description":"It is the Six or eight digit unique code offered only by mapmyindia to search for any address through this eLoc.","example":"MMI000","x-mappls-field-path":"userAddedLocation[].eLoc"},"userAddedLocation[].entryLatitude":{"type":"number","description":"latitude of the entrance of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"userAddedLocation[].entryLatitude"},"userAddedLocation[].entryLongitude":{"type":"number","description":"longitude of the entrance of the location. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"userAddedLocation[].entryLongitude"},"userAddedLocation[].latitude":{"type":"number","description":"It shows us the latitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"28.612964","x-mappls-field-path":"userAddedLocation[].latitude"},"userAddedLocation[].longitude":{"type":"number","description":"It shows us the longitude of the location searched. Geometry information is NOT available in most use-case driven response; and is RESTRICTED.","example":"77.229463","x-mappls-field-path":"userAddedLocation[].longitude"},"userAddedLocation[].orderIndex":{"type":"integer","description":"This shows the order of the search results priority wise.","example":1,"x-mappls-field-path":"userAddedLocation[].orderIndex"},"userAddedLocation[].placeAddress":{"type":"string","description":"This is the address of the text searched by you.","example":"Yippee Rooms, Sector 56, Gurugram, Haryana, 122011","x-mappls-field-path":"userAddedLocation[].placeAddress"},"userAddedLocation[].placeName":{"type":"string","description":"This shows the name of the POI.","example":"OYO Hotel","x-mappls-field-path":"userAddedLocation[].placeName"},"userAddedLocation[].resultType":{"type":"string","description":"It Shows the the category of result falling into. For eg. UAP","example":"UAP","x-mappls-field-path":"userAddedLocation[].resultType"},"userAddedLocation[].type":{"type":"string","x-mappls-field-path":"userAddedLocation[].type"},"userAddedLocation[].userName":{"type":"string","description":"It shows the UserID of the person who added the location.","example":"usr1577100139i799918080","x-mappls-field-path":"userAddedLocation[].userName"}},"required":["suggestedLocation[].type","suggestedLocation[].typeX","suggestedLocation[].placeAddress","suggestedLocation[].latitude","suggestedLocation[].longitude","suggestedLocation[].eLoc","suggestedLocation[].entryLatitude","suggestedLocation[].entryLongitude","suggestedLocation[].placeName","suggestedLocation[].alternateName","suggestedLocation[].keywords","suggestedLocation[].addressTokens","suggestedLocation[].addressTokens.district","suggestedLocation[].addressTokens.city","suggestedLocation[].addressTokens.state","suggestedLocation[].p","suggestedLocation[].orderIndex","suggestedLocation[].score","suggestedLocation[].suggester","suggestedLocation[].richInfo","userAddedLocation[].eLoc","userAddedLocation[].entryLatitude","userAddedLocation[].entryLongitude","userAddedLocation[].latitude","userAddedLocation[].longitude","userAddedLocation[].orderIndex","userAddedLocation[].placeAddress","userAddedLocation[].placeName","userAddedLocation[].resultType","userAddedLocation[].type","userAddedLocation[].userName"]},"example":{"suggestedLocation":[{"type":"POI","typeX":7,"placeAddress":"Yippee Rooms, Sector 56, Gurugram, Haryana, 122011","latitude":"RESTRICTED","longitude":"RESTRICTED","eLoc":"2LH9OC","entryLatitude":"RESTRICTED","entryLongitude":"RESTRICTED","placeName":"OYO Hotel","alternateName":"OyoRooms,OYO 40400 Yippe Rooms,OYO Rooms Hotel","keywords":["FINATM"],"addressTokens":{"district":"South Delhi","city":"New Delhi","state":"Delhi"},"p":11663,"orderIndex":1,"score":1.5075794782130676,"suggester":"alternateName","richInfo":""}],"userAddedLocation":[{"eLoc":"2LH9OC","entryLatitude":"RESTRICTED","entryLongitude":"RESTRICTED","latitude":"RESTRICTED","longitude":"RESTRICTED","orderIndex":1,"placeAddress":"Yippee Rooms, Sector 56, Gurugram, Haryana, 122011","placeName":"OYO Hotel","resultType":"UAP","type":"","userName":"usr1577100139i799918080"}]}}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/textsearch.yml","x-mappls-source-fingerprint":"afcd3c96db88abefe988018a2ef98ccb5e816c84beefc47bd0c9cd4452b365f6","x-mappls-evidence-score":54,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-get-api-places-textsearch-json-4b2c3fc489","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/security/oauth/token":{"post":{"operationId":"core-location-post-security-oauth-token-token-generation-api","summary":"Token Generation API","description":"This API is required to generate tokens authorize the oAuth 2 based APIs. Hence, the developer would need to send a request for access token using their clientid and clientsecret to the Token Generation API. Once validated from the OAuth API, the accesstoken and the tokentype need to be sent as Authorization header with the value: {tokentype} {accesstoken} Authorization: “tokentype accesstoken”.","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://outpost.mapmyindia.com/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-post-security-oauth-token-token-generation-api"},"requestBody":{"required":false,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","additionalProperties":true,"properties":{"grant_type":{"type":"string","description":"The grant type applicable to the token. By default, it is set at \"clientcredentials\".","example":"client_credentials","x-mappls-field-path":"grant_type"},"client_id":{"type":"string","description":"The client ID provided to thec client for accessing oAuth 2 based APIs.","example":"YOUR_CLIENT_ID","x-mappls-field-path":"client_id"},"client_secret":{"type":"string","description":"The client secret provided to thec client for accessing oAuth 2 based APIs.","example":"YOUR_CLIENT_SECRET","x-mappls-field-path":"client_secret"}},"required":["grant_type","client_id","client_secret"]},"example":{"grant_type":"client_credentials","client_id":"this-is-client-id-provided-to-client","client_secret":"this-is-client-secret-provided-to-client"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"access_token":{"type":"string","example":"YOUR_ACCESS_TOKEN","x-mappls-field-path":"access_token"},"token_type":{"type":"string","example":"YOUR_ACCESS_TOKEN","x-mappls-field-path":"token_type"},"expires_in":{"type":"integer","example":86499,"x-mappls-field-path":"expires_in"},"scope":{"type":"string","example":"READ","x-mappls-field-path":"scope"},"project_code":{"type":"string","example":"prj1234567890987654321","x-mappls-field-path":"project_code"},"client_id":{"type":"string","example":"YOUR_CLIENT_ID","x-mappls-field-path":"client_id"}},"required":["access_token","token_type","expires_in","scope","project_code","client_id"]},"example":{"access_token":"0XXXXXXf-dXX0-4XX0-8XXa-eXXXXXXXXXX6","token_type":"bearer","expires_in":86499,"scope":"READ","project_code":"prj1234567890987654321","client_id":"thisistheplace-whereyour-clientIdisprovidedback"}}}},"400":{"description":"Bad request; User made an error while creating a valid request."},"401":{"description":"Unauthorized, if the clientID doesn’t exist or an invalid clientSecret is provided."},"403":{"description":"Forbidden."},"500":{"description":"Something went wrong."},"503":{"description":"Maintenance break."}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/tokenGeneration.yml","x-mappls-source-fingerprint":"9db8784388d7bdb71cf6b3d3fedc21c9e97d85fbd0cee24e236d9c273daf7b13","x-mappls-evidence-score":15,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-post-security-oauth-token-fb39dbd5c7","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/{REST_KEY}/still_image_polyline":{"post":{"operationId":"core-location-post-rest-key-still-image-polyline-traveled-route-image-api","summary":"Traveled Route Image API","description":"This API can be used to get an image of map with traveled route plotted on it. The image size can be specified; which will dynamically create an image of varying zoom levels with the start and end locations plotted on it.","tags":["Core Maps, Search & Routing"],"deprecated":false,"servers":[{"url":"https://apis.mapmyindia.com/advancedmaps/v1"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/core-location-post-rest-key-still-image-polyline-traveled-route-image-api"},"parameters":[{"name":"REST_KEY","in":"path","required":true,"description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","schema":{"type":"string","description":"The REST API licence key allocated to you by signing into our services and registering yourself as a developer.","example":"YOUR_REST_KEY"}}],"requestBody":{"required":false,"content":{"multipart/form-data:":{"schema":{"type":"object","additionalProperties":true,"properties":{"height":{"type":"integer","description":"The height of the image resolution that is required.","example":400,"x-mappls-field-path":"height"},"width":{"type":"integer","description":"The width of the image resolution that is required.","example":400,"x-mappls-field-path":"width"},"polyline":{"type":"string","description":"An array of comma separated [Longitude,Latitude] points that define the polyline along which the route was traversed.","example":"[[77.227437,28.611004],[77.227385,28.611011],[77.226859,28.610907],[77.224885,28.610022],[77.224906,28.609965],[77.224906,28.609843],[77.224885,28.609786],[77.224788,28.609682],[77.224702,28.609644],[77.224595,28.609635],[77.224456,28.609682],[77.224349,28.609795],[77.220347,28.608005],[77.21892,28.607336],[77.218963,28.607148],[77.218942,28.60696],[77.218824,28.606677],[77.21876,28.606602],[77.218578,28.606385],[77.218374,28.606263],[77.218235,28.606216],[77.218063,28.606188],[77.217956,28.606197],[77.217945,28.605199],[77.217902,28.60438],[77.217859,28.603674],[77.217827,28.603033],[77.217773,28.602223],[77.217698,28.600933],[77.217805,28.600924],[77.217902,28.600886],[77.217988,28.600829],[77.218074,28.600707],[77.218106,28.600622],[77.218106,28.6005],[77.218085,28.600434],[77.218021,28.60033],[77.217882,28.600226],[77.217753,28.600188],[77.217571,28.600197],[77.217453,28.600244],[77.217389,28.600291],[77.217292,28.600404],[77.216798,28.600197],[77.215897,28.599801],[77.214384,28.599123],[77.212785,28.598407],[77.211326,28.597729],[77.211347,28.597682],[77.211336,28.597588],[77.211239,28.597484],[77.211196,28.597465],[77.211067,28.597465],[77.210992,28.597493],[77.210938,28.59755],[77.209575,28.596947],[77.20935,28.596853],[77.207998,28.59625],[77.20759,28.596071],[77.207526,28.596005],[77.207462,28.595996],[77.207033,28.596109],[77.20684,28.596156],[77.205295,28.596495],[77.204555,28.596561],[77.203546,28.596533],[77.20243,28.59642],[77.201218,28.59609],[77.200596,28.596109],[77.19992,28.596137],[77.199019,28.596175],[77.198826,28.596053],[77.198826,28.595996],[77.198772,28.595855],[77.198675,28.59577],[77.1986,28.595742],[77.198557,28.595723],[77.198428,28.595723],[77.198299,28.595761],[77.198235,28.595808],[77.197055,28.595516],[77.196529,28.59545],[77.196132,28.595431],[77.19566,28.595459],[77.194533,28.595695],[77.193986,28.595865],[77.193911,28.595799],[77.193772,28.595761],[77.193633,28.595789],[77.193515,28.595883],[77.193472,28.596005],[77.193483,28.596062],[77.193032,28.596241],[77.190908,28.597108],[77.190854,28.597042],[77.190768,28.596995],[77.190661,28.596967],[77.190532,28.596976],[77.190457,28.597004],[77.19035,28.597089],[77.190307,28.597155],[77.190286,28.597287],[77.190318,28.597391],[77.189095,28.5979],[77.188655,28.59807],[77.187775,28.598419],[77.187743,28.598362],[77.187646,28.598296],[77.187549,28.598268],[77.18741,28.598287],[77.187313,28.598334],[77.187238,28.598438],[77.187227,28.598532],[77.187259,28.598626],[77.183686,28.600058],[77.181991,28.600727],[77.181809,28.60084],[77.181498,28.601057],[77.181058,28.601528],[77.180897,28.601726],[77.180715,28.601811],[77.180618,28.60183],[77.180403,28.601811],[77.17933,28.601265],[77.175446,28.599212],[77.17521,28.59909],[77.174877,28.598911],[77.173965,28.598431],[77.173718,28.598309],[77.173471,28.598168],[77.172666,28.597754]]","x-mappls-field-path":"polyline"},"color":{"type":"string","description":"hex color ie. #3edhhs","example":"#ff00f7","x-mappls-field-path":"color"},"icon_from":{"type":"string","description":"The URL of the custom icon that indicates the origin of the path.","example":"https://maps.mapmyindia.com/images/from.png","x-mappls-field-path":"icon_from"},"icon_to":{"type":"string","description":"The URL of the custom icon that indicates the destination of the path.","example":"https://maps.mapmyindia.com/images/to.png","x-mappls-field-path":"icon_to"},"offset":{"type":"string","description":"The offset of the marker pointer from top right corner of the icons.","example":"10,44","x-mappls-field-path":"offset"},"padding_x":{"type":"integer","description":"Padding for path rendering from x axis image (in pixels); Max: 150","example":50,"x-mappls-field-path":"padding_x"},"padding_y":{"type":"integer","description":"Padding for path rendering from y axis image (in pixels); Max: 150","example":100,"x-mappls-field-path":"padding_y"},"markers_icon":{"type":"string","description":"The marker icons for the via points to be rendered on the polyline.","example":"https://img.icons8.com/fluent/48/000000/marker-storm.png","x-mappls-field-path":"markers_icon"},"markers":{"type":"string","description":"An Array of comma separated [Longitude,Latitude], Custom Markers to be embedded in the image during the trip.","example":"[77.187238,28.598438],[77.200596,28.596109]","x-mappls-field-path":"markers"}},"required":["height","width","polyline"]},"example":{"height":400,"width":400,"polyline":"[[77.227437,28.611004],[77.227385,28.611011],[77.226859,28.610907],[77.224885,28.610022],[77.224906,28.609965],[77.224906,28.609843],[77.224885,28.609786],[77.224788,28.609682],[77.224702,28.609644],[77.224595,28.609635],[77.224456,28.609682],[77.224349,28.609795],[77.220347,28.608005],[77.21892,28.607336],[77.218963,28.607148],[77.218942,28.60696],[77.218824,28.606677],[77.21876,28.606602],[77.218578,28.606385],[77.218374,28.606263],[77.218235,28.606216],[77.218063,28.606188],[77.217956,28.606197],[77.217945,28.605199],[77.217902,28.60438],[77.217859,28.603674],[77.217827,28.603033],[77.217773,28.602223],[77.217698,28.600933],[77.217805,28.600924],[77.217902,28.600886],[77.217988,28.600829],[77.218074,28.600707],[77.218106,28.600622],[77.218106,28.6005],[77.218085,28.600434],[77.218021,28.60033],[77.217882,28.600226],[77.217753,28.600188],[77.217571,28.600197],[77.217453,28.600244],[77.217389,28.600291],[77.217292,28.600404],[77.216798,28.600197],[77.215897,28.599801],[77.214384,28.599123],[77.212785,28.598407],[77.211326,28.597729],[77.211347,28.597682],[77.211336,28.597588],[77.211239,28.597484],[77.211196,28.597465],[77.211067,28.597465],[77.210992,28.597493],[77.210938,28.59755],[77.209575,28.596947],[77.20935,28.596853],[77.207998,28.59625],[77.20759,28.596071],[77.207526,28.596005],[77.207462,28.595996],[77.207033,28.596109],[77.20684,28.596156],[77.205295,28.596495],[77.204555,28.596561],[77.203546,28.596533],[77.20243,28.59642],[77.201218,28.59609],[77.200596,28.596109],[77.19992,28.596137],[77.199019,28.596175],[77.198826,28.596053],[77.198826,28.595996],[77.198772,28.595855],[77.198675,28.59577],[77.1986,28.595742],[77.198557,28.595723],[77.198428,28.595723],[77.198299,28.595761],[77.198235,28.595808],[77.197055,28.595516],[77.196529,28.59545],[77.196132,28.595431],[77.19566,28.595459],[77.194533,28.595695],[77.193986,28.595865],[77.193911,28.595799],[77.193772,28.595761],[77.193633,28.595789],[77.193515,28.595883],[77.193472,28.596005],[77.193483,28.596062],[77.193032,28.596241],[77.190908,28.597108],[77.190854,28.597042],[77.190768,28.596995],[77.190661,28.596967],[77.190532,28.596976],[77.190457,28.597004],[77.19035,28.597089],[77.190307,28.597155],[77.190286,28.597287],[77.190318,28.597391],[77.189095,28.5979],[77.188655,28.59807],[77.187775,28.598419],[77.187743,28.598362],[77.187646,28.598296],[77.187549,28.598268],[77.18741,28.598287],[77.187313,28.598334],[77.187238,28.598438],[77.187227,28.598532],[77.187259,28.598626],[77.183686,28.600058],[77.181991,28.600727],[77.181809,28.60084],[77.181498,28.601057],[77.181058,28.601528],[77.180897,28.601726],[77.180715,28.601811],[77.180618,28.60183],[77.180403,28.601811],[77.17933,28.601265],[77.175446,28.599212],[77.17521,28.59909],[77.174877,28.598911],[77.173965,28.598431],[77.173718,28.598309],[77.173471,28.598168],[77.172666,28.597754]]"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"https://kunalbharti.github.io/mapmyindia-rest-api-beta/custom/stillImagePolylineResponse.png"}}},"204":{"description":"Not found"},"400":{"description":"Bad request"},"401":{"description":"API access denied"},"403":{"description":"Forbidden"},"500":{"description":"Something went wrong"},"503":{"description":"Internal server error"}},"x-mappls-auth-mode":"not-declared","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-rest-api","x-mappls-source-file":"contenthub/dochub/mapmyindia-rest-api/docs/custom/StillImagePolyline.yml","x-mappls-source-fingerprint":"1e6f6eade85c296433987ee991d538d5c072917ef353288c20193a0cfda654b6","x-mappls-evidence-score":19,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"core-location-post-rest-key-still-image-polyline-3ee8b0af86","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/listingapi":{"get":{"operationId":"geoanalytics-get-listingapi-list-layer-attributes-or-a-layer-bounding-box","summary":"List layer attributes or a layer bounding box","description":"Returns documented attribute values or bbox for one Geo-Analytics layer. Supply addr, or supply geoboundtype together with geobound.","tags":["Geo-Analytics Listing"],"deprecated":false,"servers":[{"url":"https://geoanalytics.mapmyindia.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/geoanalytics-get-listingapi-list-layer-attributes-or-a-layer-bounding-box"},"parameters":[{"name":"geo_bound_type","in":"query","required":false,"description":"Parent type; required with geobound when addr is absent.","schema":{"type":"string","description":"Parent type; required with geobound when addr is absent.","example":"stt_nme"}},{"name":"geo_bound","in":"query","required":false,"description":"Parent value; required with geoboundtype when addr is absent.","schema":{"type":"string","description":"Parent value; required with geoboundtype when addr is absent.","example":"Haryana"}},{"name":"addr","in":"query","required":false,"description":"Comma-separated address; required when geoboundtype and geobound are absent.","schema":{"type":"string","description":"Comma-separated address; required when geoboundtype and geobound are absent.","example":"Jhansi, Uttar Pradesh"}},{"name":"api","in":"query","required":true,"description":"Layer name such as state, district, subdistrict, village, or pincode.","schema":{"type":"string","description":"Layer name such as state, district, subdistrict, village, or pincode.","example":"district"}},{"name":"get_attr","in":"query","required":true,"description":"Comma-separated documented attributes or bbox.","schema":{"type":"string","description":"Comma-separated documented attributes or bbox.","example":"dst_id,dst_nme,stt_nme,stt_id,b_box"}}],"responses":{"200":{"description":"Documented successful listing response.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"responseCode":{"type":"integer","example":200,"x-mappls-field-path":"responseCode"},"version":{"type":"string","example":"1.0.0","x-mappls-field-path":"version"},"total_feature_count":{"type":"integer","example":1,"x-mappls-field-path":"total_feature_count"},"results":{"type":"object","example":"example","x-mappls-field-path":"results"},"results.api_name":{"type":"string","example":"district","x-mappls-field-path":"results.api_name"},"results.attribute":{"type":"string","example":"dst_id","x-mappls-field-path":"results.attribute"},"results.get_attr_values":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"results.get_attr_values"}},"required":["responseCode","version","total_feature_count","results"]},"example":{"responseCode":200,"version":"1.0.0","total_feature_count":1,"results":{"api_name":"district","attribute":"dst_id","get_attr_values":["example"]}}}}},"400":{"description":"Client-side request error documented by responseCode class."},"500":{"description":"Server-side error documented by responseCode class."}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateless","x-mappls-journey-role":"request-response","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-geoanalytics-api-web","x-mappls-source-file":"mappls-developer-platform/data/contracts/geoanalytics-listing.openapi.yml","x-mappls-source-fingerprint":"e358eab2ef038c2d03df69920dd1789bdd188b5196b8cf8d780bfab7693eb6e3","x-mappls-evidence-score":15,"x-mappls-source-generation":"v2-0","x-mappls-generation-group":"geoanalytics-get-listingapi-7abab2b643","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/alarm":{"get":{"operationId":"intouch-get-alarm-this-api-will-get-all-the-alarm-configurations-for-a-user","summary":"This API will get all the alarm configurations for a user.","description":"Based on the passed token key, the API will return the list of all alarm configs.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-alarm-this-api-will-get-all-the-alarm-configurations-for-a-user"},"parameters":[{"name":"id","in":"query","required":false,"description":"This is the alarm's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all alarm configurations in the account. You can pass single value or comma separated alarm IDs for multiple values.","schema":{"type":"string","description":"This is the alarm's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all alarm configurations in the account. You can pass single value or comma separated alarm IDs for multiple values.","example":"23889,89876"}},{"name":"deviceId","in":"query","required":false,"description":"This is device ID. API will return data based on the configs set for the passed device IDs. You can pass a single device ID or comma seperated multiple device IDs.","schema":{"type":"string","description":"This is device ID. API will return data based on the configs set for the passed device IDs. You can pass a single device ID or comma seperated multiple device IDs.","example":"24567,10018"}},{"name":"alarmType","in":"query","required":false,"description":"This is alarm type. API will return data based on the passed alarm types. You can pass a single alarm type or comma seperated multiple alarm types.","schema":{"type":"string","description":"This is alarm type. API will return data based on the passed alarm types. You can pass a single alarm type or comma seperated multiple alarm types.","example":"177,90"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"number","description":"This is alarm ID","example":2345598,"x-mappls-field-path":"data[].id"},"data[].deviceId":{"type":"array","items":{"type":"number"},"description":"Device ID(s) on which the alarm config got created.","example":[67700,8987],"x-mappls-field-path":"data[].deviceId"},"data[].alarmType":{"type":"integer","description":"Type of alarm, for eg - ignition, overspeed etc.","example":28,"x-mappls-field-path":"data[].alarmType"},"data[].limit":{"type":"integer","example":28,"x-mappls-field-path":"data[].limit"},"data[].duration":{"type":"integer","description":"Type of alarm, for eg - ignition, overspeed etc.","example":28,"x-mappls-field-path":"data[].duration"},"data[].type":{"type":"integer","description":"Values depends on the type of alarm configured.","example":0,"x-mappls-field-path":"data[].type"},"data[].creationTime":{"type":"number","description":"Time at which the alarm got configured.","example":"1700000000000","x-mappls-field-path":"data[].creationTime"},"data[].updationTime":{"type":"integer","description":"Time at which the alarm got updated.","example":"1700000000000","x-mappls-field-path":"data[].updationTime"},"data[].geofenceId":{"type":"array","items":{"type":"number"},"description":"If returned alarm type is geofence, then this will return the list of geofences for which alarms were configured.","example":[1001,2002],"x-mappls-field-path":"data[].geofenceId"},"data[].severity":{"type":"integer","example":0,"x-mappls-field-path":"data[].severity"}}},"example":{"data":[{"id":2345598,"deviceId":[67700,8987],"alarmType":28,"limit":28,"duration":28,"type":0,"creationTime":1567654565,"updationTime":1567654565}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.yaml","x-mappls-source-fingerprint":"9789c0e53eba5ec44918ca8aade24d4b856aaade5c692109943d1e262fb2545a","x-mappls-evidence-score":22,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-alarm-10c842d182","x-mappls-generation-count":2,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-alarm-this-api-will-create-an-alarm","summary":"This API will create an alarm.","description":"Based on the input parameters provided to this POST alarm API, a new alarm will get created for a single or multiple devices","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-alarm-this-api-will-create-an-alarm"},"requestBody":{"required":false,"content":{"application/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"alarmType":{"type":"integer","description":"Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","example":26,"x-mappls-field-path":"alarmType"},"deviceId":{"type":"array","items":{"type":"number"},"description":"Device IDs of those devices for which the alarm configuration is done.","example":[1009,9090],"x-mappls-field-path":"deviceId"},"type":{"type":"integer","description":"For Geofence(alarmType = 26), value of type are as follows: 2 - entry, 3 - Exit, 1 - Entry & Exit, 4 - long stay in geofence For ignition(alarmType = 21), types values are as follows: 1 - Both ON & OFF, 2 - Ignition On, 3 - Ignition Off, 5 - Day's First Ignition ON For mileage(alarmType = 133), value of type are as follows: 0 - Daily, 1 - Monthly For DIstance Covered(alarmType = 151), value of type are as follows: 1 - At Least, 2 - At Most","example":1,"x-mappls-field-path":"type"},"duration":{"type":"integer","description":"Only required in case of overspeed, stoppage, idle, towing, GPRS connectivity, vehicle battery, GPS connectivity, distance covered, internal battery alarm","example":11,"x-mappls-field-path":"duration"},"limit":{"type":"integer","description":"Only required in case of overspeed, vehicle battery, mileage, distance covered, internal battery alarm","example":55,"x-mappls-field-path":"limit"},"geofenceId":{"type":"array","items":{"type":"number"},"description":"Only required when alarmType is 26 (Geofence). You can pass a single geofence ID or multiple geofence IDs separated by comma","example":[23434,45454],"x-mappls-field-path":"geofenceId"},"severity":{"type":"integer","description":"This basically defines the severity of the alarm. You can pass 0 for normal severity & 1 for high severity.","example":0,"x-mappls-field-path":"severity"}}},"example":{"alarmType":26,"deviceId":[1009,9090],"type":1,"duration":11,"limit":55,"geofenceId":[23434,45454],"severity":0}}}},"responses":{"201":{"description":"Created"},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.yaml","x-mappls-source-fingerprint":"9789c0e53eba5ec44918ca8aade24d4b856aaade5c692109943d1e262fb2545a","x-mappls-evidence-score":15,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-alarm-8579e8cb93","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/alarm/alarmLog/":{"get":{"operationId":"intouch-get-alarm-alarmlog-gets-the-list-of-alarm-config-s","summary":"Gets The List Of Alarm Config(s)","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-alarm-alarmlog-gets-the-list-of-alarm-config-s"},"parameters":[{"name":"deviceId","in":"query","required":false,"description":"Not Mandatory field. This is the ID of the device for which the alarm log need to be fetched. You can pass single device ID or multiple device IDs separated by comma","schema":{"type":"string","description":"Not Mandatory field. This is the ID of the device for which the alarm log need to be fetched. You can pass single device ID or multiple device IDs separated by comma","example":"1909,2545"}},{"name":"alarmType","in":"query","required":false,"description":"Not Mandatory field. This is the type of alarm for which the alarm log need to be fetched. You can pass single alarm type or multiple device IDs separated by comma. Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","schema":{"type":"string","description":"Not Mandatory field. This is the type of alarm for which the alarm log need to be fetched. You can pass single alarm type or multiple device IDs separated by comma. Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","example":"21,26"}},{"name":"startTime","in":"query","required":true,"description":"Mandatory field. This is start timestamp in seconds","schema":{"type":"number","description":"Mandatory field. This is start timestamp in seconds","example":"1700000000000"}},{"name":"endTime","in":"query","required":true,"description":"Mandatory field. This is end timestamp in seconds","schema":{"type":"number","description":"Mandatory field. This is end timestamp in seconds","example":"1700000000000"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].deviceId":{"type":"number","description":"Will come only in case of /alarmLog GET API response","example":8989,"x-mappls-field-path":"data[].deviceId"},"data[].timestamp":{"type":"number","description":"Time at which the alert got generated","example":"1700000000000","x-mappls-field-path":"data[].timestamp"},"data[].latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data[].latitude"},"data[].longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data[].longitude"},"data[].address":{"type":"string","description":"Location address at which the alarm got generated","example":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","x-mappls-field-path":"data[].address"},"data[].alarmType":{"type":"integer","description":"Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","example":28,"x-mappls-field-path":"data[].alarmType"},"data[].limit":{"type":"integer","description":"Alarm limit as set in the config. For example, if an overspeed alarm set on limit of 44 km/hr in the alarm config setting, then this attribute will return 44 km/hr","example":44,"x-mappls-field-path":"data[].limit"},"data[].duration":{"type":"integer","description":"Alarm duration limit as set in the alarm config section. For example, if duration of overspeed alarm is set as 20 secs, then the alarm will generate when the vehicle overspeeds for a duration of 20 secs","example":20,"x-mappls-field-path":"data[].duration"},"data[].actualLimit":{"type":"integer","description":"The actual data received from the device at that particular moment when the alarm got generated","example":57,"x-mappls-field-path":"data[].actualLimit"},"data[].actualDuration":{"type":"integer","description":"Actual duration for which the device breached the alarm config limit","example":25,"x-mappls-field-path":"data[].actualDuration"},"data[].severity":{"type":"integer","description":"0 - Low Severity. 1 - High Severity","example":1,"x-mappls-field-path":"data[].severity"},"data[].data":{"type":"integer","description":"Describes the state of the alarm. IGNITION(type = 21), 0: OFF & 1: ON. AC(type=25), 0: OFF, 1: ON. GEOFENCE(type=26), 1: Entry & Exit Geofence 2: Entry Geofence, 3: Leaving Geofence & 4: Long Stay In Geofence","example":1,"x-mappls-field-path":"data[].data"},"data[].geofenceId":{"type":"number","description":"This is the ID of the geofence for which the alarm got generated. This will come only when the 'type' field return 26 i,e geofence.","example":987876,"x-mappls-field-path":"data[].geofenceId"}}},"example":{"data":[{"deviceId":8989,"timestamp":1577589789,"latitude":28.550962381896,"longitude":77.26890675033,"address":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","alarmType":28,"limit":44,"duration":20}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.yaml","x-mappls-source-fingerprint":"9789c0e53eba5ec44918ca8aade24d4b856aaade5c692109943d1e262fb2545a","x-mappls-evidence-score":26,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-alarm-alarmlog-0de27f90fb","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/alarm/{id}":{"delete":{"operationId":"intouch-delete-alarm-id-deletes-an-alarm-config","summary":"Deletes An Alarm Config","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-delete-alarm-id-deletes-an-alarm-config"},"parameters":[{"name":"id","in":"path","required":true,"description":"id of the alarm config which you want to delete","schema":{"type":"integer","description":"id of the alarm config which you want to delete","example":"1"}}],"responses":{"200":{"description":"OK - successful operation"},"204":{"description":"No Content Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"retire","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.yaml","x-mappls-source-fingerprint":"9789c0e53eba5ec44918ca8aade24d4b856aaade5c692109943d1e262fb2545a","x-mappls-evidence-score":9,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-delete-alarm-id-ca6df54f47","x-mappls-generation-count":2,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-alarm-id-updates-an-alarm-config","summary":"Updates An Alarm Config","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-alarm-id-updates-an-alarm-config"},"parameters":[{"name":"id","in":"path","required":true,"description":"Mandatory field. This is the ID of the alarm config which needs to be updated.","schema":{"type":"integer","description":"Mandatory field. This is the ID of the alarm config which needs to be updated.","example":"1"}}],"requestBody":{"required":false,"content":{"application/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"deviceId":{"type":"array","items":{"type":"number"},"description":"ID of the device for which the alarm config has to be updated. If there are multiple devices then you can pass them separated by comma.","example":[6678,9876],"x-mappls-field-path":"deviceId"},"type":{"type":"integer","description":"For Geofence(alarmType = 26), value of type are as follows: 2 - entry, 3 - Exit, 1 - Entry & Exit, 4 - long stay in geofence For ignition(alarmType = 21), types values are as follows: 1 - Both ON & OFF, 2 - Ignition On, 3 - Ignition Off, 5 - Day's First Ignition ON For mileage(alarmType = 133), value of type are as follows: 0 - Daily, 1 - Monthly For DIstance Covered(alarmType = 151), value of type are as follows: 1 - At Least, 2 - At Most","example":1,"x-mappls-field-path":"type"},"duration":{"type":"integer","description":"Only required in case of overspeed, stoppage, idle, towing, GPRS connectivity, vehicle battery, GPS connectivity, distance covered, internal battery alarm","example":11,"x-mappls-field-path":"duration"},"limit":{"type":"integer","description":"Only required in case of overspeed, vehicle battery, mileage, distance covered, internal battery alarm","example":55,"x-mappls-field-path":"limit"},"geofenceId":{"type":"array","items":{"type":"number"},"description":"Only required when alarmType is 26 (Geofence). You can pass a single geofence ID or multiple geofence IDs separated by comma","example":[23434,45454],"x-mappls-field-path":"geofenceId"},"severity":{"type":"integer","description":"This basically defines the severity of the alarm. You can pass 0 for normal severity & 1 for high severity.","example":0,"x-mappls-field-path":"severity"}}},"example":{"deviceId":[6678,9876],"type":1,"duration":11,"limit":55,"geofenceId":[23434,45454],"severity":0}}}},"responses":{"200":{"description":"OK - successful operation"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"ID Not Found"},"404":{"description":"URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.yaml","x-mappls-source-fingerprint":"9789c0e53eba5ec44918ca8aade24d4b856aaade5c692109943d1e262fb2545a","x-mappls-evidence-score":15,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-alarm-id-352bd7eab8","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/alarms":{"get":{"operationId":"intouch-get-alarms-this-api-will-get-all-the-alarm-configurations-for-a-user","summary":"This API will get all the alarm configurations for a user.","description":"Based on the passed token key, the API will return the list of all alarm configs.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-alarms-this-api-will-get-all-the-alarm-configurations-for-a-user"},"parameters":[{"name":"id","in":"query","required":false,"description":"This is the alarm's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all alarm configurations in the account. You can pass single value or comma separated alarm IDs for multiple values.","schema":{"type":"string","description":"This is the alarm's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all alarm configurations in the account. You can pass single value or comma separated alarm IDs for multiple values.","example":"23889,89876"}},{"name":"deviceId","in":"query","required":false,"description":"This is device ID. API will return data based on the configs set for the passed device IDs. You can pass a single device ID or comma seperated multiple device IDs.","schema":{"type":"string","description":"This is device ID. API will return data based on the configs set for the passed device IDs. You can pass a single device ID or comma seperated multiple device IDs.","example":"24567,10018"}},{"name":"alarmType","in":"query","required":false,"description":"This is alarm type. API will return data based on the passed alarm types. You can pass a single alarm type or comma seperated multiple alarm types.","schema":{"type":"string","description":"This is alarm type. API will return data based on the passed alarm types. You can pass a single alarm type or comma seperated multiple alarm types.","example":"177,90"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"number","description":"This is alarm ID","example":2345598,"x-mappls-field-path":"data[].id"},"data[].deviceId":{"type":"array","items":{"type":"number"},"description":"Device ID(s) on which the alarm config got created.","example":[67700,8987],"x-mappls-field-path":"data[].deviceId"},"data[].alarmType":{"type":"integer","description":"Type of alarm, for eg - ignition, overspeed etc.","example":28,"x-mappls-field-path":"data[].alarmType"},"data[].limit":{"type":"integer","example":28,"x-mappls-field-path":"data[].limit"},"data[].duration":{"type":"integer","description":"Type of alarm, for eg - ignition, overspeed etc.","example":28,"x-mappls-field-path":"data[].duration"},"data[].type":{"type":"integer","description":"Values depends on the type of alarm configured.","example":0,"x-mappls-field-path":"data[].type"},"data[].creationTime":{"type":"number","description":"Time at which the alarm got configured.","example":"1700000000000","x-mappls-field-path":"data[].creationTime"},"data[].updationTime":{"type":"integer","description":"Time at which the alarm got updated.","example":"1700000000000","x-mappls-field-path":"data[].updationTime"},"data[].geofenceId":{"type":"array","items":{"type":"number"},"description":"If returned alarm type is geofence, then this will return the list of geofences for which alarms were configured.","example":[1001,2002],"x-mappls-field-path":"data[].geofenceId"},"data[].severity":{"type":"integer","example":0,"x-mappls-field-path":"data[].severity"}}},"example":{"data":[{"id":2345598,"deviceId":[67700,8987],"alarmType":28,"limit":28,"duration":28,"type":0,"creationTime":1567654565,"updationTime":1567654565}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.json","x-mappls-source-fingerprint":"a8316045f3c25586ee418e1a723122baf0844eaf95d407fc01b9ff1e24af8e1c","x-mappls-evidence-score":22,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-alarms-d6d42c52d5","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-alarms-this-api-will-create-an-alarm","summary":"This API will create an alarm.","description":"Based on the input parameters provided to this POST alarm API, a new alarm will get created for a single or multiple devices","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-alarms-this-api-will-create-an-alarm"},"requestBody":{"required":false,"content":{"application/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"alarmType":{"type":"integer","description":"Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","example":26,"x-mappls-field-path":"alarmType"},"deviceId":{"type":"array","items":{"type":"number"},"description":"Device IDs of those devices for which the alarm configuration is done.","example":[1009,9090],"x-mappls-field-path":"deviceId"},"type":{"type":"integer","description":"For Geofence(alarmType = 26), value of type are as follows: 2 - entry, 3 - Exit, 1 - Entry & Exit, 4 - long stay in geofence For ignition(alarmType = 21), types values are as follows: 1 - Both ON & OFF, 2 - Ignition On, 3 - Ignition Off, 5 - Day's First Ignition ON For mileage(alarmType = 133), value of type are as follows: 0 - Daily, 1 - Monthly For DIstance Covered(alarmType = 151), value of type are as follows: 1 - At Least, 2 - At Most","example":1,"x-mappls-field-path":"type"},"duration":{"type":"integer","description":"Only required in case of overspeed, stoppage, idle, towing, GPRS connectivity, vehicle battery, GPS connectivity, distance covered, internal battery alarm","example":11,"x-mappls-field-path":"duration"},"limit":{"type":"integer","description":"Only required in case of overspeed, vehicle battery, mileage, distance covered, internal battery alarm","example":55,"x-mappls-field-path":"limit"},"geofenceId":{"type":"array","items":{"type":"number"},"description":"Only required when alarmType is 26 (Geofence). You can pass a single geofence ID or multiple geofence IDs separated by comma","example":[23434,45454],"x-mappls-field-path":"geofenceId"},"severity":{"type":"integer","description":"This basically defines the severity of the alarm. You can pass 0 for normal severity & 1 for high severity.","example":0,"x-mappls-field-path":"severity"}}},"example":{"alarmType":26,"deviceId":[1009,9090],"type":1,"duration":11,"limit":55,"geofenceId":[23434,45454],"severity":0}}}},"responses":{"201":{"description":"Created"},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.json","x-mappls-source-fingerprint":"a8316045f3c25586ee418e1a723122baf0844eaf95d407fc01b9ff1e24af8e1c","x-mappls-evidence-score":15,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-alarms-eb4b359c3a","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/alarms/alarmlogs/":{"get":{"operationId":"intouch-get-alarms-alarmlogs-gets-the-list-of-alarm-config-s","summary":"Gets The List Of Alarm Config(s)","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-alarms-alarmlogs-gets-the-list-of-alarm-config-s"},"parameters":[{"name":"deviceId","in":"query","required":false,"description":"Not Mandatory field. This is the ID of the device for which the alarm log need to be fetched. You can pass single device ID or multiple device IDs separated by comma","schema":{"type":"string","description":"Not Mandatory field. This is the ID of the device for which the alarm log need to be fetched. You can pass single device ID or multiple device IDs separated by comma","example":"1909,2545"}},{"name":"alarmType","in":"query","required":false,"description":"Not Mandatory field. This is the type of alarm for which the alarm log need to be fetched. You can pass single alarm type or multiple device IDs separated by comma. Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","schema":{"type":"string","description":"Not Mandatory field. This is the type of alarm for which the alarm log need to be fetched. You can pass single alarm type or multiple device IDs separated by comma. Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","example":"21,26"}},{"name":"startTime","in":"query","required":true,"description":"Mandatory field. This is start timestamp in seconds","schema":{"type":"number","description":"Mandatory field. This is start timestamp in seconds","example":"1700000000000"}},{"name":"endTime","in":"query","required":true,"description":"Mandatory field. This is end timestamp in seconds","schema":{"type":"number","description":"Mandatory field. This is end timestamp in seconds","example":"1700000000000"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].deviceId":{"type":"number","description":"Will come only in case of /alarmLog GET API response","example":8989,"x-mappls-field-path":"data[].deviceId"},"data[].timestamp":{"type":"number","description":"Time at which the alert got generated","example":"1700000000000","x-mappls-field-path":"data[].timestamp"},"data[].latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data[].latitude"},"data[].longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data[].longitude"},"data[].address":{"type":"string","description":"Location address at which the alarm got generated","example":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","x-mappls-field-path":"data[].address"},"data[].alarmType":{"type":"integer","description":"Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","example":28,"x-mappls-field-path":"data[].alarmType"},"data[].limit":{"type":"integer","description":"Alarm limit as set in the config. For example, if an overspeed alarm set on limit of 44 km/hr in the alarm config setting, then this attribute will return 44 km/hr","example":44,"x-mappls-field-path":"data[].limit"},"data[].duration":{"type":"integer","description":"Alarm duration limit as set in the alarm config section. For example, if duration of overspeed alarm is set as 20 secs, then the alarm will generate when the vehicle overspeeds for a duration of 20 secs","example":20,"x-mappls-field-path":"data[].duration"},"data[].actualLimit":{"type":"integer","description":"The actual data received from the device at that particular moment when the alarm got generated","example":57,"x-mappls-field-path":"data[].actualLimit"},"data[].actualDuration":{"type":"integer","description":"Actual duration for which the device breached the alarm config limit","example":25,"x-mappls-field-path":"data[].actualDuration"},"data[].severity":{"type":"integer","description":"0 - Low Severity. 1 - High Severity","example":1,"x-mappls-field-path":"data[].severity"},"data[].data":{"type":"integer","description":"Describes the state of the alarm. IGNITION(type = 21), 0: OFF & 1: ON. AC(type=25), 0: OFF, 1: ON. GEOFENCE(type=26), 1: Entry & Exit Geofence 2: Entry Geofence, 3: Leaving Geofence & 4: Long Stay In Geofence","example":1,"x-mappls-field-path":"data[].data"},"data[].geofenceId":{"type":"number","description":"This is the ID of the geofence for which the alarm got generated. This will come only when the 'type' field return 26 i,e geofence.","example":987876,"x-mappls-field-path":"data[].geofenceId"}}},"example":{"data":[{"deviceId":8989,"timestamp":1577589789,"latitude":28.550962381896,"longitude":77.26890675033,"address":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","alarmType":28,"limit":44,"duration":20}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.json","x-mappls-source-fingerprint":"a8316045f3c25586ee418e1a723122baf0844eaf95d407fc01b9ff1e24af8e1c","x-mappls-evidence-score":26,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-alarms-alarmlogs-d3d6a2888f","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/alarms/{id}":{"delete":{"operationId":"intouch-delete-alarms-id-deletes-an-alarm-config","summary":"Deletes An Alarm Config","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-delete-alarms-id-deletes-an-alarm-config"},"parameters":[{"name":"id","in":"path","required":true,"description":"id of the alarm config which you want to delete","schema":{"type":"integer","description":"id of the alarm config which you want to delete","example":"1"}}],"responses":{"200":{"description":"OK - successful operation"},"204":{"description":"No Content Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"retire","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.json","x-mappls-source-fingerprint":"a8316045f3c25586ee418e1a723122baf0844eaf95d407fc01b9ff1e24af8e1c","x-mappls-evidence-score":9,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-delete-alarms-id-4c98701b68","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-alarms-id-updates-an-alarm-config","summary":"Updates An Alarm Config","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-alarms-id-updates-an-alarm-config"},"parameters":[{"name":"id","in":"path","required":true,"description":"Mandatory field. This is the ID of the alarm config which needs to be updated.","schema":{"type":"integer","description":"Mandatory field. This is the ID of the alarm config which needs to be updated.","example":"1"}}],"requestBody":{"required":false,"content":{"application/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"deviceId":{"type":"array","items":{"type":"number"},"description":"ID of the device for which the alarm config has to be updated. If there are multiple devices then you can pass them separated by comma.","example":[6678,9876],"x-mappls-field-path":"deviceId"},"type":{"type":"integer","description":"For Geofence(alarmType = 26), value of type are as follows: 2 - entry, 3 - Exit, 1 - Entry & Exit, 4 - long stay in geofence For ignition(alarmType = 21), types values are as follows: 1 - Both ON & OFF, 2 - Ignition On, 3 - Ignition Off, 5 - Day's First Ignition ON For mileage(alarmType = 133), value of type are as follows: 0 - Daily, 1 - Monthly For DIstance Covered(alarmType = 151), value of type are as follows: 1 - At Least, 2 - At Most","example":1,"x-mappls-field-path":"type"},"duration":{"type":"integer","description":"Only required in case of overspeed, stoppage, idle, towing, GPRS connectivity, vehicle battery, GPS connectivity, distance covered, internal battery alarm","example":11,"x-mappls-field-path":"duration"},"limit":{"type":"integer","description":"Only required in case of overspeed, vehicle battery, mileage, distance covered, internal battery alarm","example":55,"x-mappls-field-path":"limit"},"geofenceId":{"type":"array","items":{"type":"number"},"description":"Only required when alarmType is 26 (Geofence). You can pass a single geofence ID or multiple geofence IDs separated by comma","example":[23434,45454],"x-mappls-field-path":"geofenceId"},"severity":{"type":"integer","description":"This basically defines the severity of the alarm. You can pass 0 for normal severity & 1 for high severity.","example":0,"x-mappls-field-path":"severity"}}},"example":{"deviceId":[6678,9876],"type":1,"duration":11,"limit":55,"geofenceId":[23434,45454],"severity":0}}}},"responses":{"200":{"description":"OK - successful operation"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"ID Not Found"},"404":{"description":"URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.json","x-mappls-source-fingerprint":"a8316045f3c25586ee418e1a723122baf0844eaf95d407fc01b9ff1e24af8e1c","x-mappls-evidence-score":15,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-alarms-id-09fd24c730","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/devices/info":{"get":{"operationId":"intouch-get-devices-info-gets-the-basic-info-of-devices","summary":"Gets the basic info of devices.","description":"This API returns the basic info of devices such as their registration number, tyre size, manufacturer etc.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-devices-info-gets-the-basic-info-of-devices"},"parameters":[{"name":"id","in":"query","required":false,"description":"id of the device, a non-mandatory parameter. If not passed then by default the API will return the basic info of all active devices in the account.","schema":{"type":"integer","description":"id of the device, a non-mandatory parameter. If not passed then by default the API will return the basic info of all active devices in the account.","example":"1"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"integer","description":"id of the device.","example":"1","x-mappls-field-path":"data[].id"},"data[].name":{"type":"string","description":"name of the device.","example":"my vehicle 1878","x-mappls-field-path":"data[].name"},"data[].type":{"type":"integer","description":"0 - car, 1 - person, 2 - asset, 3 - bike, 4 - bus, 5 - truck, 6 - tracktor.","example":2,"x-mappls-field-path":"data[].type"},"data[].creationOn":{"type":"number","description":"the date when the device was created.","example":1585541181,"x-mappls-field-path":"data[].creationOn"},"data[].updationOn":{"type":"number","description":"date when device got updated","example":1585541181,"x-mappls-field-path":"data[].updationOn"},"data[].expiryDate":{"type":"number","description":"date when device will get expired","example":1585541181,"x-mappls-field-path":"data[].expiryDate"},"data[].active":{"type":"boolean","description":"whether device is active or not","example":true,"x-mappls-field-path":"data[].active"},"data[].registrationNumber":{"type":"string","description":"device's registraion number","example":"DL03555","x-mappls-field-path":"data[].registrationNumber"},"data[].manufacturer":{"type":"string","description":"device manufactured by","example":"BMW","x-mappls-field-path":"data[].manufacturer"},"data[].model":{"type":"string","description":"device's model type","example":"X3","x-mappls-field-path":"data[].model"},"data[].color":{"type":"string","description":"color of the device","example":"example","x-mappls-field-path":"data[].color"},"data[].geofenceIds":{"type":"array","items":{"type":"number"},"example":"example","x-mappls-field-path":"data[].geofenceIds"},"data[].tag":{"type":"array","items":{"type":"string"},"example":"example","x-mappls-field-path":"data[].tag"},"data[].chasisNo":{"type":"string","description":"chasis number of the device.","example":"EXASDSSSSADC","x-mappls-field-path":"data[].chasisNo"},"data[].initialOdometer":{"type":"number","description":"initial odometer reading.","example":0,"x-mappls-field-path":"data[].initialOdometer"}}},"example":{"data":[{"id":"1","name":"my vehicle 1878","type":2,"creationOn":1585541181,"updationOn":1585541181,"expiryDate":1585541181,"active":true,"registrationNumber":"DL03555"}]}}}},"204":{"description":"No content found"},"400":{"description":"Bad Request - Invalid device ID supplied or device id is missing or invalid data type. For example, input attribute id is integer but string value gets passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/device.json","x-mappls-source-fingerprint":"58a17aea1fc8a386e467f0266fb5d92e52e148c709fbcb95565be5c0f25895a4","x-mappls-evidence-score":25,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-devices-info-0d671e8445","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/devices/hardwareinfo":{"get":{"operationId":"intouch-get-devices-hardwareinfo-gets-the-hardware-info-of-devices","summary":"Gets the hardware info of devices.","description":"This API returns the hardware related info of devices such as their IMEI number, GSM number etc.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-devices-hardwareinfo-gets-the-hardware-info-of-devices"},"parameters":[{"name":"id","in":"query","required":false,"description":"This is the physical device's ID, a non-mandatory parameter. If not passed then by default the API will return the hardware info of all active devices in the account.","schema":{"type":"integer","description":"This is the physical device's ID, a non-mandatory parameter. If not passed then by default the API will return the hardware info of all active devices in the account.","example":"1"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"integer","description":"id of the physical hardware device","example":"1","x-mappls-field-path":"data[].id"},"data[].name":{"type":"string","description":"name of the physical hardware device","example":"MMI314295","x-mappls-field-path":"data[].name"},"data[].deviceType":{"type":"integer","description":"type of device for eg; drivate, vt etc","example":"868728030749458","x-mappls-field-path":"data[].deviceType"},"data[].deviceTypeName":{"type":"string","description":"name of the type of device","example":"drive mate pro","x-mappls-field-path":"data[].deviceTypeName"},"data[].trackingCode":{"type":"string","description":"tracking code/unique code number of the device","example":"868728030749458","x-mappls-field-path":"data[].trackingCode"},"data[].deviceCode":{"type":"string","description":"another unique number, genrally same as tracking code","example":"868728030749458","x-mappls-field-path":"data[].deviceCode"},"data[].active":{"type":"boolean","description":"true means device is active. false means device is not active","example":true,"x-mappls-field-path":"data[].active"},"data[].mappedDeviceIds":{"type":"array","items":{"type":"number"},"example":"example","x-mappls-field-path":"data[].mappedDeviceIds"},"data[].odometerType":{"type":"integer","description":"0 - odometer not suported, 1- GPS based odometer(comes from the device), 2 - CAN based Odometer(comes from vehicle's CAN bus)","example":2,"x-mappls-field-path":"data[].odometerType"},"data[].installDate":{"type":"number","description":"timstamp when the device got installed","example":1581273000,"x-mappls-field-path":"data[].installDate"},"data[].expiryDate":{"type":"number","description":"timestamp when the device will get expired","example":1600713000,"x-mappls-field-path":"data[].expiryDate"}}},"example":{"data":[{"id":"1","name":"MMI314295","deviceType":"868728030749458","deviceTypeName":"drive mate pro","trackingCode":"868728030749458","deviceCode":"868728030749458","active":true,"mappedDeviceIds":[887876]}]}}}},"204":{"description":"No content found"},"400":{"description":"Bad Request - Invalid device ID supplied or device id is missing or invalid data type. For example, input attribute id is integer but string value gets passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/device.json","x-mappls-source-fingerprint":"58a17aea1fc8a386e467f0266fb5d92e52e148c709fbcb95565be5c0f25895a4","x-mappls-evidence-score":21,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-devices-hardwareinfo-63c589c536","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/devices":{"get":{"operationId":"intouch-get-devices-gets-the-live-data-of-devices","summary":"Gets the live data of devices.","description":"This API returns accurate live location and related data of vehicles, assets & people with help of connected devices/sensors/mobiles to provide location awareness to users of your app. The API provides real-time visibility of your tracked objects, giving not just location information, but multiple additional fields which add value to your application. The API is capable of being used for multiple use cases: be it for transport - logistics or for personnel information services for all kinds of web or mobile development platforms.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-devices-gets-the-live-data-of-devices"},"parameters":[{"name":"id","in":"query","required":false,"description":"This is the device's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all active devices in the account.","schema":{"type":"integer","description":"This is the device's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all active devices in the account.","example":"1"}},{"name":"includeInActive","in":"query","required":false,"description":"Non mandatory boolean field. If this field is not sent then by default API response will send all active devices. If \"true\" then API reponse will have inactive devices along with active devices. If \"false\" then API will return only active devices","schema":{"type":"boolean","description":"Non mandatory boolean field. If this field is not sent then by default API response will send all active devices. If \"true\" then API reponse will have inactive devices along with active devices. If \"false\" then API will return only active devices","example":"true"}},{"name":"ignoreBeacon","in":"query","required":false,"description":"Non mandatory field. If set to true then API will return all devices except those whose device type is beacon(mobile).","schema":{"type":"boolean","description":"Non mandatory field. If set to true then API will return all devices except those whose device type is beacon(mobile).","example":"true"}},{"name":"state","in":"query","required":false,"description":"Non mandatory field. Input timestamp in this field to fetch only those live locations of devices which have come after the input timestamp. If \"state\" is sent then by default only active devices will be fetched irrespective of the status of \"includeInActive\" attribute.","schema":{"type":"number","description":"Non mandatory field. Input timestamp in this field to fetch only those live locations of devices which have come after the input timestamp. If \"state\" is sent then by default only active devices will be fetched irrespective of the status of \"includeInActive\" attribute.","example":"1700000000000"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"integer","example":"1","x-mappls-field-path":"data[].id"},"data[].active":{"type":"string","description":"device active status","enum":[true,false],"example":true,"x-mappls-field-path":"data[].active"},"data[].status":{"type":"number","description":"device movement status 1 -> moving 2 -> idle i,e ignition is on and speed stopped i,e engine is off 4 -> towing i,e ignition is off, but vehicle speed 5 -> no data i,e no communication of device with intouch server or no GPRS signal 6 -> power off 7 -> no gps i,e satellite count is less than 4 8 -> on trip i,e device is currently on an active trip 9 -> free vehicle i,e device is not on any active trip","example":1,"x-mappls-field-path":"data[].status"},"data[].vehicleBattery":{"type":"number","example":13568.98,"x-mappls-field-path":"data[].vehicleBattery"},"data[].location":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"data[].location"},"data[].location.gpsTime":{"type":"number","example":"1700000000000","x-mappls-field-path":"data[].location.gpsTime"},"data[].location.gprsTime":{"type":"number","example":"1700000000000","x-mappls-field-path":"data[].location.gprsTime"},"data[].location.latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data[].location.latitude"},"data[].location.longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data[].location.longitude"},"data[].location.address":{"type":"string","example":"244, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 2 m from Usha Exim Pvt Ltd pin-110020","x-mappls-field-path":"data[].location.address"},"data[].location.altitude":{"type":"number","example":234,"x-mappls-field-path":"data[].location.altitude"},"data[].location.heading":{"type":"number","example":196.868,"x-mappls-field-path":"data[].location.heading"},"data[].location.speedKph":{"type":"number","example":27.85,"x-mappls-field-path":"data[].location.speedKph"},"data[].location.odometer":{"type":"number","example":12548.22,"x-mappls-field-path":"data[].location.odometer"},"data[].deviceDetails":{"type":"object","example":"example","x-mappls-field-path":"data[].deviceDetails"},"data[].deviceDetails.name":{"type":"string","example":"DL3CCM8097","x-mappls-field-path":"data[].deviceDetails.name"},"data[].deviceDetails.registrationNumber":{"type":"string","example":"DL3CCM8097","x-mappls-field-path":"data[].deviceDetails.registrationNumber"},"data[].deviceDetails.deviceType":{"type":"string","enum":["car","truck","bus","bike","tracktor","JCB","excavator"],"example":"car","x-mappls-field-path":"data[].deviceDetails.deviceType"},"data[].alerts":{"type":"object","example":"example","x-mappls-field-path":"data[].alerts"},"data[].alerts.deviceId":{"type":"number","description":"Will come only in case of /alarmLog GET API response","example":8989,"x-mappls-field-path":"data[].alerts.deviceId"},"data[].alerts.timestamp":{"type":"number","description":"Time at which the alert got generated","example":"1700000000000","x-mappls-field-path":"data[].alerts.timestamp"},"data[].alerts.latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data[].alerts.latitude"},"data[].alerts.longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data[].alerts.longitude"},"data[].alerts.address":{"type":"string","description":"Location address at which the alarm got generated","example":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","x-mappls-field-path":"data[].alerts.address"},"data[].alerts.alarmType":{"type":"integer","description":"Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","example":28,"x-mappls-field-path":"data[].alerts.alarmType"},"data[].alerts.limit":{"type":"integer","description":"Alarm limit as set in the config. For example, if an overspeed alarm set on limit of 44 km/hr in the alarm config setting, then this attribute will return 44 km/hr","example":44,"x-mappls-field-path":"data[].alerts.limit"},"data[].alerts.duration":{"type":"integer","description":"Alarm duration limit as set in the alarm config section. For example, if duration of overspeed alarm is set as 20 secs, then the alarm will generate when the vehicle overspeeds for a duration of 20 secs","example":20,"x-mappls-field-path":"data[].alerts.duration"},"data[].alerts.actualLimit":{"type":"integer","description":"The actual data received from the device at that particular moment when the alarm got generated","example":57,"x-mappls-field-path":"data[].alerts.actualLimit"},"data[].alerts.actualDuration":{"type":"integer","description":"Actual duration for which the device breached the alarm config limit","example":25,"x-mappls-field-path":"data[].alerts.actualDuration"},"data[].alerts.severity":{"type":"integer","description":"0 - Low Severity. 1 - High Severity","example":1,"x-mappls-field-path":"data[].alerts.severity"},"data[].alerts.data":{"type":"integer","description":"Describes the state of the alarm. IGNITION(type = 21), 0: OFF & 1: ON. AC(type=25), 0: OFF, 1: ON. GEOFENCE(type=26), 1: Entry & Exit Geofence 2: Entry Geofence, 3: Leaving Geofence & 4: Long Stay In Geofence","example":1,"x-mappls-field-path":"data[].alerts.data"},"data[].alerts.geofenceId":{"type":"number","description":"This is the ID of the geofence for which the alarm got generated. This will come only when the 'type' field return 26 i,e geofence.","example":987876,"x-mappls-field-path":"data[].alerts.geofenceId"},"data[].canInfo":{"type":"object","example":"example","x-mappls-field-path":"data[].canInfo"},"data[].canInfo.calcEngineVal":{"type":"integer","example":0,"x-mappls-field-path":"data[].canInfo.calcEngineVal"},"data[].canInfo.greenDriveType":{"type":"string","description":"HA(Harsh acceleration), HB(Harsh Breaking), HC(Harsh Cornering)","example":"HA","x-mappls-field-path":"data[].canInfo.greenDriveType"},"data[].canInfo.canTimestamp":{"type":"number","description":"Exact time at which the CAN data got generated by the device","example":"1700000000000","x-mappls-field-path":"data[].canInfo.canTimestamp"},"data[].canInfo.coolantTemp":{"type":"number","example":87,"x-mappls-field-path":"data[].canInfo.coolantTemp"},"data[].canInfo.engineRPM":{"type":"integer","example":796,"x-mappls-field-path":"data[].canInfo.engineRPM"},"data[].canInfo.accelPedal":{"type":"number","description":"This is accelerator pedal value in percentage.","example":8.4,"x-mappls-field-path":"data[].canInfo.accelPedal"},"data[].canInfo.parkBrake":{"type":"number","description":"This is parking break. 0 means parking break is disengaged & 1 means parking break is engaged","example":0,"x-mappls-field-path":"data[].canInfo.parkBrake"},"data[].canInfo.breakPedal":{"type":"number","description":"1 means break pedal is engaged & 0 means break pedal is disengaged","example":0,"x-mappls-field-path":"data[].canInfo.breakPedal"},"data[].canInfo.fuelLevel":{"type":"integer","description":"Level of the fuel in liters","example":14,"x-mappls-field-path":"data[].canInfo.fuelLevel"},"data[].canInfo.driverDoor":{"type":"number","description":"1 means door is open & 0 means door is closed","example":0,"x-mappls-field-path":"data[].canInfo.driverDoor"},"data[].canInfo.headLights":{"type":"number","description":"1 means ON & 0 means OFF","example":1,"x-mappls-field-path":"data[].canInfo.headLights"},"data[].canInfo.blinker":{"type":"number","description":"1 means ON & 0 means OFF","example":0,"x-mappls-field-path":"data[].canInfo.blinker"},"data[].canInfo.gearState":{"type":"number","description":"0 is Neutral, 1 is Drive, 2 is Sports, 3 is Reverse","example":"1700000000000","x-mappls-field-path":"data[].canInfo.gearState"},"data[].canInfo.intakeAirTemp":{"type":"number","description":"This is the intake air temperature of the engine.","example":62,"x-mappls-field-path":"data[].canInfo.intakeAirTemp"},"data[].canInfo.intakeabsolutePress":{"type":"number","description":"This is the intake absolute pressure of the engine. It is defined in Pa(Pascal)","example":42,"x-mappls-field-path":"data[].canInfo.intakeabsolutePress"},"data[].canInfo.ac":{"type":"integer","description":"1 means AC is ON & 0 means AC is OFF","example":0,"x-mappls-field-path":"data[].canInfo.ac"},"data[].canInfo.fuelConsAVG":{"type":"integer","description":"Fuel constant average","example":99,"x-mappls-field-path":"data[].canInfo.fuelConsAVG"},"data[].deviceFaults":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data[].deviceFaults"},"data[].deviceFaults[].code":{"type":"integer","example":1001,"x-mappls-field-path":"data[].deviceFaults[].code"},"data[].deviceFaults[].timetamp":{"type":"number","example":"1700000000000","x-mappls-field-path":"data[].deviceFaults[].timetamp"},"data[].deviceFaults[].status":{"type":"integer","description":"Describes the status of the fault which was detected. 0: OPEN & 1: Close.","example":0,"x-mappls-field-path":"data[].deviceFaults[].status"},"data[].deviceFaults[].closedOn":{"type":"number","example":556567872,"x-mappls-field-path":"data[].deviceFaults[].closedOn"},"data[].currentGeofence":{"type":"array","items":{"type":"number"},"example":"example","x-mappls-field-path":"data[].currentGeofence"},"data[].todaysDrive":{"type":"object","example":"example","x-mappls-field-path":"data[].todaysDrive"},"data[].todaysDrive.todayKms":{"type":"number","example":55.67,"x-mappls-field-path":"data[].todaysDrive.todayKms"},"data[].todaysDrive.todayMovementTime":{"type":"number","description":"Value is in seconds","example":"1700000000000","x-mappls-field-path":"data[].todaysDrive.todayMovementTime"},"data[].todaysDrive.todayIdleTime":{"type":"number","description":"Value is in seconds","example":"1700000000000","x-mappls-field-path":"data[].todaysDrive.todayIdleTime"},"data[].todaysDrive.todayDriveCount":{"type":"integer","example":5,"x-mappls-field-path":"data[].todaysDrive.todayDriveCount"}}},"example":{"data":[{"id":"1","active":true,"status":1,"vehicleBattery":13568.98,"location":{"gpsTime":1574736922,"gprsTime":1574736922,"latitude":28.551255163434,"longitude":77.2687,"address":"244, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 2 m from Usha Exim Pvt Ltd pin-110020","altitude":234,"heading":196.868,"speedKph":27.85},"deviceDetails":{"name":"DL3CCM8097","registrationNumber":"DL3CCM8097","deviceType":"car"},"alerts":{"deviceId":8989,"timestamp":1577589789,"latitude":28.550962381896,"longitude":77.26890675033,"address":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","alarmType":28,"limit":44,"duration":20},"canInfo":{"calcEngineVal":0,"greenDriveType":"HA","canTimestamp":1568362645,"coolantTemp":87,"engineRPM":796,"accelPedal":8.4,"parkBrake":0,"breakPedal":0}}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid device ID supplied or invalid data type. For example, input attribute \"id\" is integer but string value gets passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/device.json","x-mappls-source-fingerprint":"58a17aea1fc8a386e467f0266fb5d92e52e148c709fbcb95565be5c0f25895a4","x-mappls-evidence-score":74,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-devices-8d5e41c132","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/device":{"get":{"operationId":"intouch-get-device-gets-the-live-data-of-devices","summary":"Gets the live data of devices.","description":"This API returns accurate live location and related data of vehicles, assets & people with help of connected devices/sensors/mobiles to provide location awareness to users of your app. The API provides real-time visibility of your tracked objects, giving not just location information, but multiple additional fields which add value to your application. The API is capable of being used for multiple use cases: be it for transport - logistics or for personnel information services for all kinds of web or mobile development platforms.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-device-gets-the-live-data-of-devices"},"parameters":[{"name":"id","in":"query","required":false,"description":"This is the device's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all active devices in the account.","schema":{"type":"integer","description":"This is the device's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all active devices in the account.","example":"1"}},{"name":"includeInActive","in":"query","required":false,"description":"Non mandatory boolean field. If this field is not sent then by default API response will send all active devices. If \"true\" then API reponse will have inactive devices along with active devices. If \"false\" then API will return only active devices","schema":{"type":"boolean","description":"Non mandatory boolean field. If this field is not sent then by default API response will send all active devices. If \"true\" then API reponse will have inactive devices along with active devices. If \"false\" then API will return only active devices","example":"true"}},{"name":"ignoreBeacon","in":"query","required":false,"description":"Non mandatory field. If set to true then API will return all devices except those whose device type is beacon(mobile).","schema":{"type":"boolean","description":"Non mandatory field. If set to true then API will return all devices except those whose device type is beacon(mobile).","example":"true"}},{"name":"state","in":"query","required":false,"description":"Non mandatory field. Input timestamp in this field to fetch only those live locations of devices which have come after the input timestamp. If \"state\" is sent then by default only active devices will be fetched irrespective of the status of \"includeInActive\" attribute.","schema":{"type":"number","description":"Non mandatory field. Input timestamp in this field to fetch only those live locations of devices which have come after the input timestamp. If \"state\" is sent then by default only active devices will be fetched irrespective of the status of \"includeInActive\" attribute.","example":"1700000000000"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"integer","example":"1","x-mappls-field-path":"data[].id"},"data[].active":{"type":"string","description":"device active status","enum":[true,false],"example":true,"x-mappls-field-path":"data[].active"},"data[].status":{"type":"integer","description":"1 is Moving 2 is idle 3 is stopped 4 is towing 5 is No Data 6 is power off i,e the device's battery is disconnected from the vehicle battery 7 is No GPS 12 is Activation Pending i,e the device is not yet active and is yet to send the first ping.","example":1,"x-mappls-field-path":"data[].status"},"data[].vehicleBattery":{"type":"number","example":13568.98,"x-mappls-field-path":"data[].vehicleBattery"},"data[].location":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"data[].location"},"data[].location.gpsTime":{"type":"number","description":"time at which the device captures the packet","example":"1700000000000","x-mappls-field-path":"data[].location.gpsTime"},"data[].location.gprsTime":{"type":"number","description":"time at which the Intouch server receives the device packet","example":"1700000000000","x-mappls-field-path":"data[].location.gprsTime"},"data[].location.latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data[].location.latitude"},"data[].location.longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data[].location.longitude"},"data[].location.address":{"type":"string","example":"244, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 2 m from Usha Exim Pvt Ltd pin-110020","x-mappls-field-path":"data[].location.address"},"data[].location.altitude":{"type":"number","example":234,"x-mappls-field-path":"data[].location.altitude"},"data[].location.heading":{"type":"number","description":"value in degrees from the North","example":196.868,"x-mappls-field-path":"data[].location.heading"},"data[].location.speedKph":{"type":"number","example":27.85,"x-mappls-field-path":"data[].location.speedKph"},"data[].location.odometer":{"type":"number","example":12548.22,"x-mappls-field-path":"data[].location.odometer"},"data[].deviceDetails":{"type":"object","example":"example","x-mappls-field-path":"data[].deviceDetails"},"data[].deviceDetails.name":{"type":"string","example":"DL3CCM8097","x-mappls-field-path":"data[].deviceDetails.name"},"data[].deviceDetails.registrationNumber":{"type":"string","example":"DL3CCM8097","x-mappls-field-path":"data[].deviceDetails.registrationNumber"},"data[].deviceDetails.deviceType":{"type":"string","enum":["car","truck","bus","bike","tracktor","JCB","excavator"],"example":"car","x-mappls-field-path":"data[].deviceDetails.deviceType"},"data[].alerts":{"type":"object","example":"example","x-mappls-field-path":"data[].alerts"},"data[].alerts.deviceId":{"type":"number","description":"Will come only in case of /alarmLog GET API response","example":8989,"x-mappls-field-path":"data[].alerts.deviceId"},"data[].alerts.timestamp":{"type":"number","description":"Time at which the alert got generated","example":"1700000000000","x-mappls-field-path":"data[].alerts.timestamp"},"data[].alerts.latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data[].alerts.latitude"},"data[].alerts.longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data[].alerts.longitude"},"data[].alerts.address":{"type":"string","description":"Location address at which the alarm got generated","example":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","x-mappls-field-path":"data[].alerts.address"},"data[].alerts.alarmType":{"type":"integer","description":"Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","example":28,"x-mappls-field-path":"data[].alerts.alarmType"},"data[].alerts.limit":{"type":"integer","description":"Alarm limit as set in the config. For example, if an overspeed alarm set on limit of 44 km/hr in the alarm config setting, then this attribute will return 44 km/hr","example":44,"x-mappls-field-path":"data[].alerts.limit"},"data[].alerts.duration":{"type":"integer","description":"Alarm duration limit as set in the alarm config section. For example, if duration of overspeed alarm is set as 20 secs, then the alarm will generate when the vehicle overspeeds for a duration of 20 secs","example":20,"x-mappls-field-path":"data[].alerts.duration"},"data[].alerts.actualLimit":{"type":"integer","description":"The actual data received from the device at that particular moment when the alarm got generated","example":57,"x-mappls-field-path":"data[].alerts.actualLimit"},"data[].alerts.actualDuration":{"type":"integer","description":"Actual duration for which the device breached the alarm config limit","example":25,"x-mappls-field-path":"data[].alerts.actualDuration"},"data[].alerts.severity":{"type":"integer","description":"0 - Low Severity. 1 - High Severity","example":1,"x-mappls-field-path":"data[].alerts.severity"},"data[].alerts.data":{"type":"integer","description":"Describes the state of the alarm. IGNITION(type = 21), 0: OFF & 1: ON. AC(type=25), 0: OFF, 1: ON. GEOFENCE(type=26), 1: Entry & Exit Geofence 2: Entry Geofence, 3: Leaving Geofence & 4: Long Stay In Geofence","example":1,"x-mappls-field-path":"data[].alerts.data"},"data[].alerts.geofenceId":{"type":"number","description":"This is the ID of the geofence for which the alarm got generated. This will come only when the 'type' field return 26 i,e geofence.","example":987876,"x-mappls-field-path":"data[].alerts.geofenceId"},"data[].canInfo":{"type":"object","example":"example","x-mappls-field-path":"data[].canInfo"},"data[].canInfo.calcEngineVal":{"type":"integer","example":0,"x-mappls-field-path":"data[].canInfo.calcEngineVal"},"data[].canInfo.greenDriveType":{"type":"string","description":"HA(Harsh acceleration), HB(Harsh Breaking), HC(Harsh Cornering)","example":"HA","x-mappls-field-path":"data[].canInfo.greenDriveType"},"data[].canInfo.canTimestamp":{"type":"number","description":"Exact time at which the CAN data got generated by the device","example":"1700000000000","x-mappls-field-path":"data[].canInfo.canTimestamp"},"data[].canInfo.coolantTemp":{"type":"number","example":87,"x-mappls-field-path":"data[].canInfo.coolantTemp"},"data[].canInfo.engineRPM":{"type":"integer","example":796,"x-mappls-field-path":"data[].canInfo.engineRPM"},"data[].canInfo.accelPedal":{"type":"number","description":"This is accelerator pedal value in percentage.","example":8.4,"x-mappls-field-path":"data[].canInfo.accelPedal"},"data[].canInfo.parkBrake":{"type":"number","description":"This is parking break. 0 means parking break is disengaged & 1 means parking break is engaged","example":0,"x-mappls-field-path":"data[].canInfo.parkBrake"},"data[].canInfo.breakPedal":{"type":"number","description":"1 means break pedal is engaged & 0 means break pedal is disengaged","example":0,"x-mappls-field-path":"data[].canInfo.breakPedal"},"data[].canInfo.fuelLevel":{"type":"integer","description":"Level of the fuel in liters","example":14,"x-mappls-field-path":"data[].canInfo.fuelLevel"},"data[].canInfo.driverDoor":{"type":"number","description":"1 means door is open & 0 means door is closed","example":0,"x-mappls-field-path":"data[].canInfo.driverDoor"},"data[].canInfo.headLights":{"type":"number","description":"1 means ON & 0 means OFF","example":1,"x-mappls-field-path":"data[].canInfo.headLights"},"data[].canInfo.blinker":{"type":"number","description":"1 means ON & 0 means OFF","example":0,"x-mappls-field-path":"data[].canInfo.blinker"},"data[].canInfo.intakeAirTemp":{"type":"number","description":"This is the intake air temperature of the engine.","example":62,"x-mappls-field-path":"data[].canInfo.intakeAirTemp"},"data[].canInfo.intakeabsolutePress":{"type":"number","description":"This is the intake absolute pressure of the engine. It is defined in Pa(Pascal)","example":42,"x-mappls-field-path":"data[].canInfo.intakeabsolutePress"},"data[].canInfo.ac":{"type":"integer","description":"1 means AC is ON & 0 means AC is OFF","example":0,"x-mappls-field-path":"data[].canInfo.ac"},"data[].canInfo.fuelConsAVG":{"type":"integer","description":"Fuel constant average","example":99,"x-mappls-field-path":"data[].canInfo.fuelConsAVG"},"data[].canInfo.ignition":{"type":"integer","description":"0 is ignition off 1 is ignition on","example":0,"x-mappls-field-path":"data[].canInfo.ignition"},"data[].canInfo.gearState":{"type":"integer","description":"shows the current state of gear of the EV","example":"1700000000000","x-mappls-field-path":"data[].canInfo.gearState"},"data[].canInfo.stateOfCharge":{"type":"integer","description":"Value is in percentage, i,e the current percentage value at which the EV's battery is charged","example":"1700000000000","x-mappls-field-path":"data[].canInfo.stateOfCharge"},"data[].canInfo.distanceToEmpty":{"type":"integer","description":"distnace in KMs after which the EV will need to be charged","example":100,"x-mappls-field-path":"data[].canInfo.distanceToEmpty"},"data[].deviceFaults":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data[].deviceFaults"},"data[].deviceFaults[].code":{"type":"integer","example":1001,"x-mappls-field-path":"data[].deviceFaults[].code"},"data[].deviceFaults[].timetamp":{"type":"number","example":"1700000000000","x-mappls-field-path":"data[].deviceFaults[].timetamp"},"data[].deviceFaults[].status":{"type":"integer","description":"Describes the status of the fault which was detected. 0: OPEN & 1: Close.","example":0,"x-mappls-field-path":"data[].deviceFaults[].status"},"data[].deviceFaults[].closedOn":{"type":"number","example":556567872,"x-mappls-field-path":"data[].deviceFaults[].closedOn"},"data[].currentGeofence":{"type":"array","items":{"type":"number"},"example":"example","x-mappls-field-path":"data[].currentGeofence"},"data[].todaysDrive":{"type":"object","example":"example","x-mappls-field-path":"data[].todaysDrive"},"data[].todaysDrive.todayKms":{"type":"number","example":55.67,"x-mappls-field-path":"data[].todaysDrive.todayKms"},"data[].todaysDrive.todayMovementTime":{"type":"number","description":"Value is in seconds","example":"1700000000000","x-mappls-field-path":"data[].todaysDrive.todayMovementTime"},"data[].todaysDrive.todayIdleTime":{"type":"number","description":"Value is in seconds","example":"1700000000000","x-mappls-field-path":"data[].todaysDrive.todayIdleTime"},"data[].todaysDrive.todayDriveCount":{"type":"integer","example":5,"x-mappls-field-path":"data[].todaysDrive.todayDriveCount"}}},"example":{"data":[{"id":"1","active":true,"status":1,"vehicleBattery":13568.98,"location":{"gpsTime":1574736922,"gprsTime":1574736922,"latitude":28.551255163434,"longitude":77.2687,"address":"244, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 2 m from Usha Exim Pvt Ltd pin-110020","altitude":234,"heading":196.868,"speedKph":27.85},"deviceDetails":{"name":"DL3CCM8097","registrationNumber":"DL3CCM8097","deviceType":"car"},"alerts":{"deviceId":8989,"timestamp":1577589789,"latitude":28.550962381896,"longitude":77.26890675033,"address":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","alarmType":28,"limit":44,"duration":20},"canInfo":{"calcEngineVal":0,"greenDriveType":"HA","canTimestamp":1568362645,"coolantTemp":87,"engineRPM":796,"accelPedal":8.4,"parkBrake":0,"breakPedal":0}}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid device ID supplied or invalid data type. For example, input attribute \"id\" is integer but string value gets passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","x-mappls-source-fingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","x-mappls-evidence-score":77,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"intouch-get-device-edb77335d0","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/device/drive":{"get":{"operationId":"intouch-get-device-drive-gets-drive-details-of-a-device","summary":"Gets drive details of a device.","description":"This API is used to request the drive details of a vehicle in an account on our telematics platform. A vehicle can be a device/sensor connected to our telematics platform directly or via a third party data aggregator who utilises our telematics platform for tracking services. Drive is a list of reported geo-positions of any object (such as vehicles, assets or people) according to pre-defined conditions","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-device-drive-gets-drive-details-of-a-device"},"parameters":[{"name":"deviceId","in":"query","required":true,"description":"ID of the device for which the drives need to be fetched","schema":{"type":"integer","description":"ID of the device for which the drives need to be fetched","example":"1"}},{"name":"startTime","in":"query","required":true,"description":"The starting timsstamp from which the drives need to be fetched.","schema":{"type":"number","description":"The starting timsstamp from which the drives need to be fetched.","example":"1700000000000"}},{"name":"endTime","in":"query","required":true,"description":"The end timestamp till which the drives need to be fetched.","schema":{"type":"number","description":"The end timestamp till which the drives need to be fetched.","example":"1700000000000"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].deviceId":{"type":"number","description":"Your Device's ID.","example":67790,"x-mappls-field-path":"data[].deviceId"},"data[].location":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"data[].location"},"data[].location.startAddress":{"type":"string","example":"3605, 13th G Main Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 35 m from Supraja Meru pin-560038 (India)","x-mappls-field-path":"data[].location.startAddress"},"data[].location.startTimestamp":{"type":"number","description":"this is epoc timestamp","example":"1700000000000","x-mappls-field-path":"data[].location.startTimestamp"},"data[].location.endAddress":{"type":"string","example":"1139, Sweth Ambara, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 32 m from AMC Cookware India Pvt Ltd pin-560038","x-mappls-field-path":"data[].location.endAddress"},"data[].location.endTimestamp":{"type":"number","description":"this is epoc timestamp","example":"1700000000000","x-mappls-field-path":"data[].location.endTimestamp"},"data[].location.avgSpeed":{"type":"number","description":"speed in km/hr","example":45.34,"x-mappls-field-path":"data[].location.avgSpeed"},"data[].movement":{"type":"object","example":"example","x-mappls-field-path":"data[].movement"},"data[].movement.duration":{"type":"number","description":"duration in seconds","example":265,"x-mappls-field-path":"data[].movement.duration"},"data[].movement.distance":{"type":"number","description":"Distance im KMs","example":12.34,"x-mappls-field-path":"data[].movement.distance"},"data[].movement.idleTime":{"type":"number","description":"idle time in seconds","example":"1700000000000","x-mappls-field-path":"data[].movement.idleTime"},"data[].movement.movementTime":{"type":"number","description":"movement time in seconds","example":"1700000000000","x-mappls-field-path":"data[].movement.movementTime"},"data[].movement.stoppageTime":{"type":"number","description":"stoppage time in seconds","example":"1700000000000","x-mappls-field-path":"data[].movement.stoppageTime"},"data[].drivingBehaviourCount":{"type":"object","example":"example","x-mappls-field-path":"data[].drivingBehaviourCount"},"data[].drivingBehaviourCount.haCount":{"type":"integer","description":"Harsh Acceleration count","example":2,"x-mappls-field-path":"data[].drivingBehaviourCount.haCount"},"data[].drivingBehaviourCount.hbCount":{"type":"integer","description":"Harsh Breaking Count","example":5,"x-mappls-field-path":"data[].drivingBehaviourCount.hbCount"},"data[].drivingBehaviourCount.hcCount":{"type":"integer","description":"Harsh Cornering Count","example":1,"x-mappls-field-path":"data[].drivingBehaviourCount.hcCount"}}},"example":{"data":[{"deviceId":67790,"location":{"startAddress":"3605, 13th G Main Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 35 m from Supraja Meru pin-560038 (India)","startTimestamp":1574913781,"endAddress":"1139, Sweth Ambara, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 32 m from AMC Cookware India Pvt Ltd pin-560038","endTimestamp":1574914046,"avgSpeed":45.34},"movement":{"duration":265,"distance":12.34,"idleTime":265,"movementTime":800,"stoppageTime":1300},"drivingBehaviourCount":{"haCount":2,"hbCount":5,"hcCount":1}}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid device ID supplied or invalid data type. For example, input attribute \"id\" is integer but string value gets passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","x-mappls-source-fingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","x-mappls-evidence-score":29,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"intouch-get-device-drive-e0e4c548ee","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/devices/drives":{"get":{"operationId":"intouch-get-devices-drives-gets-drive-details-of-a-device","summary":"Gets drive details of a device.","description":"This API is used to request the drive details of a vehicle in an account on our telematics platform. A vehicle can be a device/sensor connected to our telematics platform directly or via a third party data aggregator who utilises our telematics platform for tracking services. Drive is a list of reported geo-positions of any object (such as vehicles, assets or people) according to pre-defined conditions","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-devices-drives-gets-drive-details-of-a-device"},"parameters":[{"name":"deviceId","in":"query","required":true,"description":"ID of the device for which the drives need to be fetched","schema":{"type":"integer","description":"ID of the device for which the drives need to be fetched","example":"1"}},{"name":"startTime","in":"query","required":true,"description":"The starting timsstamp from which the drives need to be fetched.","schema":{"type":"number","description":"The starting timsstamp from which the drives need to be fetched.","example":"1700000000000"}},{"name":"endTime","in":"query","required":true,"description":"The end timestamp till which the drives need to be fetched.","schema":{"type":"number","description":"The end timestamp till which the drives need to be fetched.","example":"1700000000000"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].deviceId":{"type":"number","description":"Your Device's ID.","example":67790,"x-mappls-field-path":"data[].deviceId"},"data[].location":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"data[].location"},"data[].location.startAddress":{"type":"string","example":"3605, 13th G Main Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 35 m from Supraja Meru pin-560038 (India)","x-mappls-field-path":"data[].location.startAddress"},"data[].location.startTimestamp":{"type":"number","description":"this is epoc timestamp","example":"1700000000000","x-mappls-field-path":"data[].location.startTimestamp"},"data[].location.endAddress":{"type":"string","example":"1139, Sweth Ambara, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 32 m from AMC Cookware India Pvt Ltd pin-560038","x-mappls-field-path":"data[].location.endAddress"},"data[].location.endTimestamp":{"type":"number","description":"this is epoc timestamp","example":"1700000000000","x-mappls-field-path":"data[].location.endTimestamp"},"data[].location.avgSpeed":{"type":"number","description":"speed in km/hr","example":45.34,"x-mappls-field-path":"data[].location.avgSpeed"},"data[].movement":{"type":"object","example":"example","x-mappls-field-path":"data[].movement"},"data[].movement.duration":{"type":"number","description":"duration in seconds","example":265,"x-mappls-field-path":"data[].movement.duration"},"data[].movement.distance":{"type":"number","description":"Distance im KMs","example":12.34,"x-mappls-field-path":"data[].movement.distance"},"data[].movement.idleTime":{"type":"number","description":"idle time in seconds","example":"1700000000000","x-mappls-field-path":"data[].movement.idleTime"},"data[].movement.movementTime":{"type":"number","description":"movement time in seconds","example":"1700000000000","x-mappls-field-path":"data[].movement.movementTime"},"data[].movement.stoppageTime":{"type":"number","description":"stoppage time in seconds","example":"1700000000000","x-mappls-field-path":"data[].movement.stoppageTime"},"data[].drivingBehaviourCount":{"type":"object","example":"example","x-mappls-field-path":"data[].drivingBehaviourCount"},"data[].drivingBehaviourCount.haCount":{"type":"integer","description":"Harsh Acceleration count","example":2,"x-mappls-field-path":"data[].drivingBehaviourCount.haCount"},"data[].drivingBehaviourCount.hbCount":{"type":"integer","description":"Harsh Breaking Count","example":5,"x-mappls-field-path":"data[].drivingBehaviourCount.hbCount"},"data[].drivingBehaviourCount.hcCount":{"type":"integer","description":"Harsh Cornering Count","example":1,"x-mappls-field-path":"data[].drivingBehaviourCount.hcCount"}}},"example":{"data":[{"deviceId":67790,"location":{"startAddress":"3605, 13th G Main Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 35 m from Supraja Meru pin-560038 (India)","startTimestamp":1574913781,"endAddress":"1139, Sweth Ambara, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 32 m from AMC Cookware India Pvt Ltd pin-560038","endTimestamp":1574914046,"avgSpeed":45.34},"movement":{"duration":265,"distance":12.34,"idleTime":265,"movementTime":800,"stoppageTime":1300},"drivingBehaviourCount":{"haCount":2,"hbCount":5,"hcCount":1}}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid device ID supplied or invalid data type. For example, input attribute \"id\" is integer but string value gets passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/drive.json","x-mappls-source-fingerprint":"6cdf4c61bc811cde72adc7d658a90c01a1bb4a1f805c85a4d3cd763c2281f2c3","x-mappls-evidence-score":29,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"intouch-get-devices-drives-6ed00dce99","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/device/{deviceId}/events":{"get":{"operationId":"intouch-get-device-deviceid-events-gets-the-historical-location-events-of-a-device","summary":"Gets the historical location events of a device.","description":"This API is used to get the historical location information as well as related additional information for a vehicle. This API can be used thus to create customized reports for users of your apps for different use cases, e.g.: plot the vehicle's past movements on map or get a historical graph of change in a vehicle's altitude.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-device-deviceid-events-gets-the-historical-location-events-of-a-device"},"parameters":[{"name":"deviceId","in":"path","required":true,"description":"ID of the device for which the events need to be fetched","schema":{"type":"integer","description":"ID of the device for which the events need to be fetched","example":"1"}},{"name":"startTime","in":"query","required":true,"description":"The starting timsstamp from which the events need to be fetched.","schema":{"type":"number","description":"The starting timsstamp from which the events need to be fetched.","example":"1700000000000"}},{"name":"endTime","in":"query","required":true,"description":"The end timestamp till which the events need to be fetched.","schema":{"type":"number","description":"The end timestamp till which the events need to be fetched.","example":"1700000000000"}},{"name":"skipPeriod","in":"query","required":false,"description":"Defined in minitues. For example, if say 2 is passed then each returned data packet will have a minimum difference of 2 mins.","schema":{"type":"integer","description":"Defined in minitues. For example, if say 2 is passed then each returned data packet will have a minimum difference of 2 mins.","example":2}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"object","example":"example","x-mappls-field-path":"data"},"data.drivingBehaviourCount":{"type":"object","example":"example","x-mappls-field-path":"data.drivingBehaviourCount"},"data.drivingBehaviourCount.haCount":{"type":"integer","description":"Harsh Acceleration Count","example":2,"x-mappls-field-path":"data.drivingBehaviourCount.haCount"},"data.drivingBehaviourCount.hbCount":{"type":"integer","description":"Harsh Breaking Count","example":1,"x-mappls-field-path":"data.drivingBehaviourCount.hbCount"},"data.drivingBehaviourCount.hcCount":{"type":"integer","description":"Harsh Cornering Count","example":3,"x-mappls-field-path":"data.drivingBehaviourCount.hcCount"},"data.summary":{"type":"object","example":"example","x-mappls-field-path":"data.summary"},"data.summary.distance":{"type":"number","description":"Total Drive Distance in KMs","example":23.67,"x-mappls-field-path":"data.summary.distance"},"data.summary.duration":{"type":"number","description":"Total drive duration in seconds","example":300,"x-mappls-field-path":"data.summary.duration"},"data.summary.avgSpeed":{"type":"number","description":"Average speed in km/hr","example":45.54,"x-mappls-field-path":"data.summary.avgSpeed"},"data.summary.startAddress":{"type":"string","example":"213, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 15 m from The Bodhi Tree pin-560038 (India)","x-mappls-field-path":"data.summary.startAddress"},"data.summary.endAddress":{"type":"string","example":"3645, 13th F Main Road, Dupanahalli, Indiranagar, Bengaluru, Karnataka. 12 m from Meenakshi Enclave pin-560038 (India)","x-mappls-field-path":"data.summary.endAddress"},"data.summary.startTimestamp":{"type":"number","description":"Start time of the device i,e the time at which the data first came from the device for the selected day.","example":"1700000000000","x-mappls-field-path":"data.summary.startTimestamp"},"data.summary.endTimestamp":{"type":"number","description":"End time of the device i,e the time at which the last data came from the device for the selected day.","example":"1700000000000","x-mappls-field-path":"data.summary.endTimestamp"},"data.positionList":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data.positionList"},"data.positionList[].address":{"type":"string","description":"Address of the location event","example":"213, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 15 m from The Bodhi Tree pin-560038 (India)","x-mappls-field-path":"data.positionList[].address"},"data.positionList[].timestamp":{"type":"number","example":"1700000000000","x-mappls-field-path":"data.positionList[].timestamp"},"data.positionList[].longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data.positionList[].longitude"},"data.positionList[].latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data.positionList[].latitude"},"data.positionList[].heading":{"type":"number","description":"device heading direction in degrees from North.","example":298,"x-mappls-field-path":"data.positionList[].heading"},"data.positionList[].speed":{"type":"number","description":"Device speed at this particular location","example":33.33,"x-mappls-field-path":"data.positionList[].speed"},"data.positionList[].ignition":{"type":"number","description":"whether vehicle ignition is On or Off. 0 means ignition is OFF and 1 means ignition is ON.","example":0,"x-mappls-field-path":"data.positionList[].ignition"},"data.positionList[].powerSupplyVoltage":{"type":"number","description":"battery voltage value in milli volts.","example":12769,"x-mappls-field-path":"data.positionList[].powerSupplyVoltage"},"data.positionList[].gpsFix":{"type":"boolean","description":"GPS is fix or not for the device. true meanse GPS is fixed and false means GPS is not fixed.","example":true,"x-mappls-field-path":"data.positionList[].gpsFix"},"data.positionList[].validGPS":{"type":"boolean","description":"Checks whether GPS is valid or not.","enum":[true,false],"example":true,"x-mappls-field-path":"data.positionList[].validGPS"},"data.positionList[].accOff":{"type":"boolean","description":"checks for whether adaptive cruise control is enabled or not.","enum":[true,false],"example":true,"x-mappls-field-path":"data.positionList[].accOff"},"data.positionList[].movementStatus":{"type":"integer","description":"Checks the movement status of the device. 1:Moving 2:Idle 3:Stopped 4:Towing 5:No Data 6:Power Off 7:No Gps 8:On Trip 9:Free Vehicle","example":1,"x-mappls-field-path":"data.positionList[].movementStatus"},"data.positionList[].durationTime":{"type":"number","description":"duration(in secsonds) time spent at current location","example":"1700000000000","x-mappls-field-path":"data.positionList[].durationTime"},"data.positionList[].greenDriveType":{"type":"string","description":"HA(Harsh acceleration), HB(Harsh Breaking), HC(Harsh Cornering)","example":"HA","x-mappls-field-path":"data.positionList[].greenDriveType"},"data.positionList[].tripStatus":{"type":"integer","description":"0 - On Trip, 1 - Free Vehicle","enum":["On Trip","Free Vehicle"],"example":0,"x-mappls-field-path":"data.positionList[].tripStatus"},"data.positionList[].mobileInfo":{"type":"object","example":"example","x-mappls-field-path":"data.positionList[].mobileInfo"},"data.positionList[].mobileInfo.locationSource":{"type":"number","description":"1 - GPS connected, distanceaccuracy less that 50mtrs, 2 - GPRS connected, distance accracy more than 50 mtr.","enum":["GPS Connected","GPRS Connected"],"example":"28.612964,77.229463","x-mappls-field-path":"data.positionList[].mobileInfo.locationSource"},"data.positionList[].mobileInfo.mockLocation":{"type":"boolean","description":"true - mock location being sent by the user. false - real location being sent by the user.","example":"28.612964,77.229463","x-mappls-field-path":"data.positionList[].mobileInfo.mockLocation"},"data.positionList[].mobileInfo.isAirplanemode":{"type":"boolean","description":"Checks whether mobile's airplane mode is ON(i,e true) or OFF(i,e false)","example":true,"x-mappls-field-path":"data.positionList[].mobileInfo.isAirplanemode"},"data.positionList[].mobileInfo.callStatus":{"type":"number","description":"0-CALLSTATEIDLE, 1-CALLSTATERINGING, 2-CALLSTATEOFFHOOK","enum":["CALL_STATE_IDLE","CALL_STATE_RINGING","CALL_STATE_OFFHOOK"],"example":0,"x-mappls-field-path":"data.positionList[].mobileInfo.callStatus"},"data.positionList[].mobileInfo.deviceStatus":{"type":"integer","description":"status of the device in the current location. Values as mentioned in the below enum are possible.","enum":["IN_VEHICLE","ON_BICYCLE","ON_FOOT","STILL","UNKNOWN","TILTING","WALKING","RUNNING"],"example":0,"x-mappls-field-path":"data.positionList[].mobileInfo.deviceStatus"},"data.positionList[].mobileInfo.phoneEvent":{"type":"integer","description":"Checks the location permission that the user enables/disables in the mobile phone.","enum":["EVENT_LOCATION_PERMISSION_DENIED = 5","EVENT_LOCATION_PROVIDER_OFF = 6","EVENT_LOCATION_STOP_PROGRAMMATICALLY = 7"],"example":5,"x-mappls-field-path":"data.positionList[].mobileInfo.phoneEvent"},"data.positionList[].alerts":{"type":"object","example":"example","x-mappls-field-path":"data.positionList[].alerts"},"data.positionList[].alerts.deviceId":{"type":"number","description":"Will come only in case of /alarmLog GET API response","example":8989,"x-mappls-field-path":"data.positionList[].alerts.deviceId"},"data.positionList[].alerts.timestamp":{"type":"number","description":"Time at which the alert got generated","example":"1700000000000","x-mappls-field-path":"data.positionList[].alerts.timestamp"},"data.positionList[].alerts.latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data.positionList[].alerts.latitude"},"data.positionList[].alerts.longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data.positionList[].alerts.longitude"},"data.positionList[].alerts.address":{"type":"string","description":"Location address at which the alarm got generated","example":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","x-mappls-field-path":"data.positionList[].alerts.address"},"data.positionList[].alerts.alarmType":{"type":"integer","description":"Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","example":28,"x-mappls-field-path":"data.positionList[].alerts.alarmType"},"data.positionList[].alerts.limit":{"type":"integer","description":"Alarm limit as set in the config. For example, if an overspeed alarm set on limit of 44 km/hr in the alarm config setting, then this attribute will return 44 km/hr","example":44,"x-mappls-field-path":"data.positionList[].alerts.limit"},"data.positionList[].alerts.duration":{"type":"integer","description":"Alarm duration limit as set in the alarm config section. For example, if duration of overspeed alarm is set as 20 secs, then the alarm will generate when the vehicle overspeeds for a duration of 20 secs","example":20,"x-mappls-field-path":"data.positionList[].alerts.duration"},"data.positionList[].alerts.actualLimit":{"type":"integer","description":"The actual data received from the device at that particular moment when the alarm got generated","example":57,"x-mappls-field-path":"data.positionList[].alerts.actualLimit"},"data.positionList[].alerts.actualDuration":{"type":"integer","description":"Actual duration for which the device breached the alarm config limit","example":25,"x-mappls-field-path":"data.positionList[].alerts.actualDuration"},"data.positionList[].alerts.severity":{"type":"integer","description":"0 - Low Severity. 1 - High Severity","example":1,"x-mappls-field-path":"data.positionList[].alerts.severity"},"data.positionList[].alerts.data":{"type":"integer","description":"Describes the state of the alarm. IGNITION(type = 21), 0: OFF & 1: ON. AC(type=25), 0: OFF, 1: ON. GEOFENCE(type=26), 1: Entry & Exit Geofence 2: Entry Geofence, 3: Leaving Geofence & 4: Long Stay In Geofence","example":1,"x-mappls-field-path":"data.positionList[].alerts.data"},"data.positionList[].alerts.geofenceId":{"type":"number","description":"This is the ID of the geofence for which the alarm got generated. This will come only when the 'type' field return 26 i,e geofence.","example":987876,"x-mappls-field-path":"data.positionList[].alerts.geofenceId"}}},"example":{"data":{"drivingBehaviourCount":{"haCount":2,"hbCount":1,"hcCount":3},"summary":{"distance":23.67,"duration":300,"avgSpeed":45.54,"startAddress":"213, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 15 m from The Bodhi Tree pin-560038 (India)","endAddress":"3645, 13th F Main Road, Dupanahalli, Indiranagar, Bengaluru, Karnataka. 12 m from Meenakshi Enclave pin-560038 (India)","startTimestamp":1577644204,"endTimestamp":1577684913},"positionList":[{"address":"213, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 15 m from The Bodhi Tree pin-560038 (India)","timestamp":1574937348,"longitude":77.74937348,"latitude":55.74937348,"heading":298,"speed":33.33,"ignition":0,"powerSupplyVoltage":12769}]}}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid device ID supplied or invalid data type. For example, input attribute \"id\" is integer but string value gets passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","x-mappls-source-fingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","x-mappls-evidence-score":62,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"intouch-get-device-deviceid-events-81b631bdb1","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/devices/{deviceId}/events":{"get":{"operationId":"intouch-get-devices-deviceid-events-gets-the-historical-location-events-of-a-device","summary":"Gets the historical location events of a device.","description":"This API is used to get the historical location information as well as related additional information for a vehicle. This API can be used thus to create customized reports for users of your apps for different use cases, e.g.: plot the vehicle's past movements on map or get a historical graph of change in a vehicle's altitude.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-devices-deviceid-events-gets-the-historical-location-events-of-a-device"},"parameters":[{"name":"deviceId","in":"path","required":true,"description":"ID of the device for which the events need to be fetched","schema":{"type":"integer","description":"ID of the device for which the events need to be fetched","example":"1"}},{"name":"startTime","in":"query","required":true,"description":"The starting timsstamp from which the events need to be fetched.","schema":{"type":"number","description":"The starting timsstamp from which the events need to be fetched.","example":"1700000000000"}},{"name":"endTime","in":"query","required":true,"description":"The end timestamp till which the events need to be fetched.","schema":{"type":"number","description":"The end timestamp till which the events need to be fetched.","example":"1700000000000"}},{"name":"skipPeriod","in":"query","required":false,"description":"Defined in minitues. For example, if say 2 is passed then each returned data packet will have a minimum difference of 2 mins.","schema":{"type":"integer","description":"Defined in minitues. For example, if say 2 is passed then each returned data packet will have a minimum difference of 2 mins.","example":2}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"object","example":"example","x-mappls-field-path":"data"},"data.drivingBehaviourCount":{"type":"object","example":"example","x-mappls-field-path":"data.drivingBehaviourCount"},"data.drivingBehaviourCount.haCount":{"type":"integer","description":"Harsh Acceleration Count","example":2,"x-mappls-field-path":"data.drivingBehaviourCount.haCount"},"data.drivingBehaviourCount.hbCount":{"type":"integer","description":"Harsh Breaking Count","example":1,"x-mappls-field-path":"data.drivingBehaviourCount.hbCount"},"data.drivingBehaviourCount.hcCount":{"type":"integer","description":"Harsh Cornering Count","example":3,"x-mappls-field-path":"data.drivingBehaviourCount.hcCount"},"data.summary":{"type":"object","example":"example","x-mappls-field-path":"data.summary"},"data.summary.distance":{"type":"number","description":"Total Drive Distance in KMs","example":23.67,"x-mappls-field-path":"data.summary.distance"},"data.summary.duration":{"type":"number","description":"Total drive duration in seconds","example":300,"x-mappls-field-path":"data.summary.duration"},"data.summary.avgSpeed":{"type":"number","description":"Average speed in km/hr","example":45.54,"x-mappls-field-path":"data.summary.avgSpeed"},"data.summary.startAddress":{"type":"string","example":"213, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 15 m from The Bodhi Tree pin-560038 (India)","x-mappls-field-path":"data.summary.startAddress"},"data.summary.endAddress":{"type":"string","example":"3645, 13th F Main Road, Dupanahalli, Indiranagar, Bengaluru, Karnataka. 12 m from Meenakshi Enclave pin-560038 (India)","x-mappls-field-path":"data.summary.endAddress"},"data.summary.startTimestamp":{"type":"number","description":"Start time of the device i,e the time at which the data first came from the device for the selected day.","example":"1700000000000","x-mappls-field-path":"data.summary.startTimestamp"},"data.summary.endTimestamp":{"type":"number","description":"End time of the device i,e the time at which the last data came from the device for the selected day.","example":"1700000000000","x-mappls-field-path":"data.summary.endTimestamp"},"data.positionList":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data.positionList"},"data.positionList[].address":{"type":"string","description":"Address of the location event","example":"213, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 15 m from The Bodhi Tree pin-560038 (India)","x-mappls-field-path":"data.positionList[].address"},"data.positionList[].timestamp":{"type":"number","example":"1700000000000","x-mappls-field-path":"data.positionList[].timestamp"},"data.positionList[].longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data.positionList[].longitude"},"data.positionList[].latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data.positionList[].latitude"},"data.positionList[].heading":{"type":"number","description":"device heading direction in degrees from North.","example":298,"x-mappls-field-path":"data.positionList[].heading"},"data.positionList[].speed":{"type":"number","description":"Device speed at this particular location","example":33.33,"x-mappls-field-path":"data.positionList[].speed"},"data.positionList[].ignition":{"type":"number","description":"whether vehicle ignition is On or Off. 0 means ignition is OFF and 1 means ignition is ON.","example":0,"x-mappls-field-path":"data.positionList[].ignition"},"data.positionList[].powerSupplyVoltage":{"type":"number","description":"battery voltage value in milli volts.","example":12769,"x-mappls-field-path":"data.positionList[].powerSupplyVoltage"},"data.positionList[].gpsFix":{"type":"boolean","description":"GPS is fix or not for the device. true meanse GPS is fixed and false means GPS is not fixed.","example":true,"x-mappls-field-path":"data.positionList[].gpsFix"},"data.positionList[].validGPS":{"type":"boolean","description":"Checks whether GPS is valid or not.","enum":[true,false],"example":true,"x-mappls-field-path":"data.positionList[].validGPS"},"data.positionList[].accOff":{"type":"boolean","description":"checks for whether adaptive cruise control is enabled or not.","enum":[true,false],"example":true,"x-mappls-field-path":"data.positionList[].accOff"},"data.positionList[].movementStatus":{"type":"integer","description":"Checks the movement status of the device. 1:Moving 2:Idle 3:Stopped 4:Towing 5:No Data 6:Power Off 7:No Gps 8:On Trip 9:Free Vehicle","example":1,"x-mappls-field-path":"data.positionList[].movementStatus"},"data.positionList[].durationTime":{"type":"number","description":"duration(in secsonds) time spent at current location","example":"1700000000000","x-mappls-field-path":"data.positionList[].durationTime"},"data.positionList[].greenDriveType":{"type":"string","description":"HA(Harsh acceleration), HB(Harsh Breaking), HC(Harsh Cornering)","example":"HA","x-mappls-field-path":"data.positionList[].greenDriveType"},"data.positionList[].tripStatus":{"type":"integer","description":"0 - On Trip, 1 - Free Vehicle","enum":["On Trip","Free Vehicle"],"example":0,"x-mappls-field-path":"data.positionList[].tripStatus"},"data.positionList[].mobileInfo":{"type":"object","example":"example","x-mappls-field-path":"data.positionList[].mobileInfo"},"data.positionList[].mobileInfo.locationSource":{"type":"number","description":"1 - GPS connected, distanceaccuracy less that 50mtrs, 2 - GPRS connected, distance accracy more than 50 mtr.","enum":["GPS Connected","GPRS Connected"],"example":"28.612964,77.229463","x-mappls-field-path":"data.positionList[].mobileInfo.locationSource"},"data.positionList[].mobileInfo.mockLocation":{"type":"boolean","description":"true - mock location being sent by the user. false - real location being sent by the user.","example":"28.612964,77.229463","x-mappls-field-path":"data.positionList[].mobileInfo.mockLocation"},"data.positionList[].mobileInfo.isAirplanemode":{"type":"boolean","description":"Checks whether mobile's airplane mode is ON(i,e true) or OFF(i,e false)","example":true,"x-mappls-field-path":"data.positionList[].mobileInfo.isAirplanemode"},"data.positionList[].mobileInfo.callStatus":{"type":"number","description":"0-CALLSTATEIDLE, 1-CALLSTATERINGING, 2-CALLSTATEOFFHOOK","enum":["CALL_STATE_IDLE","CALL_STATE_RINGING","CALL_STATE_OFFHOOK"],"example":0,"x-mappls-field-path":"data.positionList[].mobileInfo.callStatus"},"data.positionList[].mobileInfo.deviceStatus":{"type":"integer","description":"status of the device in the current location. Values as mentioned in the below enum are possible.","enum":["IN_VEHICLE","ON_BICYCLE","ON_FOOT","STILL","UNKNOWN","TILTING","WALKING","RUNNING"],"example":0,"x-mappls-field-path":"data.positionList[].mobileInfo.deviceStatus"},"data.positionList[].mobileInfo.phoneEvent":{"type":"integer","description":"Checks the location permission that the user enables/disables in the mobile phone.","enum":["EVENT_LOCATION_PERMISSION_DENIED = 5","EVENT_LOCATION_PROVIDER_OFF = 6","EVENT_LOCATION_STOP_PROGRAMMATICALLY = 7"],"example":5,"x-mappls-field-path":"data.positionList[].mobileInfo.phoneEvent"},"data.positionList[].alerts":{"type":"object","example":"example","x-mappls-field-path":"data.positionList[].alerts"},"data.positionList[].alerts.deviceId":{"type":"number","description":"Will come only in case of /alarmLog GET API response","example":8989,"x-mappls-field-path":"data.positionList[].alerts.deviceId"},"data.positionList[].alerts.timestamp":{"type":"number","description":"Time at which the alert got generated","example":"1700000000000","x-mappls-field-path":"data.positionList[].alerts.timestamp"},"data.positionList[].alerts.latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data.positionList[].alerts.latitude"},"data.positionList[].alerts.longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data.positionList[].alerts.longitude"},"data.positionList[].alerts.address":{"type":"string","description":"Location address at which the alarm got generated","example":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","x-mappls-field-path":"data.positionList[].alerts.address"},"data.positionList[].alerts.alarmType":{"type":"integer","description":"Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","example":28,"x-mappls-field-path":"data.positionList[].alerts.alarmType"},"data.positionList[].alerts.limit":{"type":"integer","description":"Alarm limit as set in the config. For example, if an overspeed alarm set on limit of 44 km/hr in the alarm config setting, then this attribute will return 44 km/hr","example":44,"x-mappls-field-path":"data.positionList[].alerts.limit"},"data.positionList[].alerts.duration":{"type":"integer","description":"Alarm duration limit as set in the alarm config section. For example, if duration of overspeed alarm is set as 20 secs, then the alarm will generate when the vehicle overspeeds for a duration of 20 secs","example":20,"x-mappls-field-path":"data.positionList[].alerts.duration"},"data.positionList[].alerts.actualLimit":{"type":"integer","description":"The actual data received from the device at that particular moment when the alarm got generated","example":57,"x-mappls-field-path":"data.positionList[].alerts.actualLimit"},"data.positionList[].alerts.actualDuration":{"type":"integer","description":"Actual duration for which the device breached the alarm config limit","example":25,"x-mappls-field-path":"data.positionList[].alerts.actualDuration"},"data.positionList[].alerts.severity":{"type":"integer","description":"0 - Low Severity. 1 - High Severity","example":1,"x-mappls-field-path":"data.positionList[].alerts.severity"},"data.positionList[].alerts.data":{"type":"integer","description":"Describes the state of the alarm. IGNITION(type = 21), 0: OFF & 1: ON. AC(type=25), 0: OFF, 1: ON. GEOFENCE(type=26), 1: Entry & Exit Geofence 2: Entry Geofence, 3: Leaving Geofence & 4: Long Stay In Geofence","example":1,"x-mappls-field-path":"data.positionList[].alerts.data"},"data.positionList[].alerts.geofenceId":{"type":"number","description":"This is the ID of the geofence for which the alarm got generated. This will come only when the 'type' field return 26 i,e geofence.","example":987876,"x-mappls-field-path":"data.positionList[].alerts.geofenceId"}}},"example":{"data":{"drivingBehaviourCount":{"haCount":2,"hbCount":1,"hcCount":3},"summary":{"distance":23.67,"duration":300,"avgSpeed":45.54,"startAddress":"213, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 15 m from The Bodhi Tree pin-560038 (India)","endAddress":"3645, 13th F Main Road, Dupanahalli, Indiranagar, Bengaluru, Karnataka. 12 m from Meenakshi Enclave pin-560038 (India)","startTimestamp":1577644204,"endTimestamp":1577684913},"positionList":[{"address":"213, 1st Cross Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 15 m from The Bodhi Tree pin-560038 (India)","timestamp":1574937348,"longitude":77.74937348,"latitude":55.74937348,"heading":298,"speed":33.33,"ignition":0,"powerSupplyVoltage":12769}]}}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid device ID supplied or invalid data type. For example, input attribute \"id\" is integer but string value gets passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/event.json","x-mappls-source-fingerprint":"e12f19aca91ae7a3a69a36fbd62f0929a6e0ffa0437bfc7361557b5b83d69528","x-mappls-evidence-score":62,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"intouch-get-devices-deviceid-events-9664a5ccb6","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/geofence/":{"get":{"operationId":"intouch-get-geofence-gets-all-the-configured-geofence-s","summary":"Gets All The Configured Geofence(s)","description":"This API returns the list of all the configured geofences","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-geofence-gets-all-the-configured-geofence-s"},"parameters":[{"name":"ignoreGeometry","in":"query","required":false,"description":"Flag to get geometry data.","schema":{"type":"boolean","description":"Flag to get geometry data.","example":"28.612964,77.229463"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"number","description":"Geofence ID","example":"1","x-mappls-field-path":"data[].id"},"data[].name":{"type":"string","description":"name of the geofence.","example":"market","x-mappls-field-path":"data[].name"},"data[].geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"data[].geometry"},"data[].geometry.type":{"type":"string","description":"This defines the type of geofence, it can be point or polygon.","example":"Point","x-mappls-field-path":"data[].geometry.type"},"data[].geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].geometry.coordinates"},"data[].type":{"type":"string","description":"Depending on the type of geofence this value can be Circle(buffer > 50 meters), Polygon or Point(buffer = 50 mtrs)","example":"Circle","x-mappls-field-path":"data[].type"},"data[].buffer":{"type":"number","description":"Radius(in meters) of a circlular geofence","example":65.76,"x-mappls-field-path":"data[].buffer"},"data[].creationTime":{"type":"number","description":"timestamp, in seconds, at which the geofence was created.","example":"1700000000000","x-mappls-field-path":"data[].creationTime"},"data[].updationTime":{"type":"number","description":"timestamp, in seconds, at which the geofence was updated.","example":"1700000000000","x-mappls-field-path":"data[].updationTime"}}},"example":{"data":[{"id":"1","name":"market","geometry":{"type":"Point","coordinates":[77.456,28.2345]},"type":"Circle","buffer":65.76,"creationTime":"1","updationTime":"1"}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.yaml","x-mappls-source-fingerprint":"03d663d784a8ea9af1a3915cad4395ab716b167774dbf54a73c516bd10bc887a","x-mappls-evidence-score":19,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-geofence-0428994c0e","x-mappls-generation-count":2,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-geofence-create-a-new-geofence","summary":"Create A New Geofence","description":"This API helps to create a new geofence","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-geofence-create-a-new-geofence"},"requestBody":{"required":false,"content":{"application/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"Name of the geofence.","example":"market","x-mappls-field-path":"name"},"buffer":{"type":"integer","description":"Buffer is nothing but radius in meters. If passed then by default the system will create a circle geofence. If buffer is not passed then by default the system will create a 'point' type geofence with radius as 50 meters","example":1000,"x-mappls-field-path":"buffer"},"geometry":{"type":"string","description":"This is a geoJSON string. You can pass here either 'Point' or 'Polygon'. Point is used for circular geofence, and Polygon is used for a multiple point polygon geofence","example":"28.612964,77.229463","x-mappls-field-path":"geometry"}}},"example":{"name":"market","buffer":1000,"geometry":{"type":"Point","coordinates":[77.2334,28.7676]}}}}},"responses":{"201":{"description":"Created"},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.yaml","x-mappls-source-fingerprint":"03d663d784a8ea9af1a3915cad4395ab716b167774dbf54a73c516bd10bc887a","x-mappls-evidence-score":11,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-geofence-9930a2a5a4","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/geofence/activity":{"get":{"operationId":"intouch-get-geofence-activity-get-all-the-activities-done-by-devices-w-r-t-various-geofences","summary":"Get all the activities done by devices w.r.t various geofences","description":"This API helps to fetch the details of all the activities, such as geofence entry time, exit time etc, which devices perform w.r.t various geofences across a defined date/time range.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-geofence-activity-get-all-the-activities-done-by-devices-w-r-t-various-geofences"},"parameters":[{"name":"deviceId","in":"query","required":true,"description":"id of the device(s) for which you want to fetch the geofence activities. For multiple devices, you can pass comma separated device ids as well in the query string.","schema":{"type":"string","description":"id of the device(s) for which you want to fetch the geofence activities. For multiple devices, you can pass comma separated device ids as well in the query string.","example":5177789777}},{"name":"geofenceId","in":"query","required":false,"description":"id of the geofence(s) for which you want to fetch the geofence activities done by the device. For multiple geofences, you can pass comma separated geofence ids as well in the query string.","schema":{"type":"string","description":"id of the geofence(s) for which you want to fetch the geofence activities done by the device. For multiple geofences, you can pass comma separated geofence ids as well in the query string.","example":45438787}},{"name":"startTime","in":"query","required":true,"description":"Value in timestamp. Start time from where you want to fetch the geofence activities","schema":{"type":"number","description":"Value in timestamp. Start time from where you want to fetch the geofence activities","example":"1700000000000"}},{"name":"endTime","in":"query","required":true,"description":"Value in timestamp. End time till where you want to fetch the geofence activities.","schema":{"type":"number","description":"Value in timestamp. End time till where you want to fetch the geofence activities.","example":"1700000000000"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].entryLongitude":{"type":"number","description":"longitude where the particular device entered the geofence.","example":"77.229463","x-mappls-field-path":"data[].entryLongitude"},"data[].entryLatitude":{"type":"number","description":"latitude where the particular device entered the geofence.","example":"28.612964","x-mappls-field-path":"data[].entryLatitude"},"data[].exitLongitude":{"type":"number","description":"longitude where the particular device exited the geofence.","example":"77.229463","x-mappls-field-path":"data[].exitLongitude"},"data[].exitLatitude":{"type":"number","description":"latitude where the particular device exited the geofence.","example":"28.612964","x-mappls-field-path":"data[].exitLatitude"},"data[].entryTimestamp":{"type":"number","description":"time at which the device entered the particular geofence.","example":"1700000000000","x-mappls-field-path":"data[].entryTimestamp"},"data[].exitTimestamp":{"type":"number","description":"time at which the device exited the particular geofence.","example":"1700000000000","x-mappls-field-path":"data[].exitTimestamp"},"data[].geofenceName":{"type":"string","description":"name of the geofence","example":"my geofence","x-mappls-field-path":"data[].geofenceName"},"data[].geofenceId":{"type":"number","description":"the id of the geofence where the activity took place","example":767676,"x-mappls-field-path":"data[].geofenceId"},"data[].deviceId":{"type":"number","description":"the id of the device which is performing the activities w.r.t the geofence","example":87676,"x-mappls-field-path":"data[].deviceId"}}},"example":{"data":[{"entryLongitude":28.8765,"entryLatitude":56.8765,"exitLongitude":38.8765,"exitLatitude":46.8765,"entryTimestamp":1580105880,"exitTimestamp":1580105880,"geofenceName":"my geofence","geofenceId":767676}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.yaml","x-mappls-source-fingerprint":"03d663d784a8ea9af1a3915cad4395ab716b167774dbf54a73c516bd10bc887a","x-mappls-evidence-score":22,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-geofence-activity-4ab8a9df1d","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/geofence/{id}":{"delete":{"operationId":"intouch-delete-geofence-id-delete-a-geofence","summary":"Delete A Geofence.","description":"This API helps to delete a geofence.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-delete-geofence-id-delete-a-geofence"},"parameters":[{"name":"id","in":"path","required":true,"description":"geofence id.","schema":{"type":"integer","description":"geofence id.","example":"1"}}],"responses":{"200":{"description":"OK - successful operation"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"retire","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.yaml","x-mappls-source-fingerprint":"03d663d784a8ea9af1a3915cad4395ab716b167774dbf54a73c516bd10bc887a","x-mappls-evidence-score":8,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-delete-geofence-id-acd58f4735","x-mappls-generation-count":2,"x-mappls-preferred-generation":true},"get":{"operationId":"intouch-get-geofence-id-get-a-single-or-multiple-geofence-s","summary":"Get A Single Or Multiple Geofence(s).","description":"This API helps to fetch the details of a particular geofence","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-geofence-id-get-a-single-or-multiple-geofence-s"},"parameters":[{"name":"id","in":"path","required":true,"description":"geofence id. This path variable will take precedence even if multiple geofence ids are passed in the query param.","schema":{"type":"integer","description":"geofence id. This path variable will take precedence even if multiple geofence ids are passed in the query param.","example":"1"}},{"name":"id","in":"query","required":false,"description":"geofence id. Use this if you want to get details of specific multiple geofence IDs.","schema":{"type":"string","description":"geofence id. Use this if you want to get details of specific multiple geofence IDs.","example":"51777,89777"}},{"name":"ignoreGeometry","in":"query","required":false,"description":"Non mandatory field, boolean value to fetch geometry details.","schema":{"type":"boolean","description":"Non mandatory field, boolean value to fetch geometry details.","example":"28.612964,77.229463"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"number","description":"Geofence ID","example":"1","x-mappls-field-path":"data[].id"},"data[].name":{"type":"string","description":"name of the geofence.","example":"market","x-mappls-field-path":"data[].name"},"data[].geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"data[].geometry"},"data[].geometry.type":{"type":"string","description":"This defines the type of geofence, it can be point or polygon.","example":"Point","x-mappls-field-path":"data[].geometry.type"},"data[].geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].geometry.coordinates"},"data[].type":{"type":"string","description":"Depending on the type of geofence this value can be Circle(buffer > 50 meters), Polygon or Point(buffer = 50 mtrs)","example":"Circle","x-mappls-field-path":"data[].type"},"data[].buffer":{"type":"number","description":"Radius(in meters) of a circlular geofence","example":65.76,"x-mappls-field-path":"data[].buffer"},"data[].creationTime":{"type":"number","description":"timestamp, in seconds, at which the geofence was created.","example":"1700000000000","x-mappls-field-path":"data[].creationTime"},"data[].updationTime":{"type":"number","description":"timestamp, in seconds, at which the geofence was updated.","example":"1700000000000","x-mappls-field-path":"data[].updationTime"}}},"example":{"data":[{"id":"1","name":"market","geometry":{"type":"Point","coordinates":[77.456,28.2345]},"type":"Circle","buffer":65.76,"creationTime":"1","updationTime":"1"}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.yaml","x-mappls-source-fingerprint":"03d663d784a8ea9af1a3915cad4395ab716b167774dbf54a73c516bd10bc887a","x-mappls-evidence-score":21,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-geofence-id-9d8bafa2d5","x-mappls-generation-count":2,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-geofence-id-update-a-geofence","summary":"Update A Geofence.","description":"This API helps to update a particular geofence.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-geofence-id-update-a-geofence"},"parameters":[{"name":"id","in":"path","required":true,"description":"geofence id.","schema":{"type":"integer","description":"geofence id.","example":"1"}}],"requestBody":{"required":false,"content":{"application/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"Name of the geofence.","example":"market","x-mappls-field-path":"name"},"buffer":{"type":"integer","description":"Buffer is nothing but radius in meters. If passed then by default the system will create a circle geofence. If buffer is not passed then by default the system will create a 'point' type geofence with radius as 50 meters","example":1000,"x-mappls-field-path":"buffer"},"geometry":{"type":"string","description":"This is a geoJSON string. You can pass here either 'Point' or 'Polygon'. Point is used for circular geofence, and Polygon is used for a multiple point polygon geofence","example":"28.612964,77.229463","x-mappls-field-path":"geometry"}}},"example":{"name":"market","buffer":1000,"geometry":{"type":"Point","coordinates":[77.2334,28.7676]}}}}},"responses":{"200":{"description":"OK - successful operation"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.yaml","x-mappls-source-fingerprint":"03d663d784a8ea9af1a3915cad4395ab716b167774dbf54a73c516bd10bc887a","x-mappls-evidence-score":11,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-geofence-id-83a7719be5","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/geofences":{"get":{"operationId":"intouch-get-geofences-gets-all-the-configured-geofence-s","summary":"Gets All The Configured Geofence(s)","description":"This API returns the list of all the configured geofences","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-geofences-gets-all-the-configured-geofence-s"},"parameters":[{"name":"ignoreGeometry","in":"query","required":false,"description":"Flag to get geometry data.","schema":{"type":"boolean","description":"Flag to get geometry data.","example":"28.612964,77.229463"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"number","description":"Geofence ID","example":"1","x-mappls-field-path":"data[].id"},"data[].name":{"type":"string","description":"name of the geofence.","example":"market","x-mappls-field-path":"data[].name"},"data[].geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"data[].geometry"},"data[].geometry.type":{"type":"string","description":"This defines the type of geofence, it can be point or polygon.","example":"Point","x-mappls-field-path":"data[].geometry.type"},"data[].geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].geometry.coordinates"},"data[].type":{"type":"string","description":"Depending on the type of geofence this value can be Circle(buffer > 50 meters), Polygon or Point(buffer = 50 mtrs)","example":"Circle","x-mappls-field-path":"data[].type"},"data[].buffer":{"type":"number","description":"Radius(in meters) of a circlular geofence","example":65.76,"x-mappls-field-path":"data[].buffer"},"data[].creationTime":{"type":"number","description":"timestamp, in seconds, at which the geofence was created.","example":"1700000000000","x-mappls-field-path":"data[].creationTime"},"data[].updationTime":{"type":"number","description":"timestamp, in seconds, at which the geofence was updated.","example":"1700000000000","x-mappls-field-path":"data[].updationTime"}}},"example":{"data":[{"id":"1","name":"market","geometry":{"type":"Point","coordinates":[77.456,28.2345]},"type":"Circle","buffer":65.76,"creationTime":"1","updationTime":"1"}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.json","x-mappls-source-fingerprint":"fc26724559038e8d114001105966c2bd30e35ac4f8c0a1644d9241eb4bd64425","x-mappls-evidence-score":19,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-geofences-e64a4614bb","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-geofences-create-a-new-geofence","summary":"Create A New Geofence","description":"This API helps to create a new geofence","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-geofences-create-a-new-geofence"},"requestBody":{"required":false,"content":{"application/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"Name of the geofence.","example":"market","x-mappls-field-path":"name"},"buffer":{"type":"integer","description":"Buffer is nothing but radius in meters. If passed then by default the system will create a circle geofence. If buffer is not passed then by default the system will create a 'point' type geofence with radius as 50 meters","example":1000,"x-mappls-field-path":"buffer"},"geometry":{"type":"string","description":"This is a geoJSON string. You can pass here either 'Point' or 'Polygon'. Point is used for circular geofence, and Polygon is used for a multiple point polygon geofence","example":"28.612964,77.229463","x-mappls-field-path":"geometry"}}},"example":{"name":"market","buffer":1000,"geometry":{"type":"Point","coordinates":[77.2334,28.7676]}}}}},"responses":{"201":{"description":"Created"},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.json","x-mappls-source-fingerprint":"fc26724559038e8d114001105966c2bd30e35ac4f8c0a1644d9241eb4bd64425","x-mappls-evidence-score":11,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-geofences-d5c55f4698","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/geofences/activities":{"get":{"operationId":"intouch-get-geofences-activities-get-all-the-activities-done-by-devices-w-r-t-various-geofences","summary":"Get all the activities done by devices w.r.t various geofences","description":"This API helps to fetch the details of all the activities, such as geofence entry time, exit time etc, which devices perform w.r.t various geofences across a defined date/time range.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-geofences-activities-get-all-the-activities-done-by-devices-w-r-t-various-geofences"},"parameters":[{"name":"deviceId","in":"query","required":true,"description":"id of the device(s) for which you want to fetch the geofence activities. For multiple devices, you can pass comma separated device ids as well in the query string.","schema":{"type":"string","description":"id of the device(s) for which you want to fetch the geofence activities. For multiple devices, you can pass comma separated device ids as well in the query string.","example":"51777,89777"}},{"name":"geofenceId","in":"query","required":false,"description":"id of the geofence(s) for which you want to fetch the geofence activities done by the device. For multiple geofences, you can pass comma separated geofence ids as well in the query string.","schema":{"type":"string","description":"id of the geofence(s) for which you want to fetch the geofence activities done by the device. For multiple geofences, you can pass comma separated geofence ids as well in the query string.","example":"4543,8787"}},{"name":"startTime","in":"query","required":true,"description":"Value in timestamp. Start time from where you want to fetch the geofence activities","schema":{"type":"number","description":"Value in timestamp. Start time from where you want to fetch the geofence activities","example":"1700000000000"}},{"name":"endTime","in":"query","required":true,"description":"Value in timestamp. End time till where you want to fetch the geofence activities.","schema":{"type":"number","description":"Value in timestamp. End time till where you want to fetch the geofence activities.","example":"1700000000000"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].entryLongitude":{"type":"number","description":"longitude where the particular device entered the geofence.","example":"77.229463","x-mappls-field-path":"data[].entryLongitude"},"data[].entryLatitude":{"type":"number","description":"latitude where the particular device entered the geofence.","example":"28.612964","x-mappls-field-path":"data[].entryLatitude"},"data[].exitLongitude":{"type":"number","description":"longitude where the particular device exited the geofence.","example":"77.229463","x-mappls-field-path":"data[].exitLongitude"},"data[].exitLatitude":{"type":"number","description":"latitude where the particular device exited the geofence.","example":"28.612964","x-mappls-field-path":"data[].exitLatitude"},"data[].entryTimestamp":{"type":"number","description":"time at which the device entered the particular geofence.","example":"1700000000000","x-mappls-field-path":"data[].entryTimestamp"},"data[].exitTimestamp":{"type":"number","description":"time at which the device exited the particular geofence.","example":"1700000000000","x-mappls-field-path":"data[].exitTimestamp"},"data[].geofenceName":{"type":"string","description":"name of the geofence","example":"my geofence","x-mappls-field-path":"data[].geofenceName"},"data[].geofenceId":{"type":"number","description":"the id of the geofence where the activity took place","example":767676,"x-mappls-field-path":"data[].geofenceId"},"data[].deviceId":{"type":"number","description":"the id of the device which is performing the activities w.r.t the geofence","example":87676,"x-mappls-field-path":"data[].deviceId"}}},"example":{"data":[{"entryLongitude":28.8765,"entryLatitude":56.8765,"exitLongitude":38.8765,"exitLatitude":46.8765,"entryTimestamp":1580105880,"exitTimestamp":1580105880,"geofenceName":"my geofence","geofenceId":767676}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.json","x-mappls-source-fingerprint":"fc26724559038e8d114001105966c2bd30e35ac4f8c0a1644d9241eb4bd64425","x-mappls-evidence-score":22,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-geofences-activities-5e4475de72","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/geofences/{id}":{"delete":{"operationId":"intouch-delete-geofences-id-delete-a-geofence","summary":"Delete A Geofence.","description":"This API helps to delete a geofence.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-delete-geofences-id-delete-a-geofence"},"parameters":[{"name":"id","in":"path","required":true,"description":"geofence id.","schema":{"type":"integer","description":"geofence id.","example":"1"}}],"responses":{"200":{"description":"OK - successful operation"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"retire","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.json","x-mappls-source-fingerprint":"fc26724559038e8d114001105966c2bd30e35ac4f8c0a1644d9241eb4bd64425","x-mappls-evidence-score":8,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-delete-geofences-id-ac8cb53c93","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"get":{"operationId":"intouch-get-geofences-id-get-a-single-or-multiple-geofence-s","summary":"Get A Single Or Multiple Geofence(s).","description":"This API helps to fetch the details of a particular geofence","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-geofences-id-get-a-single-or-multiple-geofence-s"},"parameters":[{"name":"id","in":"path","required":true,"description":"geofence id. This path variable will take precedence even if multiple geofence ids are passed in the query param.","schema":{"type":"integer","description":"geofence id. This path variable will take precedence even if multiple geofence ids are passed in the query param.","example":"1"}},{"name":"id","in":"query","required":false,"description":"geofence id. Use this if you want to get details of specific multiple geofence IDs.","schema":{"type":"string","description":"geofence id. Use this if you want to get details of specific multiple geofence IDs.","example":"51777,89777"}},{"name":"ignoreGeometry","in":"query","required":false,"description":"Non mandatory field, boolean value to fetch geometry details.","schema":{"type":"boolean","description":"Non mandatory field, boolean value to fetch geometry details.","example":"28.612964,77.229463"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"number","description":"Geofence ID","example":"1","x-mappls-field-path":"data[].id"},"data[].name":{"type":"string","description":"name of the geofence.","example":"market","x-mappls-field-path":"data[].name"},"data[].geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"data[].geometry"},"data[].geometry.type":{"type":"string","description":"This defines the type of geofence, it can be point or polygon.","example":"Point","x-mappls-field-path":"data[].geometry.type"},"data[].geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].geometry.coordinates"},"data[].type":{"type":"string","description":"Depending on the type of geofence this value can be Circle(buffer > 50 meters), Polygon or Point(buffer = 50 mtrs)","example":"Circle","x-mappls-field-path":"data[].type"},"data[].buffer":{"type":"number","description":"Radius(in meters) of a circlular geofence","example":65.76,"x-mappls-field-path":"data[].buffer"},"data[].creationTime":{"type":"number","description":"timestamp, in seconds, at which the geofence was created.","example":"1700000000000","x-mappls-field-path":"data[].creationTime"},"data[].updationTime":{"type":"number","description":"timestamp, in seconds, at which the geofence was updated.","example":"1700000000000","x-mappls-field-path":"data[].updationTime"}}},"example":{"data":[{"id":"1","name":"market","geometry":{"type":"Point","coordinates":[77.456,28.2345]},"type":"Circle","buffer":65.76,"creationTime":"1","updationTime":"1"}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.json","x-mappls-source-fingerprint":"fc26724559038e8d114001105966c2bd30e35ac4f8c0a1644d9241eb4bd64425","x-mappls-evidence-score":21,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-geofences-id-1d8903bbf6","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-geofences-id-update-a-geofence","summary":"Update A Geofence.","description":"This API helps to update a particular geofence.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-geofences-id-update-a-geofence"},"parameters":[{"name":"id","in":"path","required":true,"description":"geofence id.","schema":{"type":"integer","description":"geofence id.","example":"1"}}],"requestBody":{"required":false,"content":{"application/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"Name of the geofence.","example":"market","x-mappls-field-path":"name"},"buffer":{"type":"integer","description":"Buffer is nothing but radius in meters. If passed then by default the system will create a circle geofence. If buffer is not passed then by default the system will create a 'point' type geofence with radius as 50 meters","example":1000,"x-mappls-field-path":"buffer"},"geometry":{"type":"string","description":"This is a geoJSON string. You can pass here either 'Point' or 'Polygon'. Point is used for circular geofence, and Polygon is used for a multiple point polygon geofence","example":"28.612964,77.229463","x-mappls-field-path":"geometry"}}},"example":{"name":"market","buffer":1000,"geometry":{"type":"Point","coordinates":[77.2334,28.7676]}}}}},"responses":{"200":{"description":"OK - successful operation"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.json","x-mappls-source-fingerprint":"fc26724559038e8d114001105966c2bd30e35ac4f8c0a1644d9241eb4bd64425","x-mappls-evidence-score":11,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-geofences-id-f5b16a893d","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/group":{"get":{"operationId":"intouch-get-group-this-api-will-get-all-the-groups-for-a-user","summary":"This API will get all the groups for a user.","description":"Based on the passed token key, the API will return the list of all groups.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-group-this-api-will-get-all-the-groups-for-a-user"},"parameters":[{"name":"id","in":"query","required":false,"description":"This is the alarm's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all alarm configurations in the account. You can pass single value or comma separated alarm IDs for multiple values.","schema":{"type":"string","description":"This is the alarm's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all alarm configurations in the account. You can pass single value or comma separated alarm IDs for multiple values.","example":"23889,89876"}},{"name":"deviceId","in":"query","required":false,"description":"This is device ID. API will return data based on the configs set for the passed device IDs. You can pass a single device ID or comma seperated multiple device IDs.","schema":{"type":"string","description":"This is device ID. API will return data based on the configs set for the passed device IDs. You can pass a single device ID or comma seperated multiple device IDs.","example":"24567,10018"}},{"name":"alarmType","in":"query","required":false,"description":"This is alarm type. API will return data based on the passed alarm types. You can pass a single alarm type or comma seperated multiple alarm types.","schema":{"type":"string","description":"This is alarm type. API will return data based on the passed alarm types. You can pass a single alarm type or comma seperated multiple alarm types.","example":"177,90"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"number","description":"This is group ID","example":7656,"x-mappls-field-path":"data[].id"},"data[].deviceId":{"type":"array","items":{"type":"number"},"description":"Device ID(s) which associated with the group.","example":[67700,8987],"x-mappls-field-path":"data[].deviceId"},"data[].name":{"type":"string","description":"name of the group","example":"my group","x-mappls-field-path":"data[].name"},"data[].createdOn":{"type":"number","description":"Time at which the group got created.","example":1567654565,"x-mappls-field-path":"data[].createdOn"},"data[].updatedOn":{"type":"integer","description":"Time at which the group got updated.","example":1567654565,"x-mappls-field-path":"data[].updatedOn"},"data[].colorCode":{"type":"string","description":"color associated with the group","example":"example","x-mappls-field-path":"data[].colorCode"}}},"example":{"data":[{"id":7656,"deviceId":[67700,8987],"name":"my group","createdOn":1567654565,"updatedOn":1567654565,"colorCode":"example"}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/group.yaml","x-mappls-source-fingerprint":"0ce822e24d55afb0b8d031f312544296e051e9eb3bfc859298a2f316330448ea","x-mappls-evidence-score":18,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-group-cd45df4f32","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-group-this-api-will-create-a-group","summary":"This API will create a group.","description":"Based on the input parameters provided to this POST group API, a new group will get created for a single or multiple devices","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-group-this-api-will-create-a-group"},"parameters":[{"name":"name","in":"query","required":true,"description":"This the name of the group which you want to create.","schema":{"type":"string","description":"This the name of the group which you want to create.","example":"example"}},{"name":"deviceId","in":"query","required":false,"description":"These are the IDs of the devices which you want to have in this group. You can pass a single device id or a set of multiple ids separated by comma.","schema":{"type":"array","items":{"type":"number"},"description":"These are the IDs of the devices which you want to have in this group. You can pass a single device id or a set of multiple ids separated by comma.","example":[100967658798]}},{"name":"colorCode","in":"query","required":false,"description":"This the color code(in hex format) which you want to associated with the group.","schema":{"type":"string","description":"This the color code(in hex format) which you want to associated with the group.","example":"#24545"}}],"responses":{"201":{"description":"Created"},"203":{"description":"Device Not Found or invalid device id"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/group.yaml","x-mappls-source-fingerprint":"0ce822e24d55afb0b8d031f312544296e051e9eb3bfc859298a2f316330448ea","x-mappls-evidence-score":11,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-group-20d5915253","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/group/{id}":{"delete":{"operationId":"intouch-delete-group-id-deletes-a-group","summary":"Deletes a group","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-delete-group-id-deletes-a-group"},"parameters":[{"name":"id","in":"path","required":true,"description":"id of the group which you want to delete","schema":{"type":"integer","description":"id of the group which you want to delete","example":"1"}}],"responses":{"200":{"description":"OK - successful operation"},"204":{"description":"No Content Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"retire","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/group.yaml","x-mappls-source-fingerprint":"0ce822e24d55afb0b8d031f312544296e051e9eb3bfc859298a2f316330448ea","x-mappls-evidence-score":9,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-delete-group-id-66dadd4bb8","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-group-id-updates-a-group","summary":"Updates a group","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-group-id-updates-a-group"},"parameters":[{"name":"id","in":"path","required":true,"description":"This the ID of the group which you want to update.","schema":{"type":"number","description":"This the ID of the group which you want to update.","example":"1"}},{"name":"name","in":"query","required":true,"description":"This the name of the group which you want to update.","schema":{"type":"string","description":"This the name of the group which you want to update.","example":"example"}},{"name":"deviceId","in":"query","required":false,"description":"These are the IDs of the devices which you want to update in this group. You can pass a single device id or a set of multiple ids separated by comma.","schema":{"type":"array","items":{"type":"number"},"description":"These are the IDs of the devices which you want to update in this group. You can pass a single device id or a set of multiple ids separated by comma.","example":[100967658798]}},{"name":"colorCode","in":"query","required":false,"description":"This the color code(in hex format) which you want to associated with the group.","schema":{"type":"string","description":"This the color code(in hex format) which you want to associated with the group.","example":"#24545"}}],"responses":{"200":{"description":"OK - successful operation"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/group.yaml","x-mappls-source-fingerprint":"0ce822e24d55afb0b8d031f312544296e051e9eb3bfc859298a2f316330448ea","x-mappls-evidence-score":11,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-group-id-6f0e4605af","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/groups":{"get":{"operationId":"intouch-get-groups-this-api-will-get-all-the-groups-for-a-user","summary":"This API will get all the groups for a user.","description":"Based on the passed token key, the API will return the list of all groups.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-groups-this-api-will-get-all-the-groups-for-a-user"},"parameters":[{"name":"id","in":"query","required":false,"description":"This is the alarm's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all alarm configurations in the account. You can pass single value or comma separated alarm IDs for multiple values.","schema":{"type":"string","description":"This is the alarm's ID, a non-mandatory parameter. If not passed then by default the API will return the list of all alarm configurations in the account. You can pass single value or comma separated alarm IDs for multiple values.","example":"23889,89876"}},{"name":"deviceId","in":"query","required":false,"description":"This is device ID. API will return data based on the configs set for the passed device IDs. You can pass a single device ID or comma seperated multiple device IDs.","schema":{"type":"string","description":"This is device ID. API will return data based on the configs set for the passed device IDs. You can pass a single device ID or comma seperated multiple device IDs.","example":"24567,10018"}},{"name":"alarmType","in":"query","required":false,"description":"This is alarm type. API will return data based on the passed alarm types. You can pass a single alarm type or comma seperated multiple alarm types.","schema":{"type":"string","description":"This is alarm type. API will return data based on the passed alarm types. You can pass a single alarm type or comma seperated multiple alarm types.","example":"177,90"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"number","description":"This is group ID","example":7656,"x-mappls-field-path":"data[].id"},"data[].deviceId":{"type":"array","items":{"type":"number"},"description":"Device ID(s) which associated with the group.","example":[67700,8987],"x-mappls-field-path":"data[].deviceId"},"data[].name":{"type":"string","description":"name of the group","example":"my group","x-mappls-field-path":"data[].name"},"data[].createdOn":{"type":"number","description":"Time at which the group got created.","example":1567654565,"x-mappls-field-path":"data[].createdOn"},"data[].updatedOn":{"type":"integer","description":"Time at which the group got updated.","example":1567654565,"x-mappls-field-path":"data[].updatedOn"},"data[].colorCode":{"type":"string","description":"color associated with the group","example":"example","x-mappls-field-path":"data[].colorCode"}}},"example":{"data":[{"id":7656,"deviceId":[67700,8987],"name":"my group","createdOn":1567654565,"updatedOn":1567654565,"colorCode":"example"}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/group.json","x-mappls-source-fingerprint":"669b74b917e37baa2cafdb2411c242905e2b6d41de32726767a387c1838ea87d","x-mappls-evidence-score":18,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-groups-5f103c22ec","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-groups-this-api-will-create-a-group","summary":"This API will create a group.","description":"Based on the input parameters provided to this POST group API, a new group will get created for a single or multiple devices","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-groups-this-api-will-create-a-group"},"parameters":[{"name":"name","in":"query","required":true,"description":"This the name of the group which you want to create.","schema":{"type":"string","description":"This the name of the group which you want to create.","example":"example"}},{"name":"deviceId","in":"query","required":false,"description":"These are the IDs of the devices which you want to have in this group. You can pass a single device id or a set of multiple ids separated by comma.","schema":{"type":"array","items":{"type":"number"},"description":"These are the IDs of the devices which you want to have in this group. You can pass a single device id or a set of multiple ids separated by comma.","example":["1009,6765,8798"]}},{"name":"colorCode","in":"query","required":false,"description":"This the color code(in hex format) which you want to associated with the group.","schema":{"type":"string","description":"This the color code(in hex format) which you want to associated with the group.","example":"#24545"}}],"responses":{"201":{"description":"Created"},"203":{"description":"Device Not Found or invalid device id"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/group.json","x-mappls-source-fingerprint":"669b74b917e37baa2cafdb2411c242905e2b6d41de32726767a387c1838ea87d","x-mappls-evidence-score":11,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-groups-50e5a70cf2","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/groups/{id}":{"delete":{"operationId":"intouch-delete-groups-id-deletes-a-group","summary":"Deletes a group","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-delete-groups-id-deletes-a-group"},"parameters":[{"name":"id","in":"path","required":true,"description":"id of the group which you want to delete","schema":{"type":"integer","description":"id of the group which you want to delete","example":"1"}}],"responses":{"200":{"description":"OK - successful operation"},"204":{"description":"No Content Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"retire","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/group.json","x-mappls-source-fingerprint":"669b74b917e37baa2cafdb2411c242905e2b6d41de32726767a387c1838ea87d","x-mappls-evidence-score":9,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-delete-groups-id-955f5ff6d2","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-groups-id-updates-a-group","summary":"Updates a group","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-groups-id-updates-a-group"},"parameters":[{"name":"id","in":"path","required":true,"description":"This the ID of the group which you want to update.","schema":{"type":"number","description":"This the ID of the group which you want to update.","example":"1"}},{"name":"name","in":"query","required":true,"description":"This the name of the group which you want to update.","schema":{"type":"string","description":"This the name of the group which you want to update.","example":"example"}},{"name":"deviceId","in":"query","required":false,"description":"These are the IDs of the devices which you want to update in this group. You can pass a single device id or a set of multiple ids separated by comma.","schema":{"type":"array","items":{"type":"number"},"description":"These are the IDs of the devices which you want to update in this group. You can pass a single device id or a set of multiple ids separated by comma.","example":["1009,6765,8798"]}},{"name":"colorCode","in":"query","required":false,"description":"This the color code(in hex format) which you want to associated with the group.","schema":{"type":"string","description":"This the color code(in hex format) which you want to associated with the group.","example":"#24545"}}],"responses":{"200":{"description":"OK - successful operation"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/group.json","x-mappls-source-fingerprint":"669b74b917e37baa2cafdb2411c242905e2b6d41de32726767a387c1838ea87d","x-mappls-evidence-score":11,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-groups-id-1c5fee2419","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/devices/nearby":{"get":{"operationId":"intouch-get-devices-nearby-gets-the-list-of-all-the-nearby-devices","summary":"Gets the list of all the nearby devices.","description":"This API returns accurate live location and related data of all the nearby vehicles, assets & people, within the specified buffer range, with help of connected devices/sensors/mobiles to provide location awareness to users of your app. The API provides real-time visibility of your tracked objects, giving not just location information, but multiple additional fields which add value to your application. The API is capable of being used for multiple use cases: be it for transport - logistics or for personnel information services for all kinds of web or mobile development platforms.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-devices-nearby-gets-the-list-of-all-the-nearby-devices"},"parameters":[{"name":"buffer","in":"query","required":false,"description":"buffer distance (in meters) upto which the api will return the nearby vehicles/assets. Non mandatory attribute. If not sent by default buffer distance will be taken as 50 meters.","schema":{"type":"number","description":"buffer distance (in meters) upto which the api will return the nearby vehicles/assets. Non mandatory attribute. If not sent by default buffer distance will be taken as 50 meters.","example":"1"}},{"name":"geometry","in":"query","required":true,"description":"location coordinates in geojson format. vehicles/assets will be fetched around this location as per the configured buffer distance.","schema":{"type":"string","description":"location coordinates in geojson format. vehicles/assets will be fetched around this location as per the configured buffer distance.","example":"28.612964,77.229463"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].id":{"type":"integer","example":"1","x-mappls-field-path":"data[].id"},"data[].active":{"type":"string","description":"device active status","enum":[true,false],"example":true,"x-mappls-field-path":"data[].active"},"data[].status":{"type":"number","description":"device movement status 1 -> moving 2 -> idle i,e ignition is on and speed stopped i,e engine is off 4 -> towing i,e ignition is off, but vehicle speed 5 -> no data i,e no communication of device with intouch server or no GPRS signal 6 -> power off 7 -> no gps i,e satellite count is less than 4 8 -> on trip i,e device is currently on an active trip 9 -> free vehicle i,e device is not on any active trip","example":1,"x-mappls-field-path":"data[].status"},"data[].vehicleBattery":{"type":"number","example":13568.98,"x-mappls-field-path":"data[].vehicleBattery"},"data[].location":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"data[].location"},"data[].location.gpsTime":{"type":"number","example":"1700000000000","x-mappls-field-path":"data[].location.gpsTime"},"data[].location.gprsTime":{"type":"number","example":"1700000000000","x-mappls-field-path":"data[].location.gprsTime"},"data[].location.latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data[].location.latitude"},"data[].location.longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data[].location.longitude"},"data[].location.address":{"type":"string","example":"244, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 2 m from Usha Exim Pvt Ltd pin-110020","x-mappls-field-path":"data[].location.address"},"data[].location.altitude":{"type":"number","example":234,"x-mappls-field-path":"data[].location.altitude"},"data[].location.heading":{"type":"number","example":196.868,"x-mappls-field-path":"data[].location.heading"},"data[].location.speedKph":{"type":"number","example":27.85,"x-mappls-field-path":"data[].location.speedKph"},"data[].location.odometer":{"type":"number","example":12548.22,"x-mappls-field-path":"data[].location.odometer"},"data[].deviceDetails":{"type":"object","example":"example","x-mappls-field-path":"data[].deviceDetails"},"data[].deviceDetails.name":{"type":"string","example":"DL3CCM8097","x-mappls-field-path":"data[].deviceDetails.name"},"data[].deviceDetails.registrationNumber":{"type":"string","example":"DL3CCM8097","x-mappls-field-path":"data[].deviceDetails.registrationNumber"},"data[].deviceDetails.deviceType":{"type":"string","enum":["car","truck","bus","bike","tracktor","JCB","excavator"],"example":"car","x-mappls-field-path":"data[].deviceDetails.deviceType"},"data[].alerts":{"type":"object","example":"example","x-mappls-field-path":"data[].alerts"},"data[].alerts.deviceId":{"type":"number","description":"Will come only in case of /alarmLog GET API response","example":8989,"x-mappls-field-path":"data[].alerts.deviceId"},"data[].alerts.timestamp":{"type":"number","description":"Time at which the alert got generated","example":"1700000000000","x-mappls-field-path":"data[].alerts.timestamp"},"data[].alerts.latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data[].alerts.latitude"},"data[].alerts.longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data[].alerts.longitude"},"data[].alerts.address":{"type":"string","description":"Location address at which the alarm got generated","example":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","x-mappls-field-path":"data[].alerts.address"},"data[].alerts.alarmType":{"type":"integer","description":"Type of alarm to create. Following are the alarm types & their corresponding IDs. IGNITION: 21, OVERSPEED: 22, UNPLUGGED: 23, PANIC: 24, GEOFENCE: 26, STOPPAGE: 27, IDLE: 28, TOWING: 29, GPRS CONNECTIVITY: 126, VEHICLE BATTERY: 129, MILEAGE: 133, GPS CONNECTIVITY: 146, DISTANCE COVERED: 151, INTERNAL BATTERY VOLTAGE:161","example":28,"x-mappls-field-path":"data[].alerts.alarmType"},"data[].alerts.limit":{"type":"integer","description":"Alarm limit as set in the config. For example, if an overspeed alarm set on limit of 44 km/hr in the alarm config setting, then this attribute will return 44 km/hr","example":44,"x-mappls-field-path":"data[].alerts.limit"},"data[].alerts.duration":{"type":"integer","description":"Alarm duration limit as set in the alarm config section. For example, if duration of overspeed alarm is set as 20 secs, then the alarm will generate when the vehicle overspeeds for a duration of 20 secs","example":20,"x-mappls-field-path":"data[].alerts.duration"},"data[].alerts.actualLimit":{"type":"integer","description":"The actual data received from the device at that particular moment when the alarm got generated","example":57,"x-mappls-field-path":"data[].alerts.actualLimit"},"data[].alerts.actualDuration":{"type":"integer","description":"Actual duration for which the device breached the alarm config limit","example":25,"x-mappls-field-path":"data[].alerts.actualDuration"},"data[].alerts.severity":{"type":"integer","description":"0 - Low Severity. 1 - High Severity","example":1,"x-mappls-field-path":"data[].alerts.severity"},"data[].alerts.data":{"type":"integer","description":"Describes the state of the alarm. IGNITION(type = 21), 0: OFF & 1: ON. AC(type=25), 0: OFF, 1: ON. GEOFENCE(type=26), 1: Entry & Exit Geofence 2: Entry Geofence, 3: Leaving Geofence & 4: Long Stay In Geofence","example":1,"x-mappls-field-path":"data[].alerts.data"},"data[].alerts.geofenceId":{"type":"number","description":"This is the ID of the geofence for which the alarm got generated. This will come only when the 'type' field return 26 i,e geofence.","example":987876,"x-mappls-field-path":"data[].alerts.geofenceId"},"data[].canInfo":{"type":"object","example":"example","x-mappls-field-path":"data[].canInfo"},"data[].canInfo.calcEngineVal":{"type":"integer","example":0,"x-mappls-field-path":"data[].canInfo.calcEngineVal"},"data[].canInfo.greenDriveType":{"type":"string","description":"HA(Harsh acceleration), HB(Harsh Breaking), HC(Harsh Cornering)","example":"HA","x-mappls-field-path":"data[].canInfo.greenDriveType"},"data[].canInfo.canTimestamp":{"type":"number","description":"Exact time at which the CAN data got generated by the device","example":"1700000000000","x-mappls-field-path":"data[].canInfo.canTimestamp"},"data[].canInfo.coolantTemp":{"type":"number","example":87,"x-mappls-field-path":"data[].canInfo.coolantTemp"},"data[].canInfo.engineRPM":{"type":"integer","example":796,"x-mappls-field-path":"data[].canInfo.engineRPM"},"data[].canInfo.accelPedal":{"type":"number","description":"This is accelerator pedal value in percentage.","example":8.4,"x-mappls-field-path":"data[].canInfo.accelPedal"},"data[].canInfo.parkBrake":{"type":"number","description":"This is parking break. 0 means parking break is disengaged & 1 means parking break is engaged","example":0,"x-mappls-field-path":"data[].canInfo.parkBrake"},"data[].canInfo.breakPedal":{"type":"number","description":"1 means break pedal is engaged & 0 means break pedal is disengaged","example":0,"x-mappls-field-path":"data[].canInfo.breakPedal"},"data[].canInfo.fuelLevel":{"type":"integer","description":"Level of the fuel in liters","example":14,"x-mappls-field-path":"data[].canInfo.fuelLevel"},"data[].canInfo.driverDoor":{"type":"number","description":"1 means door is open & 0 means door is closed","example":0,"x-mappls-field-path":"data[].canInfo.driverDoor"},"data[].canInfo.headLights":{"type":"number","description":"1 means ON & 0 means OFF","example":1,"x-mappls-field-path":"data[].canInfo.headLights"},"data[].canInfo.blinker":{"type":"number","description":"1 means ON & 0 means OFF","example":0,"x-mappls-field-path":"data[].canInfo.blinker"},"data[].canInfo.gearState":{"type":"number","description":"0 is Neutral, 1 is Drive, 2 is Sports, 3 is Reverse","example":"1700000000000","x-mappls-field-path":"data[].canInfo.gearState"},"data[].canInfo.intakeAirTemp":{"type":"number","description":"This is the intake air temperature of the engine.","example":62,"x-mappls-field-path":"data[].canInfo.intakeAirTemp"},"data[].canInfo.intakeabsolutePress":{"type":"number","description":"This is the intake absolute pressure of the engine. It is defined in Pa(Pascal)","example":42,"x-mappls-field-path":"data[].canInfo.intakeabsolutePress"},"data[].canInfo.ac":{"type":"integer","description":"1 means AC is ON & 0 means AC is OFF","example":0,"x-mappls-field-path":"data[].canInfo.ac"},"data[].canInfo.fuelConsAVG":{"type":"integer","description":"Fuel constant average","example":99,"x-mappls-field-path":"data[].canInfo.fuelConsAVG"},"data[].deviceFaults":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data[].deviceFaults"},"data[].deviceFaults[].code":{"type":"integer","example":1001,"x-mappls-field-path":"data[].deviceFaults[].code"},"data[].deviceFaults[].timetamp":{"type":"number","example":"1700000000000","x-mappls-field-path":"data[].deviceFaults[].timetamp"},"data[].deviceFaults[].status":{"type":"integer","description":"Describes the status of the fault which was detected. 0: OPEN & 1: Close.","example":0,"x-mappls-field-path":"data[].deviceFaults[].status"},"data[].deviceFaults[].closedOn":{"type":"number","example":556567872,"x-mappls-field-path":"data[].deviceFaults[].closedOn"},"data[].currentGeofence":{"type":"array","items":{"type":"number"},"example":"example","x-mappls-field-path":"data[].currentGeofence"},"data[].todaysDrive":{"type":"object","example":"example","x-mappls-field-path":"data[].todaysDrive"},"data[].todaysDrive.todayKms":{"type":"number","example":55.67,"x-mappls-field-path":"data[].todaysDrive.todayKms"},"data[].todaysDrive.todayMovementTime":{"type":"number","description":"Value is in seconds","example":"1700000000000","x-mappls-field-path":"data[].todaysDrive.todayMovementTime"},"data[].todaysDrive.todayIdleTime":{"type":"number","description":"Value is in seconds","example":"1700000000000","x-mappls-field-path":"data[].todaysDrive.todayIdleTime"},"data[].todaysDrive.todayDriveCount":{"type":"integer","example":5,"x-mappls-field-path":"data[].todaysDrive.todayDriveCount"}}},"example":{"data":[{"id":"1","active":true,"status":1,"vehicleBattery":13568.98,"location":{"gpsTime":1574736922,"gprsTime":1574736922,"latitude":28.551255163434,"longitude":77.2687,"address":"244, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 2 m from Usha Exim Pvt Ltd pin-110020","altitude":234,"heading":196.868,"speedKph":27.85},"deviceDetails":{"name":"DL3CCM8097","registrationNumber":"DL3CCM8097","deviceType":"car"},"alerts":{"deviceId":8989,"timestamp":1577589789,"latitude":28.550962381896,"longitude":77.26890675033,"address":"237, Okhla Industrial Estate Phase 3, New Delhi, Delhi. 19 m from Wipro BPO Corporate Office pin-110020","alarmType":28,"limit":44,"duration":20},"canInfo":{"calcEngineVal":0,"greenDriveType":"HA","canTimestamp":1568362645,"coolantTemp":87,"engineRPM":796,"accelPedal":8.4,"parkBrake":0,"breakPedal":0}}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid device ID supplied or invalid data type. For example, input attribute \"buffer\" is of type number but string value gets passed or invalid coordinates location for location type \"polygon\" in geometry geojson object etc.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/device.json","x-mappls-source-fingerprint":"58a17aea1fc8a386e467f0266fb5d92e52e148c709fbcb95565be5c0f25895a4","x-mappls-evidence-score":72,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-devices-nearby-8ab0df890e","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/trips":{"get":{"operationId":"intouch-get-trips-this-api-will-get-all-the-trips-for-a-user","summary":"This API will get all the trips for a user.","description":"Based on the passed token key, the API will return the list of all the trips.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-trips-this-api-will-get-all-the-trips-for-a-user"},"parameters":[{"name":"limit","in":"query","required":false,"description":"will limit the records as per the passed value.","schema":{"type":"integer","description":"will limit the records as per the passed value.","example":10}},{"name":"status","in":"query","required":false,"description":"pass 1 to get active trips & 2 for completed trips.","schema":{"type":"integer","description":"pass 1 to get active trips & 2 for completed trips.","example":1}},{"name":"deviceId","in":"query","required":false,"description":"Pass device IDs if you want to get trips associated with partcular devices.","schema":{"type":"string","description":"Pass device IDs if you want to get trips associated with partcular devices.","example":"2223,7654"}},{"name":"startTime","in":"query","required":false,"description":"Pass if you wnat to get trips after this start timestamp.","schema":{"type":"number","description":"Pass if you wnat to get trips after this start timestamp.","example":"1700000000000"}},{"name":"endTime","in":"query","required":false,"description":"Pass if you wnat to get trips after this start timestamp.","schema":{"type":"number","description":"Pass if you wnat to get trips after this start timestamp.","example":"1700000000000"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].tripId":{"type":"string","description":"id of the trip","example":"5ef5a9e98a92df3a4a894db0","x-mappls-field-path":"data[].tripId"},"data[].deviceId":{"type":"number","description":"id of the device which is associated with the trip.","example":"1","x-mappls-field-path":"data[].deviceId"},"data[].status":{"type":"integer","description":"1 - active trip. 2 - completed trip","example":1,"x-mappls-field-path":"data[].status"},"data[].closureType":{"type":"integer","description":"type of trip closure. 1 - trip will get closed based on the planned end time. 2 - trip will close when the device enters the destination area/geofence. 3 - trip will get closed manually by the user","example":1,"x-mappls-field-path":"data[].closureType"},"data[].forceClose":{"type":"boolean","description":"boolean value - if true then trip will get automatically closed as soon as the device gets associated with another trip.","example":"true","x-mappls-field-path":"data[].forceClose"},"data[].name":{"type":"string","description":"name of the trip","example":"my trip","x-mappls-field-path":"data[].name"},"data[].polylinePoints":{"type":"object","description":"This is the route polyline. It Will get returned for single trip only if polyline query param is set to true in the API.","example":"example","x-mappls-field-path":"data[].polylinePoints"},"data[].polylinePoints.coordinates":{"type":"array","items":{"type":"object"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].polylinePoints.coordinates"},"data[].polylinePoints.coordinates[].lng":{"type":"number","description":"longitude point","example":"77.229463","x-mappls-field-path":"data[].polylinePoints.coordinates[].lng"},"data[].polylinePoints.coordinates[].lat":{"type":"number","description":"latititude point","example":"28.612964","x-mappls-field-path":"data[].polylinePoints.coordinates[].lat"},"data[].location":{"type":"object","description":"location data of the device. This will get returned only for a single trip when the 'deviceLocation' query param is set to true in the API.","example":"28.612964,77.229463","x-mappls-field-path":"data[].location"},"data[].location.gpsTime":{"type":"number","description":"gps time of the device","example":"1700000000000","x-mappls-field-path":"data[].location.gpsTime"},"data[].location.gprsTime":{"type":"number","description":"gps time of the device","example":"1700000000000","x-mappls-field-path":"data[].location.gprsTime"},"data[].location.latitude":{"type":"number","description":"latitude","example":"28.612964","x-mappls-field-path":"data[].location.latitude"},"data[].location.longitude":{"type":"number","description":"longitude","example":"77.229463","x-mappls-field-path":"data[].location.longitude"},"data[].location.address":{"type":"string","description":"last location address of the device","example":"example","x-mappls-field-path":"data[].location.address"},"data[].location.status":{"type":"number","description":"movement status of the device 1 is Moving 2 is idle 3 is stopped 4 is towing 5 is No Data 6 is power off i,e the device's battery is disconnected from the vehicle battery 7 is No GPS 12 is Activation Pending i,e the device is not yet active and is yet to send the first ping.","example":3,"x-mappls-field-path":"data[].location.status"},"data[].positionEvents":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data[].positionEvents"},"data[].positionEvents[].timestamp":{"type":"number","example":"1700000000000","x-mappls-field-path":"data[].positionEvents[].timestamp"},"data[].positionEvents[].longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data[].positionEvents[].longitude"},"data[].positionEvents[].latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data[].positionEvents[].latitude"},"data[].destination":{"type":"object","description":"This object will only get returned if the user has given a specific desntination as input while creating a trip","example":"example","x-mappls-field-path":"data[].destination"},"data[].destination.geometry":{"type":"object","description":"This is standard geo json format.","example":"28.612964,77.229463","x-mappls-field-path":"data[].destination.geometry"},"data[].destination.geometry.type":{"type":"string","description":"supports the following geometry types - Point, Polygon.","example":"Point","x-mappls-field-path":"data[].destination.geometry.type"},"data[].destination.geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].destination.geometry.coordinates"},"data[].destination.radius":{"type":"number","description":"radius of the point","example":100,"x-mappls-field-path":"data[].destination.radius"},"data[].destination.plannedTime":{"type":"number","description":"planned timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].destination.plannedTime"},"data[].destination.name":{"type":"string","description":"name of the geofence point","example":"example","x-mappls-field-path":"data[].destination.name"},"data[].destination.arrivalTime":{"type":"number","description":"actual timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].destination.arrivalTime"},"data[].destination.departureTime":{"type":"number","description":"departure timestamp at which device leaves the destination","example":"1700000000000","x-mappls-field-path":"data[].destination.departureTime"},"data[].destination.address":{"type":"string","description":"address of the desntination point","example":"example","x-mappls-field-path":"data[].destination.address"},"data[].destination.time":{"type":"number","description":"planned timestamp taken to reach the destination from previous point","example":"1700000000000","x-mappls-field-path":"data[].destination.time"},"data[].destination.distance":{"type":"number","description":"planned distance taken to reach the destination from previous point","example":"1","x-mappls-field-path":"data[].destination.distance"},"data[].destination.pointName":{"type":"string","description":"name given to the destination point.","example":"example","x-mappls-field-path":"data[].destination.pointName"},"data[].destination.metadata":{"type":"object","description":"will get returned only if it was mentioned while creating a trip.","example":"example","x-mappls-field-path":"data[].destination.metadata"},"data[].destination.metadata.myattribute":{"type":"string","description":"dummy meta data value. this can be any key-value data pair.","example":"sample text","x-mappls-field-path":"data[].destination.metadata.myattribute"},"data[].geofences":{"type":"array","items":{"type":"object"},"description":"various points of the trip. This will only get returned in case the these geofence points were explicitly mentioned while creating a trip","example":"example","x-mappls-field-path":"data[].geofences"},"data[].geofences[].geometry":{"type":"object","description":"This is standard geo json format.","example":"28.612964,77.229463","x-mappls-field-path":"data[].geofences[].geometry"},"data[].geofences[].geometry.type":{"type":"string","description":"supports the following geometry types - Point, Polygon.","example":"Point","x-mappls-field-path":"data[].geofences[].geometry.type"},"data[].geofences[].geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].geofences[].geometry.coordinates"},"data[].geofences[].radius":{"type":"number","description":"radius of the point","example":100,"x-mappls-field-path":"data[].geofences[].radius"},"data[].geofences[].plannedTime":{"type":"number","description":"planned timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].geofences[].plannedTime"},"data[].geofences[].name":{"type":"string","description":"name of the geofence point","example":"example","x-mappls-field-path":"data[].geofences[].name"},"data[].geofences[].arrivalTime":{"type":"number","description":"actual timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].geofences[].arrivalTime"},"data[].geofences[].departureTime":{"type":"number","description":"departure timestamp at which device leaves the destination","example":"1700000000000","x-mappls-field-path":"data[].geofences[].departureTime"},"data[].geofences[].address":{"type":"string","description":"address of the desntination point","example":"example","x-mappls-field-path":"data[].geofences[].address"},"data[].geofences[].time":{"type":"number","description":"planned timestamp taken to reach the destination from previous point","example":"1700000000000","x-mappls-field-path":"data[].geofences[].time"},"data[].geofences[].distance":{"type":"number","description":"planned distance taken to reach the destination from previous point","example":"1","x-mappls-field-path":"data[].geofences[].distance"},"data[].geofences[].pointName":{"type":"string","description":"name given to the destination point.","example":"example","x-mappls-field-path":"data[].geofences[].pointName"},"data[].geofences[].metadata":{"type":"object","description":"will get returned only if it was mentioned while creating a trip.","example":"example","x-mappls-field-path":"data[].geofences[].metadata"},"data[].geofences[].metadata.myattribute":{"type":"string","description":"dummy meta data value. this can be any key-value data pair.","example":"sample text","x-mappls-field-path":"data[].geofences[].metadata.myattribute"},"data[].start":{"type":"object","description":"start point of the trip. This will only get returned in case the start point was explicitly mentioned while creating a trip","example":"example","x-mappls-field-path":"data[].start"},"data[].start.geometry":{"type":"object","description":"This is standard geo json format.","example":"28.612964,77.229463","x-mappls-field-path":"data[].start.geometry"},"data[].start.geometry.type":{"type":"string","description":"supports the following geometry types - Point, Polygon.","example":"Point","x-mappls-field-path":"data[].start.geometry.type"},"data[].start.geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].start.geometry.coordinates"},"data[].start.radius":{"type":"number","description":"radius of the point","example":100,"x-mappls-field-path":"data[].start.radius"},"data[].start.plannedTime":{"type":"number","description":"planned timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].start.plannedTime"},"data[].start.name":{"type":"string","description":"name of the geofence point","example":"example","x-mappls-field-path":"data[].start.name"},"data[].start.arrivalTime":{"type":"number","description":"actual timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].start.arrivalTime"},"data[].start.departureTime":{"type":"number","description":"departure timestamp at which device leaves the destination","example":"1700000000000","x-mappls-field-path":"data[].start.departureTime"},"data[].start.address":{"type":"string","description":"address of the desntination point","example":"example","x-mappls-field-path":"data[].start.address"},"data[].start.time":{"type":"number","description":"planned timestamp taken to reach the destination from previous point","example":"1700000000000","x-mappls-field-path":"data[].start.time"},"data[].start.distance":{"type":"number","description":"planned distance taken to reach the destination from previous point","example":"1","x-mappls-field-path":"data[].start.distance"},"data[].start.pointName":{"type":"string","description":"name given to the destination point.","example":"example","x-mappls-field-path":"data[].start.pointName"},"data[].start.metadata":{"type":"object","description":"will get returned only if it was mentioned while creating a trip.","example":"example","x-mappls-field-path":"data[].start.metadata"},"data[].start.metadata.myattribute":{"type":"string","description":"dummy meta data value. this can be any key-value data pair.","example":"sample text","x-mappls-field-path":"data[].start.metadata.myattribute"},"data[].summary":{"type":"object","example":"example","x-mappls-field-path":"data[].summary"},"data[].summary.startedOn":{"type":"number","description":"the actual start timestamp of the trip.","example":"1","x-mappls-field-path":"data[].summary.startedOn"},"data[].summary.duration":{"type":"number","description":"the actual duration time (in seconds) of the trip.","example":"1","x-mappls-field-path":"data[].summary.duration"},"data[].summary.distance":{"type":"number","description":"the actual distance (in meters) covered in the trip.","example":7876.33,"x-mappls-field-path":"data[].summary.distance"},"data[].summary.endedOn":{"type":"number","description":"the actual end timestamp of the trip.","example":1593157994,"x-mappls-field-path":"data[].summary.endedOn"},"data[].summary.delayedBy":{"type":"number","description":"the actual timestamp by which the trip got delayed.","example":"1","x-mappls-field-path":"data[].summary.delayedBy"},"data[].summary.plannedEndTime":{"type":"number","description":"the planned end timestamp of the trip.","example":"1700000000000","x-mappls-field-path":"data[].summary.plannedEndTime"},"data[].summary.plannedStartTime":{"type":"number","description":"the planned start timestamp of the trip.","example":"1700000000000","x-mappls-field-path":"data[].summary.plannedStartTime"},"data[].summary.plannedDuration":{"type":"number","description":"the planned duration time (in seconds) of the trip.","example":"1","x-mappls-field-path":"data[].summary.plannedDuration"},"data[].summary.plannedDistance":{"type":"number","description":"the planned distance (in meters) of the trip.","example":"1","x-mappls-field-path":"data[].summary.plannedDistance"}}},"example":{"data":[{"tripId":"5ef5a9e98a92df3a4a894db0","deviceId":"1","status":1,"closureType":1,"forceClose":"true","name":"my trip","polylinePoints":{"coordinates":[]},"location":{"gpsTime":1593261959,"gprsTime":1593261959,"latitude":29.507586,"longitude":79.507586,"address":"example","status":3}}]}}}},"203":{"description":"Device Not Found"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/trip.json","x-mappls-source-fingerprint":"f475d06cfb9d7bafd8521d713749489be1b26d16de205007fd0b42eef06c254f","x-mappls-evidence-score":90,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-trips-b4e3c3a7f6","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"post":{"operationId":"intouch-post-trips-this-api-will-create-a-trip","summary":"This API will create a trip.","description":"Based on the input parameters provided, a new trip will get created.","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-trips-this-api-will-create-a-trip"},"requestBody":{"required":false,"content":{"application/raw":{"schema":{"type":"object","additionalProperties":true,"properties":{"deviceId":{"type":"number","description":"id of the device for which the trip is getting created.","example":"1","x-mappls-field-path":"deviceId"},"name":{"type":"string","description":"name of the trip","example":"example","x-mappls-field-path":"name"},"forceClose":{"type":"boolean","description":"boolean value - if true then trip will get automatically closed as soon as the device gets associated with another trip.","example":true,"x-mappls-field-path":"forceClose"},"closureType":{"type":"integer","description":"type of trip closure. 1 - trip will get closed based on the planned end time. 2 - trip will close when the device enters the destination area/geofence. 3 - trip will get closed manually by the user","example":1,"x-mappls-field-path":"closureType"},"plannedEndTime":{"type":"number","description":"tentative time when trip will end. Mandatory field when user selects closure type as 1","example":"1700000000000","x-mappls-field-path":"plannedEndTime"},"metadata":{"type":"object","example":"example","x-mappls-field-path":"metadata"},"metadata.myattribute":{"type":"string","description":"dummy meta data value. this can be any key-value data pair.","example":"sample text","x-mappls-field-path":"metadata.myattribute"},"destination":{"type":"object","description":"Destination of the trip. This is not a mandatory. If the user does not provide this object still the trip will get created.","example":"example","x-mappls-field-path":"destination"},"destination.geometry":{"type":"object","description":"This is standard geo json format.","example":"28.612964,77.229463","x-mappls-field-path":"destination.geometry"},"destination.geometry.type":{"type":"string","description":"supports the following geometry types - Point, Polygon.","example":"Point","x-mappls-field-path":"destination.geometry.type"},"destination.geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"destination.geometry.coordinates"},"destination.radius":{"type":"number","description":"radius of the point","example":100,"x-mappls-field-path":"destination.radius"},"destination.name":{"type":"string","description":"name of the geofence/point","example":"example","x-mappls-field-path":"destination.name"},"destination.plannedTime":{"type":"number","description":"planned time at which device reach the destination","example":"1700000000000","x-mappls-field-path":"destination.plannedTime"},"destination.metadata":{"type":"object","example":"example","x-mappls-field-path":"destination.metadata"},"destination.metadata.myattribute":{"type":"string","description":"dummy meta data value. this can be any key-value data pair.","example":"sample text","x-mappls-field-path":"destination.metadata.myattribute"},"geofences":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"geofences"},"geofences[].geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"geofences[].geometry"},"geofences[].geometry.type":{"type":"string","description":"supports the following geometry types - Point, Polygon.","example":"Point","x-mappls-field-path":"geofences[].geometry.type"},"geofences[].geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"geofences[].geometry.coordinates"},"geofences[].radius":{"type":"number","description":"radius of the point","example":100,"x-mappls-field-path":"geofences[].radius"},"geofences[].name":{"type":"string","description":"name of the geofence/point","example":"example","x-mappls-field-path":"geofences[].name"},"geofences[].plannedTime":{"type":"number","description":"planned timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"geofences[].plannedTime"},"geofences[].metadata":{"type":"object","example":"example","x-mappls-field-path":"geofences[].metadata"},"geofences[].metadata.myattribute":{"type":"string","description":"dummy meta data value. this can be any key-value data pair.","example":"sample text","x-mappls-field-path":"geofences[].metadata.myattribute"}}},"example":{"deviceId":"1","name":"example","forceClose":true,"closureType":1,"plannedEndTime":1591891234,"metadata":{"myattribute":"sample text"},"destination":{"geometry":{"type":"Point","coordinates":[77.234,28.456]},"radius":100,"name":"example","plannedTime":"1","metadata":{"myattribute":"sample text"}},"geofences":[{"geometry":{"type":"Point","coordinates":[77.234,28.456]},"radius":100,"name":"example","plannedTime":"1700000000000","metadata":{"myattribute":"sample text"}}]}}}},"responses":{"201":{"description":"Created"},"203":{"description":"Device Not Found or invalid device id"},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/trip.json","x-mappls-source-fingerprint":"f475d06cfb9d7bafd8521d713749489be1b26d16de205007fd0b42eef06c254f","x-mappls-evidence-score":33,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-trips-ceee553f9c","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/trips/{id}":{"get":{"operationId":"intouch-get-trips-id-gets-the-details-of-a-single-trip","summary":"Gets the details of a single trip","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-get-trips-id-gets-the-details-of-a-single-trip"},"parameters":[{"name":"id","in":"path","required":true,"description":"This is the ID of the trip which you want to fetch.","schema":{"type":"number","description":"This is the ID of the trip which you want to fetch.","example":"1"}},{"name":"polyline","in":"query","required":false,"description":"Will return the entire polyline locations of the route which was created for the trip.","schema":{"type":"boolean","description":"Will return the entire polyline locations of the route which was created for the trip.","example":"true"}},{"name":"deviceLocation","in":"query","required":false,"description":"Will return the last know device location details","schema":{"type":"boolean","description":"Will return the last know device location details","example":"MMI000"}},{"name":"event","in":"query","required":false,"description":"Will return all the position events of the device.","schema":{"type":"boolean","description":"Will return all the position events of the device.","example":"true"}}],"responses":{"200":{"description":"OK - successful operation","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].tripId":{"type":"string","description":"id of the trip","example":"5ef5a9e98a92df3a4a894db0","x-mappls-field-path":"data[].tripId"},"data[].deviceId":{"type":"number","description":"id of the device which is associated with the trip.","example":"1","x-mappls-field-path":"data[].deviceId"},"data[].status":{"type":"integer","description":"1 - active trip. 2 - completed trip","example":1,"x-mappls-field-path":"data[].status"},"data[].closureType":{"type":"integer","description":"type of trip closure. 1 - trip will get closed based on the planned end time. 2 - trip will close when the device enters the destination area/geofence. 3 - trip will get closed manually by the user","example":1,"x-mappls-field-path":"data[].closureType"},"data[].forceClose":{"type":"boolean","description":"boolean value - if true then trip will get automatically closed as soon as the device gets associated with another trip.","example":"true","x-mappls-field-path":"data[].forceClose"},"data[].name":{"type":"string","description":"name of the trip","example":"my trip","x-mappls-field-path":"data[].name"},"data[].polylinePoints":{"type":"object","description":"This is the route polyline. It Will get returned for single trip only if polyline query param is set to true in the API.","example":"example","x-mappls-field-path":"data[].polylinePoints"},"data[].polylinePoints.coordinates":{"type":"array","items":{"type":"object"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].polylinePoints.coordinates"},"data[].polylinePoints.coordinates[].lng":{"type":"number","description":"longitude point","example":"77.229463","x-mappls-field-path":"data[].polylinePoints.coordinates[].lng"},"data[].polylinePoints.coordinates[].lat":{"type":"number","description":"latititude point","example":"28.612964","x-mappls-field-path":"data[].polylinePoints.coordinates[].lat"},"data[].location":{"type":"object","description":"location data of the device. This will get returned only for a single trip when the 'deviceLocation' query param is set to true in the API.","example":"28.612964,77.229463","x-mappls-field-path":"data[].location"},"data[].location.gpsTime":{"type":"number","description":"gps time of the device","example":"1700000000000","x-mappls-field-path":"data[].location.gpsTime"},"data[].location.gprsTime":{"type":"number","description":"gps time of the device","example":"1700000000000","x-mappls-field-path":"data[].location.gprsTime"},"data[].location.latitude":{"type":"number","description":"latitude","example":"28.612964","x-mappls-field-path":"data[].location.latitude"},"data[].location.longitude":{"type":"number","description":"longitude","example":"77.229463","x-mappls-field-path":"data[].location.longitude"},"data[].location.address":{"type":"string","description":"last location address of the device","example":"example","x-mappls-field-path":"data[].location.address"},"data[].location.status":{"type":"number","description":"movement status of the device 1 is Moving 2 is idle 3 is stopped 4 is towing 5 is No Data 6 is power off i,e the device's battery is disconnected from the vehicle battery 7 is No GPS 12 is Activation Pending i,e the device is not yet active and is yet to send the first ping.","example":3,"x-mappls-field-path":"data[].location.status"},"data[].positionEvents":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data[].positionEvents"},"data[].positionEvents[].timestamp":{"type":"number","example":"1700000000000","x-mappls-field-path":"data[].positionEvents[].timestamp"},"data[].positionEvents[].longitude":{"type":"number","example":"77.229463","x-mappls-field-path":"data[].positionEvents[].longitude"},"data[].positionEvents[].latitude":{"type":"number","example":"28.612964","x-mappls-field-path":"data[].positionEvents[].latitude"},"data[].destination":{"type":"object","description":"This object will only get returned if the user has given a specific desntination as input while creating a trip","example":"example","x-mappls-field-path":"data[].destination"},"data[].destination.geometry":{"type":"object","description":"This is standard geo json format.","example":"28.612964,77.229463","x-mappls-field-path":"data[].destination.geometry"},"data[].destination.geometry.type":{"type":"string","description":"supports the following geometry types - Point, Polygon.","example":"Point","x-mappls-field-path":"data[].destination.geometry.type"},"data[].destination.geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].destination.geometry.coordinates"},"data[].destination.radius":{"type":"number","description":"radius of the point","example":100,"x-mappls-field-path":"data[].destination.radius"},"data[].destination.plannedTime":{"type":"number","description":"planned timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].destination.plannedTime"},"data[].destination.name":{"type":"string","description":"name of the geofence point","example":"example","x-mappls-field-path":"data[].destination.name"},"data[].destination.arrivalTime":{"type":"number","description":"actual timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].destination.arrivalTime"},"data[].destination.departureTime":{"type":"number","description":"departure timestamp at which device leaves the destination","example":"1700000000000","x-mappls-field-path":"data[].destination.departureTime"},"data[].destination.address":{"type":"string","description":"address of the desntination point","example":"example","x-mappls-field-path":"data[].destination.address"},"data[].destination.time":{"type":"number","description":"planned timestamp taken to reach the destination from previous point","example":"1700000000000","x-mappls-field-path":"data[].destination.time"},"data[].destination.distance":{"type":"number","description":"planned distance taken to reach the destination from previous point","example":"1","x-mappls-field-path":"data[].destination.distance"},"data[].destination.pointName":{"type":"string","description":"name given to the destination point.","example":"example","x-mappls-field-path":"data[].destination.pointName"},"data[].destination.metadata":{"type":"object","description":"will get returned only if it was mentioned while creating a trip.","example":"example","x-mappls-field-path":"data[].destination.metadata"},"data[].destination.metadata.myattribute":{"type":"string","description":"dummy meta data value. this can be any key-value data pair.","example":"sample text","x-mappls-field-path":"data[].destination.metadata.myattribute"},"data[].geofences":{"type":"array","items":{"type":"object"},"description":"various points of the trip. This will only get returned in case the these geofence points were explicitly mentioned while creating a trip","example":"example","x-mappls-field-path":"data[].geofences"},"data[].geofences[].geometry":{"type":"object","description":"This is standard geo json format.","example":"28.612964,77.229463","x-mappls-field-path":"data[].geofences[].geometry"},"data[].geofences[].geometry.type":{"type":"string","description":"supports the following geometry types - Point, Polygon.","example":"Point","x-mappls-field-path":"data[].geofences[].geometry.type"},"data[].geofences[].geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].geofences[].geometry.coordinates"},"data[].geofences[].radius":{"type":"number","description":"radius of the point","example":100,"x-mappls-field-path":"data[].geofences[].radius"},"data[].geofences[].plannedTime":{"type":"number","description":"planned timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].geofences[].plannedTime"},"data[].geofences[].name":{"type":"string","description":"name of the geofence point","example":"example","x-mappls-field-path":"data[].geofences[].name"},"data[].geofences[].arrivalTime":{"type":"number","description":"actual timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].geofences[].arrivalTime"},"data[].geofences[].departureTime":{"type":"number","description":"departure timestamp at which device leaves the destination","example":"1700000000000","x-mappls-field-path":"data[].geofences[].departureTime"},"data[].geofences[].address":{"type":"string","description":"address of the desntination point","example":"example","x-mappls-field-path":"data[].geofences[].address"},"data[].geofences[].time":{"type":"number","description":"planned timestamp taken to reach the destination from previous point","example":"1700000000000","x-mappls-field-path":"data[].geofences[].time"},"data[].geofences[].distance":{"type":"number","description":"planned distance taken to reach the destination from previous point","example":"1","x-mappls-field-path":"data[].geofences[].distance"},"data[].geofences[].pointName":{"type":"string","description":"name given to the destination point.","example":"example","x-mappls-field-path":"data[].geofences[].pointName"},"data[].geofences[].metadata":{"type":"object","description":"will get returned only if it was mentioned while creating a trip.","example":"example","x-mappls-field-path":"data[].geofences[].metadata"},"data[].geofences[].metadata.myattribute":{"type":"string","description":"dummy meta data value. this can be any key-value data pair.","example":"sample text","x-mappls-field-path":"data[].geofences[].metadata.myattribute"},"data[].start":{"type":"object","description":"start point of the trip. This will only get returned in case the start point was explicitly mentioned while creating a trip","example":"example","x-mappls-field-path":"data[].start"},"data[].start.geometry":{"type":"object","description":"This is standard geo json format.","example":"28.612964,77.229463","x-mappls-field-path":"data[].start.geometry"},"data[].start.geometry.type":{"type":"string","description":"supports the following geometry types - Point, Polygon.","example":"Point","x-mappls-field-path":"data[].start.geometry.type"},"data[].start.geometry.coordinates":{"type":"array","items":{"type":"number"},"example":"28.612964,77.229463","x-mappls-field-path":"data[].start.geometry.coordinates"},"data[].start.radius":{"type":"number","description":"radius of the point","example":100,"x-mappls-field-path":"data[].start.radius"},"data[].start.plannedTime":{"type":"number","description":"planned timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].start.plannedTime"},"data[].start.name":{"type":"string","description":"name of the geofence point","example":"example","x-mappls-field-path":"data[].start.name"},"data[].start.arrivalTime":{"type":"number","description":"actual timestamp at which device reach the destination","example":"1700000000000","x-mappls-field-path":"data[].start.arrivalTime"},"data[].start.departureTime":{"type":"number","description":"departure timestamp at which device leaves the destination","example":"1700000000000","x-mappls-field-path":"data[].start.departureTime"},"data[].start.address":{"type":"string","description":"address of the desntination point","example":"example","x-mappls-field-path":"data[].start.address"},"data[].start.time":{"type":"number","description":"planned timestamp taken to reach the destination from previous point","example":"1700000000000","x-mappls-field-path":"data[].start.time"},"data[].start.distance":{"type":"number","description":"planned distance taken to reach the destination from previous point","example":"1","x-mappls-field-path":"data[].start.distance"},"data[].start.pointName":{"type":"string","description":"name given to the destination point.","example":"example","x-mappls-field-path":"data[].start.pointName"},"data[].start.metadata":{"type":"object","description":"will get returned only if it was mentioned while creating a trip.","example":"example","x-mappls-field-path":"data[].start.metadata"},"data[].start.metadata.myattribute":{"type":"string","description":"dummy meta data value. this can be any key-value data pair.","example":"sample text","x-mappls-field-path":"data[].start.metadata.myattribute"},"data[].summary":{"type":"object","example":"example","x-mappls-field-path":"data[].summary"},"data[].summary.startedOn":{"type":"number","description":"the actual start timestamp of the trip.","example":"1","x-mappls-field-path":"data[].summary.startedOn"},"data[].summary.duration":{"type":"number","description":"the actual duration time (in seconds) of the trip.","example":"1","x-mappls-field-path":"data[].summary.duration"},"data[].summary.distance":{"type":"number","description":"the actual distance (in meters) covered in the trip.","example":7876.33,"x-mappls-field-path":"data[].summary.distance"},"data[].summary.endedOn":{"type":"number","description":"the actual end timestamp of the trip.","example":1593157994,"x-mappls-field-path":"data[].summary.endedOn"},"data[].summary.delayedBy":{"type":"number","description":"the actual timestamp by which the trip got delayed.","example":"1","x-mappls-field-path":"data[].summary.delayedBy"},"data[].summary.plannedEndTime":{"type":"number","description":"the planned end timestamp of the trip.","example":"1700000000000","x-mappls-field-path":"data[].summary.plannedEndTime"},"data[].summary.plannedStartTime":{"type":"number","description":"the planned start timestamp of the trip.","example":"1700000000000","x-mappls-field-path":"data[].summary.plannedStartTime"},"data[].summary.plannedDuration":{"type":"number","description":"the planned duration time (in seconds) of the trip.","example":"1","x-mappls-field-path":"data[].summary.plannedDuration"},"data[].summary.plannedDistance":{"type":"number","description":"the planned distance (in meters) of the trip.","example":"1","x-mappls-field-path":"data[].summary.plannedDistance"}}},"example":{"data":[{"tripId":"5ef5a9e98a92df3a4a894db0","deviceId":"1","status":1,"closureType":1,"forceClose":"true","name":"my trip","polylinePoints":{"coordinates":[]},"location":{"gpsTime":1593261959,"gprsTime":1593261959,"latitude":29.507586,"longitude":79.507586,"address":"example","status":3}}]}}}},"203":{"description":"Invalid ID - Invalid trip id or trip id does not exist."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/trip.json","x-mappls-source-fingerprint":"f475d06cfb9d7bafd8521d713749489be1b26d16de205007fd0b42eef06c254f","x-mappls-evidence-score":89,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-get-trips-id-0f2511ebf2","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/trips/{id}/close":{"post":{"operationId":"intouch-post-trips-id-close-post-api-to-close-a-trip","summary":"POST API to close a trip.","description":"A set of powerful telematics APIs which users can use to get all the data related to their devices such as live location,trails,alarms etc. These telematics APIs are powered by MapmyIndia's own INTOUCH platform. MapmyIndia InTouch easily integrates into existing cloud services via our tracking & telematics APIs. The API & SDK libraries provide powerful, efficient and accurate positioning for the IoT devices on InTouch applications for Android, iOS and the web. You can find out more about Intouch at http://mapmyindia.com/intouch","tags":["InTouch Telematics"],"deprecated":false,"servers":[{"url":"https://intouch.mapmyindia.com/iot/api"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/intouch-post-trips-id-close-post-api-to-close-a-trip"},"parameters":[{"name":"id","in":"path","required":true,"description":"This the ID of the trip which you want to close.","schema":{"type":"number","description":"This the ID of the trip which you want to close.","example":"1"}}],"responses":{"200":{"description":"OK - successful operation"},"203":{"description":"invalid param. For eg; if trip id is not correct."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":"example","x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"example","x-mappls-field-path":"message"},"error":{"type":"string","description":"describes the type of error","example":"example","x-mappls-field-path":"error"}}},"example":{"status":"example","message":"example","error":"example"}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"404":{"description":"URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-intouch-rest-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/trip.json","x-mappls-source-fingerprint":"f475d06cfb9d7bafd8521d713749489be1b26d16de205007fd0b42eef06c254f","x-mappls-evidence-score":9,"x-mappls-source-generation":"v2-0-0","x-mappls-generation-group":"intouch-post-trips-id-close-d2f2e0a19e","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/blurbox":{"post":{"operationId":"mappls-ai-ml-post-blurbox-returns-the-image-in-which-objects-of-geometry-are-blurred-as-given-by-the-client","summary":"Returns the image in which objects of geometry are blurred as given by the client.","description":"BlurBox API takes in the bounding box ( the region, area the client want to blur in the image) and then the BlurBox will automatically return the blur region within an image.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-blurbox-returns-the-image-in-which-objects-of-geometry-are-blurred-as-given-by-the-client"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"},"box":{"type":"string","description":"Takes bounding boxes of the region you want to blur.","example":"example","x-mappls-field-path":"box"}},"required":["file","box"]},"example":{"file":"example","box":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"Image"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/AI_ML_API.yaml","x-mappls-source-fingerprint":"c89f36fb053ab44fc9caeebf96326da5b69c7b5ee1a7f5a85fd14d095565687e","x-mappls-evidence-score":9,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-blurbox-a4f70028da","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/brand_detection":{"post":{"operationId":"mappls-ai-ml-post-brand-detection-returns-the-brands-bounding-box-array-for-the-inputs-images","summary":"Returns the Brands bounding box array for the inputs Images","description":"API will predict the bounding box co-ordinates(x1, y1, x2, y2) i.e (left most coordinate, right most coordinate) of the Brands in the given image.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-brand-detection-returns-the-brands-bounding-box-array-for-the-inputs-images"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"Prediction":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"Prediction"},"Prediction[].x1":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].x1"},"Prediction[].y1":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].y1"},"Prediction[].x2":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].x2"},"Prediction[].y2":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].y2"}}},"example":{"Prediction":[{"x1":1,"y1":1,"x2":1,"y2":1}]}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/brand_detection.yaml","x-mappls-source-fingerprint":"20759d3fde92064b580e491c0d5b8334e2d334d011e021ce6abb1bc2f0831d14","x-mappls-evidence-score":13,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-brand-detection-3eec8136c3","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/faceblur":{"post":{"operationId":"mappls-ai-ml-post-faceblur-returns-the-array-of-features-which-contains-objects-of-geometry-of-the-uploaded-image","summary":"Returns the array of features which contains objects of geometry of the uploaded image.","description":"Face Blur API can automatically detect all faces within an image and blurs them. No need for manual face selection.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-faceblur-returns-the-array-of-features-which-contains-objects-of-geometry-of-the-uploaded-image"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"Image"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/AI_ML_API.yaml","x-mappls-source-fingerprint":"c89f36fb053ab44fc9caeebf96326da5b69c7b5ee1a7f5a85fd14d095565687e","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-faceblur-ee7be4abf8","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/facedetection":{"post":{"operationId":"mappls-ai-ml-post-facedetection-returns-different-output-depending-upon-the-inputs-given","summary":"Returns different output depending upon the inputs given.","description":"Using these APIs developers can fully leverage and embed the power of AI / ML Analytics, intelligence. These APIs allow our client to integrate into their own application the power and full set of functionalities of the mGIS product and platform. It’s a fact: people have a right of getting digital privacy. Here’s one more: online publishers and businesses worldwide must respect those rights and provide visual anonymity when it’s needed. That’s why we decided to give you the fastest and easiest way to keep people’s privacy in photos. Meet Face Detection & Blurring by MapmyIndia. This tool completely automates Face Detection, Face Blurring in photos and helps you get the job done in just a few clicks without graphic editors and manual work. Keep reading to find out how it works, when it comes in handy, and how you can actually use it in MapmyIndia.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-facedetection-returns-different-output-depending-upon-the-inputs-given"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":[0,0,1]}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/AI_ML_API.yaml","x-mappls-source-fingerprint":"c89f36fb053ab44fc9caeebf96326da5b69c7b5ee1a7f5a85fd14d095565687e","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-facedetection-1035d8c194","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/faceplot":{"post":{"operationId":"mappls-ai-ml-post-faceplot-returns-the-image-which-contains-objects-of-geometry-of-the-detected-face-plotted-on-it-with-the-bounding-box","summary":"Returns the image which contains objects of geometry of the detected face plotted on it with the bounding box.","description":"This tool completely automates Face Detection, Face Blurring in photos and helps you get the job done in just a few clicks without graphic editors and manual work. Keep reading to find out how it works, when it comes in handy, and how you can actually use it in MapmyIndia. You can detect faces in an image, identify key facial features, and get the contours of detected faces. Note that the API detects faces, it does not recognize people . When you have face contour detection enabled, you also get a list of points for each facial feature that was detected. These points represent the shape of the feature. The following image illustrates how these points map to a face.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-faceplot-returns-the-image-which-contains-objects-of-geometry-of-the-detected-face-plotted-on-it-with-the-bounding-box"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"Image"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/AI_ML_API.yaml","x-mappls-source-fingerprint":"c89f36fb053ab44fc9caeebf96326da5b69c7b5ee1a7f5a85fd14d095565687e","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-faceplot-391975834f","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/face_blur":{"post":{"operationId":"mappls-ai-ml-post-face-blur-returns-the-face-blured-images-of-the-uploaded-2d-image","summary":"Returns the face blured images of the uploaded 2D image","description":"This API completely automates Face Detection, Face Blurring in 2D Images, without any extra effort","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-face-blur-returns-the-face-blured-images-of-the-uploaded-2d-image"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"Image"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/face_2d.yaml","x-mappls-source-fingerprint":"96f033e10b9c516538d193dfe2065202604614655eebb9581e729cb60f24b606","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-face-blur-a0b1c93990","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/face_detection":{"post":{"operationId":"mappls-ai-ml-post-face-detection-returns-the-bounding-box-array-for-the-inputs-image","summary":"Returns the bounding box array for the inputs Image","description":"API will predict the bounding box co-ordinates(x1, y1, x2, y2) i.e (left most coordinate, right most coordinate) of the faces in the given 2D image.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-face-detection-returns-the-bounding-box-array-for-the-inputs-image"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"Prediction":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"Prediction"},"Prediction[].x1":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].x1"},"Prediction[].y1":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].y1"},"Prediction[].x2":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].x2"},"Prediction[].y2":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].y2"}}},"example":{"Prediction":[{"x1":1,"y1":1,"x2":1,"y2":1}]}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/face_2d.yaml","x-mappls-source-fingerprint":"96f033e10b9c516538d193dfe2065202604614655eebb9581e729cb60f24b606","x-mappls-evidence-score":13,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-face-detection-c743b8c6fc","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/face_draw":{"post":{"operationId":"mappls-ai-ml-post-face-draw-returns-the-box-drawn-faces-on-the-uploaded-2d-image","summary":"Returns the box drawn faces on the uploaded 2D image","description":"This API detects faces in 2D images and draw their box around faces.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-face-draw-returns-the-box-drawn-faces-on-the-uploaded-2d-image"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"Image"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/face_2d.yaml","x-mappls-source-fingerprint":"96f033e10b9c516538d193dfe2065202604614655eebb9581e729cb60f24b606","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-face-draw-817130ed74","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/face_blur_pano":{"post":{"operationId":"mappls-ai-ml-post-face-blur-pano-returns-the-face-blured-images-of-the-uploaded-panorama-image","summary":"Returns the face blured images of the uploaded panorama image","description":"This API completely automates Face Detection, Face Blurring in panorama Images, without any extra effort","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-face-blur-pano-returns-the-face-blured-images-of-the-uploaded-panorama-image"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"Image"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/face_Panorama.yaml","x-mappls-source-fingerprint":"c243d8e439ac9a6c8aa08399e5abe8a3871134fd340117fdac004238717d1bcc","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-face-blur-pano-24b8b5b497","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/face_detection_pano":{"post":{"operationId":"mappls-ai-ml-post-face-detection-pano-returns-the-bounding-box-array-for-the-inputs-panorama-images","summary":"Returns the bounding box array for the inputs panorama Images","description":"API will predict the bounding box co-ordinates(x1, y1, x2, y2) i.e (left most coordinate, right most coordinate) of the faces in the given panorama image.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-face-detection-pano-returns-the-bounding-box-array-for-the-inputs-panorama-images"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"Prediction":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"Prediction"},"Prediction[].x1":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].x1"},"Prediction[].y1":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].y1"},"Prediction[].x2":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].x2"},"Prediction[].y2":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].y2"}}},"example":{"Prediction":[{"x1":1,"y1":1,"x2":1,"y2":1}]}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/face_Panorama.yaml","x-mappls-source-fingerprint":"c243d8e439ac9a6c8aa08399e5abe8a3871134fd340117fdac004238717d1bcc","x-mappls-evidence-score":13,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-face-detection-pano-7b1e63a928","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/face_draw_pano":{"post":{"operationId":"mappls-ai-ml-post-face-draw-pano-returns-the-box-drawn-faces-on-the-uploaded-panorama-image","summary":"Returns the box drawn faces on the uploaded panorama image","description":"Without any additional effort, This API detects faces in panorama images and draw their box around faces.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-face-draw-pano-returns-the-box-drawn-faces-on-the-uploaded-panorama-image"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"Image"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/face_Panorama.yaml","x-mappls-source-fingerprint":"c243d8e439ac9a6c8aa08399e5abe8a3871134fd340117fdac004238717d1bcc","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-face-draw-pano-95b127b26a","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/license_plate_blur":{"post":{"operationId":"mappls-ai-ml-post-license-plate-blur-returns-the-license-plate-blured-images-of-the-uploaded-2d-image","summary":"Returns the License Plate blured images of the uploaded 2D image","description":"This API completely automates License Plate Detection, License Plate Blurring in 2D Images, without any extra effort","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-license-plate-blur-returns-the-license-plate-blured-images-of-the-uploaded-2d-image"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"Image"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/license_plate_2d.yaml","x-mappls-source-fingerprint":"e28c4d4728921522e5ebb4fda0951c05693d0b68387d8587402225825b4a1bd9","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-license-plate-blur-edf6a8512b","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/license_plate_detection":{"post":{"operationId":"mappls-ai-ml-post-license-plate-detection-returns-the-bounding-box-array-for-the-inputs-image","summary":"Returns the bounding box array for the inputs Image","description":"API will predict the bounding box co-ordinates(x1, y1, x2, y2) i.e (left most coordinate, right most coordinate) of the License Plate in the given 2D image.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-license-plate-detection-returns-the-bounding-box-array-for-the-inputs-image"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"Prediction":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"Prediction"},"Prediction[].x1":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].x1"},"Prediction[].y1":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].y1"},"Prediction[].x2":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].x2"},"Prediction[].y2":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].y2"}}},"example":{"Prediction":[{"x1":1,"y1":1,"x2":1,"y2":1}]}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/license_plate_2d.yaml","x-mappls-source-fingerprint":"e28c4d4728921522e5ebb4fda0951c05693d0b68387d8587402225825b4a1bd9","x-mappls-evidence-score":13,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-license-plate-detection-cad578f7e9","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/license_plate_draw":{"post":{"operationId":"mappls-ai-ml-post-license-plate-draw-returns-the-box-drawn-license-plate-on-the-uploaded-2d-image","summary":"Returns the box drawn License Plate on the uploaded 2D image","description":"This API detects License Plate in 2D images and draw their box around License Plate.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-license-plate-draw-returns-the-box-drawn-license-plate-on-the-uploaded-2d-image"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"Image"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/license_plate_2d.yaml","x-mappls-source-fingerprint":"e28c4d4728921522e5ebb4fda0951c05693d0b68387d8587402225825b4a1bd9","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-license-plate-draw-d65f5ae99c","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/license_plate_blur_pano":{"post":{"operationId":"mappls-ai-ml-post-license-plate-blur-pano-returns-the-license-plate-blured-images-of-the-uploaded-panorama-image","summary":"Returns the License plate blured images of the uploaded panorama image","description":"This API completely automates License plate Detection, License plate Blurring in panorama Images, without any extra effort","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-license-plate-blur-pano-returns-the-license-plate-blured-images-of-the-uploaded-panorama-image"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"Image"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/license_plate_panorama.yaml","x-mappls-source-fingerprint":"4aef0ef7d89efd5b0f3e2f9ac34488f3e7a033d78e073df38a350b525c857c06","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-license-plate-blur-pano-9a997421a7","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/license_plate_detection_pano":{"post":{"operationId":"mappls-ai-ml-post-license-plate-detection-pano-returns-the-bounding-box-array-of-license-plate-in-panorama-images","summary":"Returns the bounding box array of License plate in panorama Images","description":"API will predict the bounding box co-ordinates(x1, y1, x2, y2) i.e (left most coordinate, right most coordinate) of the License Plate in the given panorama image.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-license-plate-detection-pano-returns-the-bounding-box-array-of-license-plate-in-panorama-images"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"Prediction":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"Prediction"},"Prediction[].x1":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].x1"},"Prediction[].y1":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].y1"},"Prediction[].x2":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].x2"},"Prediction[].y2":{"type":"integer","example":1,"x-mappls-field-path":"Prediction[].y2"}}},"example":{"Prediction":[{"x1":1,"y1":1,"x2":1,"y2":1}]}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/license_plate_panorama.yaml","x-mappls-source-fingerprint":"4aef0ef7d89efd5b0f3e2f9ac34488f3e7a033d78e073df38a350b525c857c06","x-mappls-evidence-score":13,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-license-plate-detection-pano-9b75994989","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/license_plate_draw_pano":{"post":{"operationId":"mappls-ai-ml-post-license-plate-draw-pano-returns-the-box-drawn-license-plate-in-the-uploaded-panorama-image","summary":"Returns the box drawn License plate in the uploaded panorama image","description":"Without any additional effort, This API detects License plate in panorama images and draw their box around License plate.","tags":["Mappls AI / ML"],"deprecated":false,"servers":[{"url":"https://aiml.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mappls-ai-ml-post-license-plate-draw-pano-returns-the-box-drawn-license-plate-in-the-uploaded-panorama-image"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .jpg, .jpeg and .png formats","example":"example","x-mappls-field-path":"file"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"Image"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Client side error, Invalid parameter request","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occurred while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"public-mappls-ai-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mappls-ai-apis/docs/custom/license_plate_panorama.yaml","x-mappls-source-fingerprint":"4aef0ef7d89efd5b0f3e2f9ac34488f3e7a033d78e073df38a350b525c857c06","x-mappls-evidence-score":8,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"mappls-ai-ml-post-license-plate-draw-pano-f8a9362cd4","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/aggregate":{"get":{"operationId":"mgis-get-aggregate-perform-aggregate-operation-on-a-single-dataset","summary":"Perform aggregate operation on a single dataset","description":"Perform aggregate operation on a single dataset","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-aggregate-perform-aggregate-operation-on-a-single-dataset"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"columnname","in":"query","required":true,"description":"column name on which the aggregate operation has to be performed","schema":{"type":"string","description":"column name on which the aggregate operation has to be performed","example":"anzee"}},{"name":"operation","in":"query","required":true,"description":"aggregate operators which are acceptable are Count, Average, Max, Median, Min, StdDev and Sum","schema":{"type":"string","description":"aggregate operators which are acceptable are Count, Average, Max, Median, Min, StdDev and Sum","example":"Median"}},{"name":"singlePass","in":"query","required":false,"description":"If TRUE computes all aggregation values in a single pass. Its default value is set true","schema":{"type":"boolean","description":"If TRUE computes all aggregation values in a single pass. Its default value is set true","example":true}},{"name":"dataStoreName","in":"query","required":false,"description":"Name of datastore where adaptor published.","schema":{"type":"string","description":"Name of datastore where adaptor published.","example":"adaptor"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response Code","example":"200","x-mappls-field-path":"code"},"result":{"type":"object","example":"example","x-mappls-field-path":"result"},"result.GroupByAttributes":{"type":"array","items":{"type":"string"},"example":"example","x-mappls-field-path":"result.GroupByAttributes"},"result.AggregationResults":{"type":"array","items":{"type":"array","items":{"type":"number"}},"example":"example","x-mappls-field-path":"result.AggregationResults"},"result.AggregationFunctions":{"type":"array","items":{"type":"string"},"example":"example","x-mappls-field-path":"result.AggregationFunctions"},"result.AggregationAttribute":{"type":"string","description":"Attribute on which aggregate function performed","example":"latitude","x-mappls-field-path":"result.AggregationAttribute"}}},"example":{"code":"200","result":{"GroupByAttributes":["example"],"AggregationResults":[["21.168174"]],"AggregationFunctions":["Median"],"AggregationAttribute":"latitude"}}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Error exception code.","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"error"}}},"example":{"error":"No data found in Database."}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"error"}}},"example":{"error":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/dqv-apis.yml","x-mappls-source-fingerprint":"ec78e94e77644b4d9ff44c58916c40813cc7f96798318569b33204ebd94fba04","x-mappls-evidence-score":26,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-get-aggregate-52ee7ba2d3","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/catchement_query/join":{"get":{"operationId":"mgis-get-catchement-query-join-fetches-the-results-of-the-query-applied-between-two-dataset-as-well-as-between-one-datset-and-user-defimed-geometry","summary":"Fetches the results of the query applied between two dataset as well as between one datset and user defimed geometry.","description":"User can performed both the following tasks: Non Spatial Query Spatial Query For spatial query user can perform the query between 2 datasets as well as between one dataset and user defined geometry in geojson format. Whereas Non-Spatial Query is only applicable between 2 datasets.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-catchement-query-join-fetches-the-results-of-the-query-applied-between-two-dataset-as-well-as-between-one-datset-and-user-defimed-geometry"},"parameters":[{"name":"queryType","in":"query","required":true,"description":"queryType value can be basic, spatial .","schema":{"type":"string","description":"queryType value can be basic, spatial .","example":"functionBased"}},{"name":"datasetSource","in":"query","required":true,"description":"Source dataset name. Mandatory both in case of Spatial as well as Non-Spatial Query.","schema":{"type":"string","description":"Source dataset name. Mandatory both in case of Spatial as well as Non-Spatial Query.","example":"geocode_ii"}},{"name":"datasetRef","in":"query","required":false,"description":"Source dataset name. Mandatory both in case of Non-Spatial Query.","schema":{"type":"string","description":"Source dataset name. Mandatory both in case of Non-Spatial Query.","example":"geocode_iii"}},{"name":"operator","in":"query","required":true,"description":"Mandatory both in case of Spatial as well as Non-Spatial Query. Operators allowed for queryType = 'basic' are: =, =, , <>, IN and NOT IN Operators allowed for queryType = 'spatial' are: Intersects, Disjoint, Overlaps, Equals, Touches, DWithin, Within, Contains and Crosses","schema":{"type":"string","description":"Mandatory both in case of Spatial as well as Non-Spatial Query. Operators allowed for queryType = 'basic' are: =, =, , <>, IN and NOT IN Operators allowed for queryType = 'spatial' are: Intersects, Disjoint, Overlaps, Equals, Touches, DWithin, Within, Contains and Crosses","example":"Intersects"}},{"name":"sourceProperty","in":"query","required":true,"description":"Source property attributes to be queried. Mandatory both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Source property attributes to be queried. Mandatory both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"id"}},{"name":"refProperty","in":"query","required":false,"description":"Reference property attributes to be queried. Mandatory in case of Non-Spatial Query.","schema":{"type":"string","description":"Reference property attributes to be queried. Mandatory in case of Non-Spatial Query.","example":"id"}},{"name":"selectionParamSource","in":"query","required":false,"description":"Source property attributes to be reflected in the result. Optional in case of arithmetic operations, Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Source property attributes to be reflected in the result. Optional in case of arithmetic operations, Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"id, lat"}},{"name":"selectionParamRef","in":"query","required":false,"description":"Reference property attributes to be reflected in the result. Optional both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Reference property attributes to be reflected in the result. Optional both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"osm_id, name"}},{"name":"userGeom","in":"query","required":false,"description":"Value of UserGeom will be 'true' if user wants to perform spatial filters with user-defined geometry.","schema":{"type":"string","description":"Value of UserGeom will be 'true' if user wants to perform spatial filters with user-defined geometry.","example":true}},{"name":"distance","in":"query","required":false,"description":"Mandatory in case of operator DWithin, else it is not required.","schema":{"type":"number","description":"Mandatory in case of operator DWithin, else it is not required.","example":10}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"geometry"},"geometry.coordinates":{"description":"updated geomtery coordinates. Case-1 multipoint {\"geometry\":{\"coordinates\":[500000,54505678]}} Case-2 multipolygon {\"geometry\":{\"coordinates\":[[[76.55555,24.046464],[76.552734,28.844674],[83.056641,28.844674],[83.056641,24.046464],[76.55555,24.046464]]]}} Case-3 multiline {\"geometry\":{\"coordinates\":[[500000,54505678],[0,540000],[5450000,0]]}}","example":"28.612964,77.229463","x-mappls-field-path":"geometry.coordinates"}}},"example":{"geometry":{"coordinates":"example"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"result":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"result"},"result[].prop1":{"type":"string","description":"Prop1 value","example":"example","x-mappls-field-path":"result[].prop1"},"result[].prop2":{"type":"string","description":"Prop2 value","example":"example","x-mappls-field-path":"result[].prop2"},"result[].prop3":{"type":"string","description":"Prop3 value","example":"example","x-mappls-field-path":"result[].prop3"},"result[].prop4":{"type":"string","description":"Prop4 value","example":"example","x-mappls-field-path":"result[].prop4"},"result[].prop5":{"type":"string","description":"Prop5 value","example":"example","x-mappls-field-path":"result[].prop5"},"result[].prop6":{"type":"string","description":"Prop6 value","example":"example","x-mappls-field-path":"result[].prop6"},"result[].prop7":{"type":"string","description":"Prop7 value","example":"example","x-mappls-field-path":"result[].prop7"},"result[].prop8":{"type":"string","description":"Prop8 value","example":"example","x-mappls-field-path":"result[].prop8"}}},"example":{"code":"200","result":[{"prop1":"example","prop2":"example","prop3":"example","prop4":"example","prop5":"example","prop6":"example","prop7":"example","prop8":"example"}]}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Error exception code.","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"error due to authorization","example":"authorization unsuccesful","x-mappls-field-path":"error"}}},"example":{"error":"authorization unsuccesful"}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"error"}}},"example":{"error":"No data found in Database."}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"method not allowerd, wrong method or invalid parameters","example":"Method not allowed","x-mappls-field-path":"error"}}},"example":{"error":"Method not allowed"}}}},"409":{"description":"Conflict in parameters passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"wrong parameters","example":"wrong parameters","x-mappls-field-path":"error"}}},"example":{"error":"wrong parameters"}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"error"}}},"example":{"error":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/dqv-apis.yml","x-mappls-source-fingerprint":"ec78e94e77644b4d9ff44c58916c40813cc7f96798318569b33204ebd94fba04","x-mappls-evidence-score":43,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-get-catchement-query-join-9c9b8afa0b","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/dqv/aggregate":{"get":{"operationId":"mgis-get-dqv-aggregate-perform-aggregate-operation-on-a-single-dataset","summary":"Perform aggregate operation on a single dataset","description":"Perform aggregate operation on a single dataset","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-dqv-aggregate-perform-aggregate-operation-on-a-single-dataset"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"columnname","in":"query","required":true,"description":"column name on which the aggregate operation has to be performed","schema":{"type":"string","description":"column name on which the aggregate operation has to be performed","example":"anzee"}},{"name":"operation","in":"query","required":true,"description":"aggregate operators which are acceptable are Count, Average, Max, Median, Min, StdDev and Sum","schema":{"type":"string","description":"aggregate operators which are acceptable are Count, Average, Max, Median, Min, StdDev and Sum","example":"Median"}},{"name":"singlePass","in":"query","required":false,"description":"If TRUE computes all aggregation values in a single pass. Its default value is set true","schema":{"type":"boolean","description":"If TRUE computes all aggregation values in a single pass. Its default value is set true","example":true}},{"name":"dataStoreName","in":"query","required":false,"description":"Name of datastore where adaptor published.","schema":{"type":"string","description":"Name of datastore where adaptor published.","example":"adaptor"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response Code","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","x-mappls-field-path":"message"},"data":{"type":"object","example":"example","x-mappls-field-path":"data"},"data.GroupByAttributes":{"type":"array","items":{"type":"string"},"example":"example","x-mappls-field-path":"data.GroupByAttributes"},"data.AggregationResults":{"type":"array","items":{"type":"array","items":{"type":"number"}},"example":"example","x-mappls-field-path":"data.AggregationResults"},"data.AggregationFunctions":{"type":"array","items":{"type":"string"},"example":"example","x-mappls-field-path":"data.AggregationFunctions"},"data.AggregationAttribute":{"type":"string","description":"Attribute on which aggregate function performed","example":"latitude","x-mappls-field-path":"data.AggregationAttribute"}}},"example":{"code":"200","success":true,"message":"","data":{"GroupByAttributes":["example"],"AggregationResults":[["21.168174"]],"AggregationFunctions":["Median"],"AggregationAttribute":"latitude"}}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"message":"Layer not found.","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":404,"x-mappls-field-path":"code"},"message":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"message"}}},"example":{"code":404,"message":"No data found in Database."}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"message"}}},"example":{"message":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/dqv-apis.yml","x-mappls-source-fingerprint":"391a57c02f461cd4b27fba7b0ef8f838096a4cc16680bb2c6df225fbcf1fe427","x-mappls-evidence-score":28,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-dqv-aggregate-44968fb79a","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/dqv/catchement_query/join":{"get":{"operationId":"mgis-get-dqv-catchement-query-join-fetches-the-results-of-the-query-applied-between-two-dataset-as-well-as-between-one-datset-and-user-defimed-geometry","summary":"Fetches the results of the query applied between two dataset as well as between one datset and user defimed geometry.","description":"User can performed both the following tasks: Non Spatial Query Spatial Query For spatial query user can perform the query between 2 datasets as well as between one dataset and user defined geometry in geojson format. Whereas Non-Spatial Query is only applicable between 2 datasets.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-dqv-catchement-query-join-fetches-the-results-of-the-query-applied-between-two-dataset-as-well-as-between-one-datset-and-user-defimed-geometry"},"parameters":[{"name":"queryType","in":"query","required":true,"description":"queryType value can be basic, spatial .","schema":{"type":"string","description":"queryType value can be basic, spatial .","example":"functionBased"}},{"name":"datasetSource","in":"query","required":true,"description":"Source dataset name. Mandatory both in case of Spatial as well as Non-Spatial Query.","schema":{"type":"string","description":"Source dataset name. Mandatory both in case of Spatial as well as Non-Spatial Query.","example":"geocode_ii"}},{"name":"datasetRef","in":"query","required":false,"description":"Source dataset name. Mandatory both in case of Non-Spatial Query.","schema":{"type":"string","description":"Source dataset name. Mandatory both in case of Non-Spatial Query.","example":"geocode_iii"}},{"name":"operator","in":"query","required":true,"description":"Mandatory both in case of Spatial as well as Non-Spatial Query. Operators allowed for queryType = 'basic' are: =, =, , <>, IN and NOT IN Operators allowed for queryType = 'spatial' are: Intersects, Disjoint, Overlaps, Equals, Touches, DWithin, Within, Contains and Crosses","schema":{"type":"string","description":"Mandatory both in case of Spatial as well as Non-Spatial Query. Operators allowed for queryType = 'basic' are: =, =, , <>, IN and NOT IN Operators allowed for queryType = 'spatial' are: Intersects, Disjoint, Overlaps, Equals, Touches, DWithin, Within, Contains and Crosses","example":"Intersects"}},{"name":"sourceProperty","in":"query","required":true,"description":"Source property attributes to be queried. Mandatory both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Source property attributes to be queried. Mandatory both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"id"}},{"name":"refProperty","in":"query","required":false,"description":"Reference property attributes to be queried. Mandatory in case of Non-Spatial Query.","schema":{"type":"string","description":"Reference property attributes to be queried. Mandatory in case of Non-Spatial Query.","example":"id"}},{"name":"selectionParamSource","in":"query","required":false,"description":"Source property attributes to be reflected in the result. Optional in case of arithmetic operations, Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Source property attributes to be reflected in the result. Optional in case of arithmetic operations, Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"id, lat"}},{"name":"selectionParamRef","in":"query","required":false,"description":"Reference property attributes to be reflected in the result. Optional both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Reference property attributes to be reflected in the result. Optional both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"osm_id, name"}},{"name":"userGeom","in":"query","required":false,"description":"Value of UserGeom will be 'true' if user wants to perform spatial filters with user-defined geometry.","schema":{"type":"string","description":"Value of UserGeom will be 'true' if user wants to perform spatial filters with user-defined geometry.","example":true}},{"name":"distance","in":"query","required":false,"description":"Mandatory in case of operator DWithin, else it is not required.","schema":{"type":"number","description":"Mandatory in case of operator DWithin, else it is not required.","example":10}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"type":{"type":"string","example":"FeatureCollection","x-mappls-field-path":"type"},"features":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"features"},"features[].type":{"type":"string","example":"Feature","x-mappls-field-path":"features[].type"},"features[].properties":{"type":"object","example":"example","x-mappls-field-path":"features[].properties"},"features[].geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"features[].geometry"},"features[].geometry.type":{"type":"string","example":"Polygon","x-mappls-field-path":"features[].geometry.type"},"features[].geometry.coordinates":{"type":"array","items":{"type":"string"},"example":"28.612964,77.229463","x-mappls-field-path":"features[].geometry.coordinates"}}},"example":{"type":"FeatureCollection","features":[{"type":"Feature","properties":"example","geometry":{"type":"Polygon","coordinates":[]}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","x-mappls-field-path":"message"},"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].prop1":{"type":"string","description":"Prop1 value","example":"example","x-mappls-field-path":"data[].prop1"},"data[].prop2":{"type":"string","description":"Prop2 value","example":"example","x-mappls-field-path":"data[].prop2"},"data[].prop3":{"type":"string","description":"Prop3 value","example":"example","x-mappls-field-path":"data[].prop3"},"data[].prop4":{"type":"string","description":"Prop4 value","example":"example","x-mappls-field-path":"data[].prop4"},"data[].prop5":{"type":"string","description":"Prop5 value","example":"example","x-mappls-field-path":"data[].prop5"},"data[].prop6":{"type":"string","description":"Prop6 value","example":"example","x-mappls-field-path":"data[].prop6"},"data[].prop7":{"type":"string","description":"Prop7 value","example":"example","x-mappls-field-path":"data[].prop7"},"data[].prop8":{"type":"string","description":"Prop8 value","example":"example","x-mappls-field-path":"data[].prop8"}}},"example":{"code":"200","success":true,"message":"","data":[{"prop1":"example","prop2":"example","prop3":"example","prop4":"example","prop5":"example","prop6":"example","prop7":"example","prop8":"example"}]}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"message":"Layer not found.","code":400}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":401,"x-mappls-field-path":"code"},"message":{"type":"string","description":"error due to authorization","example":"authorization unsuccesful","x-mappls-field-path":"message"}}},"example":{"code":401,"message":"authorization unsuccesful"}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":404,"x-mappls-field-path":"code"},"message":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"message"}}},"example":{"code":404,"message":"No data found in Database."}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":405,"x-mappls-field-path":"code"},"message":{"type":"string","description":"method not allowerd, wrong method or invalid parameters","example":"Method not allowed","x-mappls-field-path":"message"}}},"example":{"code":405,"message":"Method not allowed"}}}},"409":{"description":"Conflict in parameters passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":409,"x-mappls-field-path":"code"},"message":{"type":"string","description":"wrong parameters","example":"wrong parameters","x-mappls-field-path":"message"}}},"example":{"code":409,"message":"wrong parameters"}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"message"}}},"example":{"message":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/dqv-apis.yml","x-mappls-source-fingerprint":"391a57c02f461cd4b27fba7b0ef8f838096a4cc16680bb2c6df225fbcf1fe427","x-mappls-evidence-score":53,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-dqv-catchement-query-join-2137002891","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/dqv/expression":{"get":{"operationId":"mgis-get-dqv-expression-performs-arithmetic-geometric-aggregate-and-string-operations-on-column-s-of-a-dataset-passed-as-an-input","summary":"Performs arithmetic,geometric,aggregate and string operations on column(s) of a dataset passed as an input.","description":"Performs arithmetic,string,geometric and aggregate operations on a column of a dataset passed as an input. Arithmetic operations are +, -, , /. String operations are concat, lower, upper, initcap, replace, length, substring. Geometric operations are area,length,latitude,longitude,centroid. Aggregate operations are count,min,max,median,stddev,sum,avg.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-dqv-expression-performs-arithmetic-geometric-aggregate-and-string-operations-on-column-s-of-a-dataset-passed-as-an-input"},"parameters":[{"name":"queryType","in":"query","required":true,"description":"queryType values can be arithmetic,string,geometric and aggregate. On the basis of queryType value API can find which type of query you want to execute.","schema":{"type":"string","description":"queryType values can be arithmetic,string,geometric and aggregate. On the basis of queryType value API can find which type of query you want to execute.","example":"arithmetic"}},{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"operator","in":"query","required":true,"description":"Operator can contain the value of arithmetic,string,aggregate,geometric. Arithmetic Operators -,+,/, String Operators = Length,Upper,Lower,InitCap,Concat,Replace,Substring Aggregate Operators = Count, Average, Max, Median, Min, StdDev, Sum and distinct Geometric Operators = Lat,Long,Centroid,Area,Length","schema":{"type":"string","description":"Operator can contain the value of arithmetic,string,aggregate,geometric. Arithmetic Operators -,+,/, String Operators = Length,Upper,Lower,InitCap,Concat,Replace,Substring Aggregate Operators = Count, Average, Max, Median, Min, StdDev, Sum and distinct Geometric Operators = Lat,Long,Centroid,Area,Length","example":"replace"}},{"name":"col","in":"query","required":true,"description":"Single/Multiple column names on which the querytype operations has to be performed. In case of Querytype Geometric and geometric operators and String Operator(substring) single column value is required.","schema":{"type":"string","description":"Single/Multiple column names on which the querytype operations has to be performed. In case of Querytype Geometric and geometric operators and String Operator(substring) single column value is required.","example":"district,bank"}},{"name":"type","in":"query","required":true,"description":"This parameter consists the type of property. Properties are - Create, View, Update. In case of Create We need new column. In case of View, newcolumn is not required and the data after operation will be shown in response. In case of Update the values get updated in the col of the table. In case of Geometric Operations UPDATE method/type are not applicable. In case of Aggregate Operations CREATE and UPDATE methods/types are not applicable.","schema":{"type":"string","description":"This parameter consists the type of property. Properties are - Create, View, Update. In case of Create We need new column. In case of View, newcolumn is not required and the data after operation will be shown in response. In case of Update the values get updated in the col of the table. In case of Geometric Operations UPDATE method/type are not applicable. In case of Aggregate Operations CREATE and UPDATE methods/types are not applicable.","example":"view"}},{"name":"new_column","in":"query","required":false,"description":"newcolumn parameter is only mandatory in case of Type:Create, which is the name of new column to be created","schema":{"type":"string","description":"newcolumn parameter is only mandatory in case of Type:Create, which is the name of new column to be created","example":"updated_values"}},{"name":"filter","in":"query","required":false,"description":"Filter is the query to be applied on the dataset.","schema":{"type":"string","description":"Filter is the query to be applied on the dataset.","example":"district in ( 'Bikaner','Churu')values"}},{"name":"delimiter","in":"query","required":false,"description":"A delimiter is a sequence of one or more characters for specifying the boundary between separate, independent regions in plain text, mathematical expressions or other data streams. An example of a delimiter is the comma character, which acts as a field delimiter in a sequence of comma-separated values.[Note: Delimiter is applicable when when multiple column names have been added and its value always be in single inverted comma.]","schema":{"type":"string","description":"A delimiter is a sequence of one or more characters for specifying the boundary between separate, independent regions in plain text, mathematical expressions or other data streams. An example of a delimiter is the comma character, which acts as a field delimiter in a sequence of comma-separated values.[Note: Delimiter is applicable when when multiple column names have been added and its value always be in single inverted comma.]","example":"'_'"}},{"name":"oldData","in":"query","required":false,"description":"oldData is the existing value which can be replaced.","schema":{"type":"string","description":"oldData is the existing value which can be replaced.","example":"Bikaner"}},{"name":"newData","in":"query","required":false,"description":"New Value that needs to be replaced with an existing value.","schema":{"type":"string","description":"New Value that needs to be replaced with an existing value.","example":"Delhi"}},{"name":"start","in":"query","required":false,"description":"starting index of substring.","schema":{"type":"number","description":"starting index of substring.","example":2}},{"name":"steps","in":"query","required":false,"description":"number of characters in the substring. If steps is blank then substring will contain characters from starting value provided to end of string.","schema":{"type":"number","description":"number of characters in the substring. If steps is blank then substring will contain characters from starting value provided to end of string.","example":5}},{"name":"groupBy","in":"query","required":false,"description":"Pass the column names list which you want to display in the resultant. In case of multiple attributes passed in the groupBy parameter, by default it will take the first column for group by. In case of Aggregate Operation user can pass single/multiple attribute. In case of String and Arithmetic Operations groupBy, In case of multiple attributes passed in the groupBy parameter, by default it will take the first column for group by. In case of Geometric Operation groupBy is not applicable.","schema":{"type":"string","description":"Pass the column names list which you want to display in the resultant. In case of multiple attributes passed in the groupBy parameter, by default it will take the first column for group by. In case of Aggregate Operation user can pass single/multiple attribute. In case of String and Arithmetic Operations groupBy, In case of multiple attributes passed in the groupBy parameter, by default it will take the first column for group by. In case of Geometric Operation groupBy is not applicable.","example":"household"}},{"name":"distinct","in":"query","required":false,"description":"Distinct parameter is used when user want to get unique values of single/multiple columns of a dataset. Boolean values True and false can be passed. It is mandatory parameter when operator is distinct with queryType = aggregate.","schema":{"type":"string","description":"Distinct parameter is used when user want to get unique values of single/multiple columns of a dataset. Boolean values True and false can be passed. It is mandatory parameter when operator is distinct with queryType = aggregate.","example":true}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response Code","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","x-mappls-field-path":"message"},"data":{"type":"object","example":"example","x-mappls-field-path":"data"},"data.result":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data.result"},"data.result[].lat":{"type":"number","example":"28.612964","x-mappls-field-path":"data.result[].lat"},"data.result[].lon":{"type":"number","example":"77.229463","x-mappls-field-path":"data.result[].lon"},"data.result[].updated_values":{"type":"number","example":109.9204,"x-mappls-field-path":"data.result[].updated_values"}}},"example":{"code":"200","success":true,"message":"","data":{"result":[{"lat":32.3345,"lon":77.5859,"updated_values":109.9204}]}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"message":"Layer not found.","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":404,"x-mappls-field-path":"code"},"message":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"message"}}},"example":{"code":404,"message":"No data found in Database."}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"message"}}},"example":{"message":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/dqv-apis.yml","x-mappls-source-fingerprint":"391a57c02f461cd4b27fba7b0ef8f838096a4cc16680bb2c6df225fbcf1fe427","x-mappls-evidence-score":34,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-dqv-expression-970375fcf6","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/dqv/geometricFunction":{"get":{"operationId":"mgis-get-dqv-geometricfunction-performs-geometric-operations","summary":"Performs geometric operations.","description":"Performs geometric operations between two user-defined geometry as well as within the dataset. The geometric opertaions available for user defined geometry are (the brackets consists of the parameters to be passed while using the geometric function): Area (geom1) Centroid (geom1) Buffer (geom1, distance) Intersection (geom1, geom2) Distance (geom1, geom2) isEmpty (geom1) length (geom1) endPoint (geom1) (has to be a lineString or multiLineString) The geometric opertaions available for within dataset are: Area (geom1) Centroid (geom1) Buffer (geom1, distance) isEmpty (geom1) length (geom1) endPoint (geom1) (has to be a lineString or multiLineString)","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-dqv-geometricfunction-performs-geometric-operations"},"parameters":[{"name":"functionNme","in":"query","required":true,"description":"Geometric operators which are acceptable are: For user defined geometry: intersection, area, buffer, distance, centroid, isEmpty, length and endPoint For within the dataset: area, buffer, centroid, isEmpty, length and endPoint","schema":{"type":"string","description":"Geometric operators which are acceptable are: For user defined geometry: intersection, area, buffer, distance, centroid, isEmpty, length and endPoint For within the dataset: area, buffer, centroid, isEmpty, length and endPoint","example":"area"}},{"name":"datasetNme","in":"query","required":false,"description":"The dataset on which geometric operation has to be performed. It is mandatory in case of performing geometric operations within the datset.","schema":{"type":"string","description":"The dataset on which geometric operation has to be performed. It is mandatory in case of performing geometric operations within the datset.","example":"geo"}},{"name":"userGeom","in":"query","required":false,"description":"Value of UserGeom will be 'true' if user wants to perform geometric operations with user-defined geometry.","schema":{"type":"string","description":"Value of UserGeom will be 'true' if user wants to perform geometric operations with user-defined geometry.","example":true}},{"name":"geom1","in":"query","required":false,"description":"user defined geometry in terms of geoJSON. It is mandatory in case of user-defined geometry for all the geometric opertaions.","schema":{"type":"string","description":"user defined geometry in terms of geoJSON. It is mandatory in case of user-defined geometry for all the geometric opertaions.","example":"{\n\"type\": \"Polygon\",\n\"coordinates\": [\n[\n[\n75.9375,\n23.725011735951796\n],\n[\n78.92578124999999,\n23.725011735951796\n],\n[\n78.92578124999999,\n26.115985925333536\n],\n[\n75.9375,\n26.115985925333536\n],\n[\n75.9375,\n23.725011735951796\n]\n]\n]\n}"}},{"name":"geom2","in":"query","required":false,"description":"user defined geometry in terms of geoJSON. It is mandatory in case of user-defined geometry for distance and intersection geometric opertaions.","schema":{"type":"string","description":"user defined geometry in terms of geoJSON. It is mandatory in case of user-defined geometry for distance and intersection geometric opertaions.","example":"{ \"type\": \"Polygon\", \"coordinates\": [ [ [ 75.9375, 23.725011735951796 ], [ 78.92578124999999, 23.725011735951796 ], [ 78.92578124999999, 26.115985925333536 ], [ 75.9375, 26.115985925333536 ], [ 75.9375, 23.725011735951796 ] ] ] }"}},{"name":"distance","in":"query","required":false,"description":"Mandatory in case when opertaor used is Buffer, else it is not required.","schema":{"type":"number","description":"Mandatory in case when opertaor used is Buffer, else it is not required.","example":10}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"response code","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","example":true,"x-mappls-field-path":"message"},"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].area":{"type":"number","description":"value of area after spatial operation","example":"0.2670491076815","x-mappls-field-path":"data[].area"}}},"example":{"code":"200","success":true,"message":true,"data":[{"area":"0.2670491076815"}]}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"message":"Layer not found.","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":404,"x-mappls-field-path":"code"},"message":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"message"}}},"example":{"code":404,"message":"No data found in Database."}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"message"}}},"example":{"message":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/dqv-apis.yml","x-mappls-source-fingerprint":"391a57c02f461cd4b27fba7b0ef8f838096a4cc16680bb2c6df225fbcf1fe427","x-mappls-evidence-score":26,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-dqv-geometricfunction-fb5ef95bd8","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/dqv/getBoundingBox":{"get":{"operationId":"mgis-get-dqv-getboundingbox-returns-the-boundingbox-of-the-particular-layer","summary":"Returns the BoundingBox of the particular layer.","description":"Returns the Bounding Box of the particular layer without cqlfilter and returns the bounding box of feature with cqlfilter.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-dqv-getboundingbox-returns-the-boundingbox-of-the-particular-layer"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"query","in":"query","required":false,"description":"the cqlfilter to be applied on the layer.","schema":{"type":"string","description":"the cqlfilter to be applied on the layer.","example":"state = 'Delhi'"}},{"name":"dataStoreName","in":"query","required":false,"description":"Name of datastore where adaptor published.","schema":{"type":"string","description":"Name of datastore where adaptor published.","example":"adaptor"}},{"name":"layerType","in":"query","required":false,"description":"When user wants to fetch bbox for admin layers.","schema":{"type":"string","description":"When user wants to fetch bbox for admin layers.","example":"admin"}},{"name":"countryNme","in":"query","required":false,"description":"When user wants to fetch bbox for Nepal and Bhutan only.","schema":{"type":"string","description":"When user wants to fetch bbox for Nepal and Bhutan only.","example":"nepal"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","x-mappls-field-path":"message"},"data":{"type":"object","example":"example","x-mappls-field-path":"data"},"data.bounds":{"type":"array","items":{"type":"string"},"example":"example","x-mappls-field-path":"data.bounds"}}},"example":{"code":"200","success":true,"message":"","data":{"bounds":[[["8.035406","68.952956"],["34.570723","96.82733"]]]}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"message":"Layer not found.","code":400}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"message"}}},"example":{"message":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/dqv-apis.yml","x-mappls-source-fingerprint":"391a57c02f461cd4b27fba7b0ef8f838096a4cc16680bb2c6df225fbcf1fe427","x-mappls-evidence-score":19,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-dqv-getboundingbox-b57b6fcefb","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/dqv/getDataset":{"get":{"operationId":"mgis-get-dqv-getdataset-fetches-the-entire-dataset","summary":"Fetches the entire dataset.","description":"Fetches the entire dataset. You can perform 'order(sort) By' and 'groupBy' in 'query'. This has 3 cases: Only Order By Only Group By Both Order By and Group By together","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-dqv-getdataset-fetches-the-entire-dataset"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"groupBy","in":"query","required":false,"description":"Pass ‘true’ to perform groupBy on the datsetNme. 'propertyName' paramter is mandatory for 'groupBy' parameter.","schema":{"type":"string","description":"Pass ‘true’ to perform groupBy on the datsetNme. 'propertyName' paramter is mandatory for 'groupBy' parameter.","example":"true"}},{"name":"propertyName","in":"query","required":false,"description":"Pass the column names list which you want to display in the resultant. Optional in case of order(sortBy). Mandatory in case of 'groupBy'.","schema":{"type":"string","description":"Pass the column names list which you want to display in the resultant. Optional in case of order(sortBy). Mandatory in case of 'groupBy'.","example":"street,poi"}},{"name":"sortBy","in":"query","required":false,"description":"Pass ‘A' for ascending and ‘D’ for descending to perform order(sort) By. Mandatory when order(sort) By is to be performed.","schema":{"type":"string","description":"Pass ‘A' for ascending and ‘D’ for descending to perform order(sort) By. Mandatory when order(sort) By is to be performed.","example":"A"}},{"name":"sortByProperty","in":"query","required":false,"description":"Pass the column names which the user wants to order(sort) By in the resultant. Mandatory when order(sort) By is to be performed.","schema":{"type":"string","description":"Pass the column names which the user wants to order(sort) By in the resultant. Mandatory when order(sort) By is to be performed.","example":"poi,street"}},{"name":"startIndex","in":"query","required":false,"description":"To set the start index from which the user wants the result to be displayed. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","schema":{"type":"number","description":"To set the start index from which the user wants the result to be displayed. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","example":1}},{"name":"count","in":"query","required":false,"description":"To fix the number of results to be returned. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","schema":{"type":"number","description":"To fix the number of results to be returned. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","example":3}},{"name":"bbox","in":"query","required":false,"description":"Returns the bounding box of the dataset if set as true.","schema":{"type":"string","description":"Returns the bounding box of the dataset if set as true.","example":"false"}},{"name":"dataStoreName","in":"query","required":false,"description":"Name of datastore where adaptor published.","schema":{"type":"string","description":"Name of datastore where adaptor published.","example":"adaptor"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","x-mappls-field-path":"message"},"data":{"type":"object","example":"example","x-mappls-field-path":"data"},"data.type":{"type":"string","example":"FeatureCollection","x-mappls-field-path":"data.type"},"data.features":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data.features"},"data.features[].type":{"type":"string","example":"feature","x-mappls-field-path":"data.features[].type"},"data.features[].id":{"type":"string","description":"feature id of the feature attribute.","example":"india.1","x-mappls-field-path":"data.features[].id"},"data.features[].geometry":{"type":"string","description":"geometry of the feature attribute.","example":"28.612964,77.229463","x-mappls-field-path":"data.features[].geometry"},"data.features[].properties":{"type":"object","example":"example","x-mappls-field-path":"data.features[].properties"},"data.features[].properties.st_name":{"type":"string","example":"ANDAMAN AND NICOBAR ISLANDS","x-mappls-field-path":"data.features[].properties.st_name"},"data.totalFeatures":{"type":"number","example":35,"x-mappls-field-path":"data.totalFeatures"},"data.numberMatched":{"type":"number","example":35,"x-mappls-field-path":"data.numberMatched"},"data.numberReturned":{"type":"number","example":1,"x-mappls-field-path":"data.numberReturned"},"data.timestamp":{"type":"string","example":"1700000000000","x-mappls-field-path":"data.timestamp"},"data.links":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data.links"},"data.links[].title":{"type":"string","example":"next page","x-mappls-field-path":"data.links[].title"},"data.links[].type":{"type":"string","example":"application/json","x-mappls-field-path":"data.links[].type"},"data.links[].rel":{"type":"string","example":"next","x-mappls-field-path":"data.links[].rel"},"data.links[].href":{"type":"string","example":"http://localhost:8081/geoserver/wfs?PROPERTYNAME=st_name&TYPENAME=anjali%3Aindia&REQUEST=GetFeature&OUTPUTFORMAT=application%2Fjson&VERSION=2.0.0&SERVICE=WFS&COUNT=1&ISDENORMALIZED=false&STARTINDEX=1","x-mappls-field-path":"data.links[].href"},"data.crs":{"type":"string","example":"null","x-mappls-field-path":"data.crs"},"data.layerBounds":{"type":"string","example":"example","x-mappls-field-path":"data.layerBounds"}}},"example":{"code":"200","success":true,"message":"","data":{"type":"FeatureCollection","features":[{"type":"feature","id":"india.1","geometry":"null","properties":{"st_name":"ANDAMAN AND NICOBAR ISLANDS"}}],"totalFeatures":35,"numberMatched":35,"numberReturned":1,"timestamp":"2020-08-10T13:59:51.624Z","links":[{"title":"next page","type":"application/json","rel":"next","href":"http://localhost:8081/geoserver/wfs?PROPERTYNAME=st_name&TYPENAME=anjali%3Aindia&REQUEST=GetFeature&OUTPUTFORMAT=application%2Fjson&VERSION=2.0.0&SERVICE=WFS&COUNT=1&ISDENORMALIZED=false&STARTINDEX=1"}],"crs":"null"}}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"message":"Layer not found.","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":404,"x-mappls-field-path":"code"},"message":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"message"}}},"example":{"code":404,"message":"No data found in Database."}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"message"}}},"example":{"message":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/dqv-apis.yml","x-mappls-source-fingerprint":"391a57c02f461cd4b27fba7b0ef8f838096a4cc16680bb2c6df225fbcf1fe427","x-mappls-evidence-score":46,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-dqv-getdataset-0ba657c8d9","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/dqv/query_apply/join":{"post":{"operationId":"mgis-post-dqv-query-apply-join-fetches-the-results-of-the-query-applied-between-two-dataset-as-well-as-between-one-datset-and-user-defimed-geometry","summary":"Fetches the results of the query applied between two dataset as well as between one datset and user defimed geometry.","description":"User can performed both the following tasks: Non Spatial Query Spatial Query For spatial query user can perform the query between 2 datasets as well as between one dataset and user defined geometry in geojson format. Whereas Non-Spatial Query is only applicable between 2 datasets.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-dqv-query-apply-join-fetches-the-results-of-the-query-applied-between-two-dataset-as-well-as-between-one-datset-and-user-defimed-geometry"},"parameters":[{"name":"queryType","in":"query","required":true,"description":"queryType value can be basic, spatialOperation or functionBased .","schema":{"type":"string","description":"queryType value can be basic, spatialOperation or functionBased .","example":"functionBased"}},{"name":"datasetSource","in":"query","required":true,"description":"Source dataset name. Mandatory both in case of Spatial as well as Non-Spatial Query.","schema":{"type":"string","description":"Source dataset name. Mandatory both in case of Spatial as well as Non-Spatial Query.","example":"geocode_ii"}},{"name":"datasetRef","in":"query","required":false,"description":"Source dataset name. Mandatory both in case of Non-Spatial Query.","schema":{"type":"string","description":"Source dataset name. Mandatory both in case of Non-Spatial Query.","example":"geocode_iii"}},{"name":"operator","in":"query","required":true,"description":"Mandatory both in case of Spatial as well as Non-Spatial Query. Operators allowed for queryType = 'basic' are: =, =, , <>, IN and NOT IN Operators allowed for queryType = 'spatialOperation' are: Intersects, Disjoint, Overlaps, Equals, Touches, DWithin, Within, Contains and Crosses","schema":{"type":"string","description":"Mandatory both in case of Spatial as well as Non-Spatial Query. Operators allowed for queryType = 'basic' are: =, =, , <>, IN and NOT IN Operators allowed for queryType = 'spatialOperation' are: Intersects, Disjoint, Overlaps, Equals, Touches, DWithin, Within, Contains and Crosses","example":"Intersects"}},{"name":"sourceProperty","in":"query","required":true,"description":"Source property attributes to be queried. Mandatory both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Source property attributes to be queried. Mandatory both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"id"}},{"name":"refProperty","in":"query","required":false,"description":"Reference property attributes to be queried. Mandatory in case of Non-Spatial Query.","schema":{"type":"string","description":"Reference property attributes to be queried. Mandatory in case of Non-Spatial Query.","example":"id"}},{"name":"selectionParamSource","in":"query","required":false,"description":"Source property attributes to be reflected in the result. Optional in case of arithmetic operations, Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Source property attributes to be reflected in the result. Optional in case of arithmetic operations, Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"id, lat"}},{"name":"selectionParamRef","in":"query","required":false,"description":"Reference property attributes to be reflected in the result. Optional both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Reference property attributes to be reflected in the result. Optional both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"osm_id, name"}},{"name":"userGeom","in":"query","required":false,"description":"Value of UserGeom will be 'true' if user wants to perform spatial filters with user-defined geometry.","schema":{"type":"string","description":"Value of UserGeom will be 'true' if user wants to perform spatial filters with user-defined geometry.","example":true}},{"name":"distance","in":"query","required":false,"description":"Mandatory in case of operator DWithin, else it is not required.","schema":{"type":"number","description":"Mandatory in case of operator DWithin, else it is not required.","example":10}},{"name":"comparisonFunction","in":"query","required":false,"description":"The functions allowed are: Area, Length and isEmpty . This parameter is mandatory for queryType functionBased.","schema":{"type":"string","description":"The functions allowed are: Area, Length and isEmpty . This parameter is mandatory for queryType functionBased.","example":"Area"}},{"name":"comparisonOperator","in":"query","required":false,"description":"The operators allowed are: =, >, , >= and <=. This parameter is mandatory for queryType functionBased.","schema":{"type":"string","description":"The operators allowed are: =, >, , >= and <=. This parameter is mandatory for queryType functionBased.","example":"="}},{"name":"comparisonValue","in":"query","required":false,"description":"The values allowed are: Numeric (in meters) (for comparisonFunction area and length) Boolean (for comparisonFunction isEmpty) . This parameter is mandatory for queryType functionBased.","schema":{"type":"string","description":"The values allowed are: Numeric (in meters) (for comparisonFunction area and length) Boolean (for comparisonFunction isEmpty) . This parameter is mandatory for queryType functionBased.","example":"100"}},{"name":"saveAsNewDataset","in":"query","required":false,"description":"Boolean if true cross join result will be saved in to db as new table.","schema":{"type":"string","description":"Boolean if true cross join result will be saved in to db as new table.","example":true}},{"name":"newDatasetNme","in":"query","required":false,"description":"Name of new Table(mandatory if saveAsNewDataset = true)","schema":{"type":"string","description":"Name of new Table(mandatory if saveAsNewDataset = true)","example":"JoinTable"}},{"name":"filter","in":"query","required":false,"description":"query on the basis of which the response required (only applicable on queryType spatial join).","schema":{"type":"string","description":"query on the basis of which the response required (only applicable on queryType spatial join).","example":"id=368"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"geometry"},"geometry.type":{"type":"string","example":"FeatureCollection","x-mappls-field-path":"geometry.type"},"geometry.features":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"geometry.features"},"geometry.features[].type":{"type":"string","example":"Feature","x-mappls-field-path":"geometry.features[].type"},"geometry.features[].properties":{"type":"object","example":"example","x-mappls-field-path":"geometry.features[].properties"},"geometry.features[].geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"geometry.features[].geometry"},"geometry.features[].geometry.type":{"type":"string","example":"Polygon","x-mappls-field-path":"geometry.features[].geometry.type"},"geometry.features[].geometry.coordinates":{"type":"array","items":{"type":"string"},"example":"28.612964,77.229463","x-mappls-field-path":"geometry.features[].geometry.coordinates"}}},"example":{"geometry":{"type":"FeatureCollection","features":[{"type":"Feature","properties":"example","geometry":{"type":"Polygon","coordinates":"28.612964,77.229463"}}]}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","x-mappls-field-path":"message"},"data":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data"},"data[].prop1":{"type":"string","description":"Prop1 value","example":"example","x-mappls-field-path":"data[].prop1"},"data[].prop2":{"type":"string","description":"Prop2 value","example":"example","x-mappls-field-path":"data[].prop2"},"data[].prop3":{"type":"string","description":"Prop3 value","example":"example","x-mappls-field-path":"data[].prop3"},"data[].prop4":{"type":"string","description":"Prop4 value","example":"example","x-mappls-field-path":"data[].prop4"},"data[].prop5":{"type":"string","description":"Prop5 value","example":"example","x-mappls-field-path":"data[].prop5"},"data[].prop6":{"type":"string","description":"Prop6 value","example":"example","x-mappls-field-path":"data[].prop6"},"data[].prop7":{"type":"string","description":"Prop7 value","example":"example","x-mappls-field-path":"data[].prop7"},"data[].prop8":{"type":"string","description":"Prop8 value","example":"example","x-mappls-field-path":"data[].prop8"}}},"example":{"code":"200","success":true,"message":"","data":[{"prop1":"example","prop2":"example","prop3":"example","prop4":"example","prop5":"example","prop6":"example","prop7":"example","prop8":"example"}]}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"message":"Layer not found.","code":400}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":401,"x-mappls-field-path":"code"},"message":{"type":"string","description":"error due to authorization","example":"authorization unsuccesful","x-mappls-field-path":"message"}}},"example":{"code":401,"message":"authorization unsuccesful"}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":404,"x-mappls-field-path":"code"},"message":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"message"}}},"example":{"code":404,"message":"No data found in Database."}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":405,"x-mappls-field-path":"code"},"message":{"type":"string","description":"method not allowerd, wrong method or invalid parameters","example":"Method not allowed","x-mappls-field-path":"message"}}},"example":{"code":405,"message":"Method not allowed"}}}},"409":{"description":"Conflict in parameters passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":409,"x-mappls-field-path":"code"},"message":{"type":"string","description":"wrong parameters","example":"wrong parameters","x-mappls-field-path":"message"}}},"example":{"code":409,"message":"wrong parameters"}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"message"}}},"example":{"message":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/dqv-apis.yml","x-mappls-source-fingerprint":"391a57c02f461cd4b27fba7b0ef8f838096a4cc16680bb2c6df225fbcf1fe427","x-mappls-evidence-score":60,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-post-dqv-query-apply-join-b29f7253f5","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/dqv/query_apply/single":{"post":{"operationId":"mgis-post-dqv-query-apply-single-fetches-the-results-of-the-query-applied-on-the-single-dataset-you-cannot-pass-query-summerizevalue-and-uniquevalue-paramater-together","summary":"Fetches the results of the query applied on the single dataset. You cannot pass query, summerizeValue and uniqueValue paramater together.","description":"You cannot pass query, summerizeValue and uniqueValue paramater together. You can perform 'order(sort) By' and 'groupBy' in 'query'. This has 3 cases: Only Order By Only Group By Both Order By and Group By together You can perform geometric operation (area and length) when queryType = 'functionBased' is passed. The query parameter is an optional paramater in this case. summerizeValue and uniqueValue paramater are not applicable in this case.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-dqv-query-apply-single-fetches-the-results-of-the-query-applied-on-the-single-dataset-you-cannot-pass-query-summerizevalue-and-uniquevalue-paramater-together"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"queryType","in":"query","required":false,"description":"queryType value should be functionBased. Mandatory when user has to perform geometric operations with or without query.","schema":{"type":"string","description":"queryType value should be functionBased. Mandatory when user has to perform geometric operations with or without query.","example":"functionBased"}},{"name":"query","in":"query","required":false,"description":"Query to be applied on the dataset. Mandatory if uniqueValue, summerizeValue and queryType parameter is not passed. This is an optional paramter when queryType = 'functionBased' is passed.","schema":{"type":"string","description":"Query to be applied on the dataset. Mandatory if uniqueValue, summerizeValue and queryType parameter is not passed. This is an optional paramter when queryType = 'functionBased' is passed.","example":"state = 'Delhi'"}},{"name":"uniqueValue","in":"query","required":false,"description":"Unique values of a attribute of the dataset. Mandatory if query and summerizeValue parameter is not passed.","schema":{"type":"string","description":"Unique values of a attribute of the dataset. Mandatory if query and summerizeValue parameter is not passed.","example":"st_name"}},{"name":"summerizeValue","in":"query","required":false,"description":"Summerize values of a attribute of the dataset. Mandatory if query and uniqueValue parameter is not passed.","schema":{"type":"string","description":"Summerize values of a attribute of the dataset. Mandatory if query and uniqueValue parameter is not passed.","example":"st_name"}},{"name":"groupBy","in":"query","required":false,"description":"Pass ‘true’ to perform groupBy on the datsetNme. Applicable for 'query'. 'propertyName' paramter is mandatory for 'groupBy' parameter.","schema":{"type":"string","description":"Pass ‘true’ to perform groupBy on the datsetNme. Applicable for 'query'. 'propertyName' paramter is mandatory for 'groupBy' parameter.","example":"true"}},{"name":"propertyName","in":"query","required":false,"description":"Pass the column names list which you want to display in the resultant. Optional in case of order(sortBy). Mandatory in case of 'groupBy'.","schema":{"type":"string","description":"Pass the column names list which you want to display in the resultant. Optional in case of order(sortBy). Mandatory in case of 'groupBy'.","example":"street,poi"}},{"name":"sortBy","in":"query","required":false,"description":"Pass ‘A' for ascending and ‘D’ for descending to perform order(sort) By. Applicable for all. Mandatory when order(sort) By is to be performed.","schema":{"type":"string","description":"Pass ‘A' for ascending and ‘D’ for descending to perform order(sort) By. Applicable for all. Mandatory when order(sort) By is to be performed.","example":"A"}},{"name":"sortByProperty","in":"query","required":false,"description":"Pass the column names which the user wants to order(sort) By in the resultant. Applicable for 'query'. Mandatory when order(sort) By is to be performed.","schema":{"type":"string","description":"Pass the column names which the user wants to order(sort) By in the resultant. Applicable for 'query'. Mandatory when order(sort) By is to be performed.","example":"poi,street"}},{"name":"propertyName","in":"query","required":false,"description":"Property attributes to be reflected in the result. If not passed all the columns of the datasetNme will be displayed in the resultant.","schema":{"type":"string","description":"Property attributes to be reflected in the result. If not passed all the columns of the datasetNme will be displayed in the resultant.","example":"housenumber"}},{"name":"comparisonFunction","in":"query","required":false,"description":"The functions allowed are: Area and Length . This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","schema":{"type":"string","description":"The functions allowed are: Area and Length . This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","example":"Area"}},{"name":"comparisonOperator","in":"query","required":false,"description":"The operators allowed are: =, >, , >= and <=. This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","schema":{"type":"string","description":"The operators allowed are: =, >, , >= and <=. This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","example":"="}},{"name":"comparisonValue","in":"query","required":false,"description":"The value should be in numeric (in meters). This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","schema":{"type":"number","description":"The value should be in numeric (in meters). This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","example":10}},{"name":"saveAsNewDataset","in":"query","required":false,"description":"Pass ‘true’ for the resultant to be saved in to user's workspace as a new table. Applicable for only queryType = 'functionBased","schema":{"type":"string","description":"Pass ‘true’ for the resultant to be saved in to user's workspace as a new table. Applicable for only queryType = 'functionBased","example":"true"}},{"name":"newDatasetNme","in":"query","required":false,"description":"Name of the table in which the resultant has to be stored. This parameter is mandatory if saveAsNewDataset = true. Applicable for only queryType = 'functionBased'","schema":{"type":"string","description":"Name of the table in which the resultant has to be stored. This parameter is mandatory if saveAsNewDataset = true. Applicable for only queryType = 'functionBased'","example":"geotest"}},{"name":"sortBy","in":"query","required":false,"description":"Sort the result in ascending(A) or descending(D) order. Applicable for 'orderBy', 'groupBy', 'uniqueValue' and 'summerizeValue'.","schema":{"type":"string","description":"Sort the result in ascending(A) or descending(D) order. Applicable for 'orderBy', 'groupBy', 'uniqueValue' and 'summerizeValue'.","example":"A"}},{"name":"startIndex","in":"query","required":false,"description":"To set the start index from which the user wants the result to be displayed. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","schema":{"type":"number","description":"To set the start index from which the user wants the result to be displayed. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","example":1}},{"name":"count","in":"query","required":false,"description":"To fix the number of results to be returned. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","schema":{"type":"number","description":"To fix the number of results to be returned. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","example":3}},{"name":"bbox","in":"query","required":false,"description":"Returns the bounding box of the dataset if set as true.","schema":{"type":"string","description":"Returns the bounding box of the dataset if set as true.","example":"false"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","x-mappls-field-path":"message"},"data":{"type":"object","example":"example","x-mappls-field-path":"data"},"data.type":{"type":"string","example":"FeatureCollection","x-mappls-field-path":"data.type"},"data.features":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data.features"},"data.features[].type":{"type":"string","example":"Feature","x-mappls-field-path":"data.features[].type"},"data.features[].id":{"type":"string","example":" india.2","x-mappls-field-path":"data.features[].id"},"data.features[].geometry":{"type":"string","example":"28.612964,77.229463","x-mappls-field-path":"data.features[].geometry"},"data.features[].properties":{"type":"object","example":"example","x-mappls-field-path":"data.features[].properties"},"data.features[].properties.st_name":{"type":"string","example":"Andhra Pradesh","x-mappls-field-path":"data.features[].properties.st_name"},"data.totalFeatures":{"type":"number","example":1,"x-mappls-field-path":"data.totalFeatures"},"data.numberMatched":{"type":"number","example":1,"x-mappls-field-path":"data.numberMatched"},"data.numberReturned":{"type":"number","example":1,"x-mappls-field-path":"data.numberReturned"},"data.timestamp":{"type":"string","example":"1700000000000","x-mappls-field-path":"data.timestamp"},"data.crs":{"type":"string","example":"null","x-mappls-field-path":"data.crs"},"data.layerBounds":{"type":"string","example":"null","x-mappls-field-path":"data.layerBounds"}}},"example":{"code":"200","success":true,"message":"","data":{"type":"FeatureCollection","features":[{"type":"Feature","id":" india.2","geometry":"null","properties":{"st_name":"Andhra Pradesh"}}],"totalFeatures":1,"numberMatched":1,"numberReturned":1,"timestamp":"2020-08-10T13:59:51.624Z","crs":"null","layerBounds":"null"}}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"message":"Layer not found.","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":404,"x-mappls-field-path":"code"},"message":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"message"}}},"example":{"code":404,"message":"No data found in Database."}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":405,"x-mappls-field-path":"code"},"message":{"type":"string","description":"method not allowerd, wrong method or invalid parameters","example":"Method not allowed","x-mappls-field-path":"message"}}},"example":{"code":405,"message":"Method not allowed"}}}},"409":{"description":"Conflict in parameters passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":409,"x-mappls-field-path":"code"},"message":{"type":"string","description":"wrong parameters","example":"wrong parameters","x-mappls-field-path":"message"}}},"example":{"code":409,"message":"wrong parameters"}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"message"}}},"example":{"message":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/dqv-apis.yml","x-mappls-source-fingerprint":"391a57c02f461cd4b27fba7b0ef8f838096a4cc16680bb2c6df225fbcf1fe427","x-mappls-evidence-score":57,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-post-dqv-query-apply-single-b7a129a66c","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/dqv/query_validation":{"get":{"operationId":"mgis-get-dqv-query-validation-validates-the-query-to-be-applied-on-a-dataset","summary":"Validates the query to be applied on a dataset.","description":"Validates the query to be applied on a dataset.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-dqv-query-validation-validates-the-query-to-be-applied-on-a-dataset"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"query","in":"query","required":true,"description":"Query to be applied on the dataset. Mandatory if uniqueValue and summerizeValue parameter is not passed.","schema":{"type":"string","description":"Query to be applied on the dataset. Mandatory if uniqueValue and summerizeValue parameter is not passed.","example":"state = 'Delhi'"}},{"name":"dataStoreName","in":"query","required":false,"description":"Name of datastore where adaptor published.","schema":{"type":"string","description":"Name of datastore where adaptor published.","example":"adaptor"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","description":"Displays the message wheather the query is valid or invalid.","example":"Valid Query","x-mappls-field-path":"message"},"data":{"type":"object","example":"example","x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"Valid Query","data":"example"}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"message":"Layer not found.","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":404,"x-mappls-field-path":"code"},"message":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"message"}}},"example":{"code":404,"message":"No data found in Database."}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"message"}}},"example":{"message":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/dqv-apis.yml","x-mappls-source-fingerprint":"391a57c02f461cd4b27fba7b0ef8f838096a4cc16680bb2c6df225fbcf1fe427","x-mappls-evidence-score":22,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-dqv-query-validation-5e2a147139","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/expression":{"get":{"operationId":"mgis-get-expression-performs-arithmetic-geometric-aggregate-and-string-operations-on-column-s-of-a-dataset-passed-as-an-input","summary":"Performs arithmetic,geometric,aggregate and string operations on column(s) of a dataset passed as an input.","description":"Performs arithmetic,string,geometric and aggregate operations on a column of a dataset passed as an input. Arithmetic operations are +, -, , /. String operations are concat, lower, upper, initcap, replace, length, substring. Geometric operations are area,length,latitude,longitude,centroid. Aggregate operations are count,min,max,median,stddev,sum,avg.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-expression-performs-arithmetic-geometric-aggregate-and-string-operations-on-column-s-of-a-dataset-passed-as-an-input"},"parameters":[{"name":"queryType","in":"query","required":true,"description":"queryType values can be arithmetic,string,geometric and aggregate. On the basis of queryType value API can find which type of query you want to execute.","schema":{"type":"string","description":"queryType values can be arithmetic,string,geometric and aggregate. On the basis of queryType value API can find which type of query you want to execute.","example":"arithmetic"}},{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"operator","in":"query","required":true,"description":"Operator can contain the value of arithmetic,string,aggregate,geometric. Arithmetic Operators -,+,/, String Operators = Length,Upper,Lower,InitCap,Concat,Replace,Substring Aggregate Operators = Count, Average, Max, Median, Min, StdDev, Sum and distinct Geometric Operators = Lat,Long,Centroid,Area,Length","schema":{"type":"string","description":"Operator can contain the value of arithmetic,string,aggregate,geometric. Arithmetic Operators -,+,/, String Operators = Length,Upper,Lower,InitCap,Concat,Replace,Substring Aggregate Operators = Count, Average, Max, Median, Min, StdDev, Sum and distinct Geometric Operators = Lat,Long,Centroid,Area,Length","example":"replace"}},{"name":"col","in":"query","required":true,"description":"Single/Multiple column names on which the querytype operations has to be performed. In case of Querytype Geometric and geometric operators and String Operator(substring) single column value is required.","schema":{"type":"string","description":"Single/Multiple column names on which the querytype operations has to be performed. In case of Querytype Geometric and geometric operators and String Operator(substring) single column value is required.","example":"district,bank"}},{"name":"type","in":"query","required":true,"description":"This parameter consists the type of property. Properties are - Create, View, Update. In case of Create We need new column. In case of View, newcolumn is not required and the data after operation will be shown in response. In case of Update the values get updated in the col of the table. In case of Geometric Operations UPDATE method/type are not applicable. In case of Aggregate Operations CREATE and UPDATE methods/types are not applicable.","schema":{"type":"string","description":"This parameter consists the type of property. Properties are - Create, View, Update. In case of Create We need new column. In case of View, newcolumn is not required and the data after operation will be shown in response. In case of Update the values get updated in the col of the table. In case of Geometric Operations UPDATE method/type are not applicable. In case of Aggregate Operations CREATE and UPDATE methods/types are not applicable.","example":"view"}},{"name":"new_column","in":"query","required":false,"description":"newcolumn parameter is only mandatory in case of Type:Create, which is the name of new column to be created","schema":{"type":"string","description":"newcolumn parameter is only mandatory in case of Type:Create, which is the name of new column to be created","example":"updated_values"}},{"name":"filter","in":"query","required":false,"description":"Filter is the query to be applied on the dataset.","schema":{"type":"string","description":"Filter is the query to be applied on the dataset.","example":"district in ( 'Bikaner','Churu')values"}},{"name":"delimiter","in":"query","required":false,"description":"A delimiter is a sequence of one or more characters for specifying the boundary between separate, independent regions in plain text, mathematical expressions or other data streams. An example of a delimiter is the comma character, which acts as a field delimiter in a sequence of comma-separated values.[Note: Delimiter is applicable when when multiple column names have been added and its value always be in single inverted comma.]","schema":{"type":"string","description":"A delimiter is a sequence of one or more characters for specifying the boundary between separate, independent regions in plain text, mathematical expressions or other data streams. An example of a delimiter is the comma character, which acts as a field delimiter in a sequence of comma-separated values.[Note: Delimiter is applicable when when multiple column names have been added and its value always be in single inverted comma.]","example":"'_'"}},{"name":"oldData","in":"query","required":false,"description":"oldData is the existing value which can be replaced.","schema":{"type":"string","description":"oldData is the existing value which can be replaced.","example":"Bikaner"}},{"name":"newData","in":"query","required":false,"description":"New Value that needs to be replaced with an existing value.","schema":{"type":"string","description":"New Value that needs to be replaced with an existing value.","example":"Delhi"}},{"name":"start","in":"query","required":false,"description":"starting index of substring.","schema":{"type":"number","description":"starting index of substring.","example":2}},{"name":"steps","in":"query","required":false,"description":"number of characters in the substring. If steps is blank then substring will contain characters from starting value provided to end of string.","schema":{"type":"number","description":"number of characters in the substring. If steps is blank then substring will contain characters from starting value provided to end of string.","example":5}},{"name":"groupBy","in":"query","required":false,"description":"Pass the column names list which you want to display in the resultant. In case of multiple attributes passed in the groupBy parameter, by default it will take the first column for group by. In case of Aggregate Operation user can pass single/multiple attribute. In case of String and Arithmetic Operations groupBy, In case of multiple attributes passed in the groupBy parameter, by default it will take the first column for group by. In case of Geometric Operation groupBy is not applicable.","schema":{"type":"string","description":"Pass the column names list which you want to display in the resultant. In case of multiple attributes passed in the groupBy parameter, by default it will take the first column for group by. In case of Aggregate Operation user can pass single/multiple attribute. In case of String and Arithmetic Operations groupBy, In case of multiple attributes passed in the groupBy parameter, by default it will take the first column for group by. In case of Geometric Operation groupBy is not applicable.","example":"household"}},{"name":"distinct","in":"query","required":false,"description":"Distinct parameter is used when user want to get unique values of single/multiple columns of a dataset. Boolean values True and false can be passed. It is mandatory parameter when operator is distinct with queryType = aggregate.","schema":{"type":"string","description":"Distinct parameter is used when user want to get unique values of single/multiple columns of a dataset. Boolean values True and false can be passed. It is mandatory parameter when operator is distinct with queryType = aggregate.","example":true}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response Code","example":"200","x-mappls-field-path":"code"},"result":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"result"},"result[].lat":{"type":"number","example":"28.612964","x-mappls-field-path":"result[].lat"},"result[].lon":{"type":"number","example":"77.229463","x-mappls-field-path":"result[].lon"},"result[].updated_values":{"type":"number","example":109.9204,"x-mappls-field-path":"result[].updated_values"}}},"example":{"code":"200","result":[{"lat":32.3345,"lon":77.5859,"updated_values":109.9204}]}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Error exception code.","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"error"}}},"example":{"error":"No data found in Database."}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"error"}}},"example":{"error":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/dqv-apis.yml","x-mappls-source-fingerprint":"ec78e94e77644b4d9ff44c58916c40813cc7f96798318569b33204ebd94fba04","x-mappls-evidence-score":31,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-get-expression-620dd9eb38","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/geometricFunction":{"get":{"operationId":"mgis-get-geometricfunction-performs-geometric-operations","summary":"Performs geometric operations.","description":"Performs geometric operations between two user-defined geometry as well as within the dataset. The geometric opertaions available for user defined geometry are (the brackets consists of the parameters to be passed while using the geometric function): Area (geom1) Centroid (geom1) Buffer (geom1, distance) Intersection (geom1, geom2) Distance (geom1, geom2) isEmpty (geom1) length (geom1) endPoint (geom1) (has to be a lineString or multiLineString) The geometric opertaions available for within dataset are: Area (geom1) Centroid (geom1) Buffer (geom1, distance) isEmpty (geom1) length (geom1) endPoint (geom1) (has to be a lineString or multiLineString)","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-geometricfunction-performs-geometric-operations"},"parameters":[{"name":"functionNme","in":"query","required":true,"description":"Geometric operators which are acceptable are: For user defined geometry: intersection, area, buffer, distance, centroid, isEmpty, length and endPoint For within the dataset: area, buffer, centroid, isEmpty, length and endPoint","schema":{"type":"string","description":"Geometric operators which are acceptable are: For user defined geometry: intersection, area, buffer, distance, centroid, isEmpty, length and endPoint For within the dataset: area, buffer, centroid, isEmpty, length and endPoint","example":"area"}},{"name":"datasetNme","in":"query","required":false,"description":"The dataset on which geometric operation has to be performed. It is mandatory in case of performing geometric operations within the datset.","schema":{"type":"string","description":"The dataset on which geometric operation has to be performed. It is mandatory in case of performing geometric operations within the datset.","example":"geo"}},{"name":"userGeom","in":"query","required":false,"description":"Value of UserGeom will be 'true' if user wants to perform geometric operations with user-defined geometry.","schema":{"type":"string","description":"Value of UserGeom will be 'true' if user wants to perform geometric operations with user-defined geometry.","example":true}},{"name":"geom1","in":"query","required":false,"description":"user defined geometry in terms of geoJSON. It is mandatory in case of user-defined geometry for all the geometric opertaions.","schema":{"type":"string","description":"user defined geometry in terms of geoJSON. It is mandatory in case of user-defined geometry for all the geometric opertaions.","example":"{\n\"type\": \"Polygon\",\n\"coordinates\": [\n[\n[\n75.9375,\n23.725011735951796\n],\n[\n78.92578124999999,\n23.725011735951796\n],\n[\n78.92578124999999,\n26.115985925333536\n],\n[\n75.9375,\n26.115985925333536\n],\n[\n75.9375,\n23.725011735951796\n]\n]\n]\n}"}},{"name":"geom2","in":"query","required":false,"description":"user defined geometry in terms of geoJSON. It is mandatory in case of user-defined geometry for distance and intersection geometric opertaions.","schema":{"type":"string","description":"user defined geometry in terms of geoJSON. It is mandatory in case of user-defined geometry for distance and intersection geometric opertaions.","example":"{ \"type\": \"Polygon\", \"coordinates\": [ [ [ 75.9375, 23.725011735951796 ], [ 78.92578124999999, 23.725011735951796 ], [ 78.92578124999999, 26.115985925333536 ], [ 75.9375, 26.115985925333536 ], [ 75.9375, 23.725011735951796 ] ] ] }"}},{"name":"distance","in":"query","required":false,"description":"Mandatory in case when opertaor used is Buffer, else it is not required.","schema":{"type":"number","description":"Mandatory in case when opertaor used is Buffer, else it is not required.","example":10}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"response code","example":"200","x-mappls-field-path":"code"},"result":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"result"},"result[].area":{"type":"number","description":"value of area after spatial operation","example":"0.2670491076815","x-mappls-field-path":"result[].area"}}},"example":{"code":"200","result":[{"area":"0.2670491076815"}]}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Error exception code.","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"error"}}},"example":{"error":"No data found in Database."}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"error"}}},"example":{"error":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/dqv-apis.yml","x-mappls-source-fingerprint":"ec78e94e77644b4d9ff44c58916c40813cc7f96798318569b33204ebd94fba04","x-mappls-evidence-score":24,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-get-geometricfunction-a30b004a7a","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/getBoundingBox":{"get":{"operationId":"mgis-get-getboundingbox-returns-the-boundingbox-of-the-particular-layer","summary":"Returns the BoundingBox of the particular layer.","description":"Returns the Bounding Box of the particular layer without cqlfilter and returns the bounding box of feature with cqlfilter.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-getboundingbox-returns-the-boundingbox-of-the-particular-layer"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"query","in":"query","required":false,"description":"the cqlfilter to be applied on the layer.","schema":{"type":"string","description":"the cqlfilter to be applied on the layer.","example":"state = 'Delhi'"}},{"name":"datastore","in":"query","required":false,"description":"Name of datastore where adaptor published.","schema":{"type":"string","description":"Name of datastore where adaptor published.","example":"adaptor"}},{"name":"layerType","in":"query","required":false,"description":"When user to fetch bbox for admin layers.","schema":{"type":"string","description":"When user to fetch bbox for admin layers.","example":"admin"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"result":{"type":"object","example":"example","x-mappls-field-path":"result"},"result.type":{"type":"string","example":"FeatureCollection","x-mappls-field-path":"result.type"},"result.features":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"result.features"},"result.features[].type":{"type":"string","example":"feature","x-mappls-field-path":"result.features[].type"},"result.features[].id":{"type":"string","description":"feature id of the feature attribute.","example":"india.1","x-mappls-field-path":"result.features[].id"},"result.features[].geometry":{"type":"string","description":"geometry of the feature attribute.","example":"28.612964,77.229463","x-mappls-field-path":"result.features[].geometry"},"result.features[].properties":{"type":"object","example":"example","x-mappls-field-path":"result.features[].properties"},"result.features[].properties.bbox":{"type":"string","example":"BOX(74.7912769996 34.0866250004,74.7912769996 34.0866250004)","x-mappls-field-path":"result.features[].properties.bbox"},"result.totalFeatures":{"type":"number","example":1,"x-mappls-field-path":"result.totalFeatures"},"result.numberMatched":{"type":"number","example":1,"x-mappls-field-path":"result.numberMatched"},"result.numberReturned":{"type":"number","example":1,"x-mappls-field-path":"result.numberReturned"},"result.timestamp":{"type":"string","example":"1700000000000","x-mappls-field-path":"result.timestamp"},"result.crs":{"type":"string","example":"null","x-mappls-field-path":"result.crs"}}},"example":{"code":"200","result":{"type":"FeatureCollection","features":[{"type":"feature","id":"india.1","geometry":"null","properties":{"bbox":"BOX(74.7912769996 34.0866250004,74.7912769996 34.0866250004)"}}],"totalFeatures":1,"numberMatched":1,"numberReturned":1,"timestamp":"2020-08-10T13:59:51.624Z","crs":"null"}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Error exception code.","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"error"}}},"example":{"error":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/dqv-apis.yml","x-mappls-source-fingerprint":"ec78e94e77644b4d9ff44c58916c40813cc7f96798318569b33204ebd94fba04","x-mappls-evidence-score":28,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-get-getboundingbox-e12794310e","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/getDataset":{"get":{"operationId":"mgis-get-getdataset-fetches-the-entire-dataset","summary":"Fetches the entire dataset.","description":"Fetches the entire dataset. You can perform 'order(sort) By' and 'groupBy' in 'query'. This has 3 cases: Only Order By Only Group By Both Order By and Group By together","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-getdataset-fetches-the-entire-dataset"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"groupBy","in":"query","required":false,"description":"Pass ‘true’ to perform groupBy on the datsetNme. 'propertyName' paramter is mandatory for 'groupBy' parameter.","schema":{"type":"string","description":"Pass ‘true’ to perform groupBy on the datsetNme. 'propertyName' paramter is mandatory for 'groupBy' parameter.","example":"true"}},{"name":"propertyName","in":"query","required":false,"description":"Pass the column names list which you want to display in the resultant. Optional in case of order(sortBy). Mandatory in case of 'groupBy'.","schema":{"type":"string","description":"Pass the column names list which you want to display in the resultant. Optional in case of order(sortBy). Mandatory in case of 'groupBy'.","example":"street,poi"}},{"name":"sortBy","in":"query","required":false,"description":"Pass ‘A' for ascending and ‘D’ for descending to perform order(sort) By. Mandatory when order(sort) By is to be performed.","schema":{"type":"string","description":"Pass ‘A' for ascending and ‘D’ for descending to perform order(sort) By. Mandatory when order(sort) By is to be performed.","example":"A"}},{"name":"sortByProperty","in":"query","required":false,"description":"Pass the column names which the user wants to order(sort) By in the resultant. Mandatory when order(sort) By is to be performed.","schema":{"type":"string","description":"Pass the column names which the user wants to order(sort) By in the resultant. Mandatory when order(sort) By is to be performed.","example":"poi,street"}},{"name":"startIndex","in":"query","required":false,"description":"To set the start index from which the user wants the result to be displayed. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","schema":{"type":"number","description":"To set the start index from which the user wants the result to be displayed. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","example":1}},{"name":"count","in":"query","required":false,"description":"To fix the number of results to be returned. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","schema":{"type":"number","description":"To fix the number of results to be returned. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","example":3}},{"name":"bbox","in":"query","required":false,"description":"Returns the bounding box of the dataset if set as true.","schema":{"type":"string","description":"Returns the bounding box of the dataset if set as true.","example":"false"}},{"name":"datastore","in":"query","required":false,"description":"Name of datastore where adaptor published.","schema":{"type":"string","description":"Name of datastore where adaptor published.","example":"adaptor"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"result":{"type":"object","example":"example","x-mappls-field-path":"result"},"result.type":{"type":"string","example":"FeatureCollection","x-mappls-field-path":"result.type"},"result.features":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"result.features"},"result.features[].type":{"type":"string","example":"feature","x-mappls-field-path":"result.features[].type"},"result.features[].id":{"type":"string","description":"feature id of the feature attribute.","example":"india.1","x-mappls-field-path":"result.features[].id"},"result.features[].geometry":{"type":"string","description":"geometry of the feature attribute.","example":"28.612964,77.229463","x-mappls-field-path":"result.features[].geometry"},"result.features[].properties":{"type":"object","example":"example","x-mappls-field-path":"result.features[].properties"},"result.features[].properties.st_name":{"type":"string","example":"ANDAMAN AND NICOBAR ISLANDS","x-mappls-field-path":"result.features[].properties.st_name"},"result.totalFeatures":{"type":"number","example":35,"x-mappls-field-path":"result.totalFeatures"},"result.numberMatched":{"type":"number","example":35,"x-mappls-field-path":"result.numberMatched"},"result.numberReturned":{"type":"number","example":1,"x-mappls-field-path":"result.numberReturned"},"result.timestamp":{"type":"string","example":"1700000000000","x-mappls-field-path":"result.timestamp"},"result.links":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"result.links"},"result.links[].title":{"type":"string","example":"next page","x-mappls-field-path":"result.links[].title"},"result.links[].type":{"type":"string","example":"application/json","x-mappls-field-path":"result.links[].type"},"result.links[].rel":{"type":"string","example":"next","x-mappls-field-path":"result.links[].rel"},"result.links[].href":{"type":"string","example":"http://localhost:8081/geoserver/wfs?PROPERTYNAME=st_name&TYPENAME=anjali%3Aindia&REQUEST=GetFeature&OUTPUTFORMAT=application%2Fjson&VERSION=2.0.0&SERVICE=WFS&COUNT=1&ISDENORMALIZED=false&STARTINDEX=1","x-mappls-field-path":"result.links[].href"},"result.crs":{"type":"string","example":"null","x-mappls-field-path":"result.crs"}}},"example":{"code":"200","result":{"type":"FeatureCollection","features":[{"type":"feature","id":"india.1","geometry":"null","properties":{"st_name":"ANDAMAN AND NICOBAR ISLANDS"}}],"totalFeatures":35,"numberMatched":35,"numberReturned":1,"timestamp":"2020-08-10T13:59:51.624Z","links":[{"title":"next page","type":"application/json","rel":"next","href":"http://localhost:8081/geoserver/wfs?PROPERTYNAME=st_name&TYPENAME=anjali%3Aindia&REQUEST=GetFeature&OUTPUTFORMAT=application%2Fjson&VERSION=2.0.0&SERVICE=WFS&COUNT=1&ISDENORMALIZED=false&STARTINDEX=1"}],"crs":"null"}}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Error exception code.","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"error"}}},"example":{"error":"No data found in Database."}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"error"}}},"example":{"error":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/dqv-apis.yml","x-mappls-source-fingerprint":"ec78e94e77644b4d9ff44c58916c40813cc7f96798318569b33204ebd94fba04","x-mappls-evidence-score":43,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-get-getdataset-54829730bd","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/getGeometry":{"get":{"operationId":"mgis-get-getgeometry-returns-the-geometry-of-the-particular-layer-on-the-basis-of-the-featureid-provided-by-the-user","summary":"Returns the geometry of the particular layer on the basis of the featureID provided by the user.","description":"Returns the geometry of the particular layer on the basis of the featureID or filter provided by the user.(Any one of the filter or featureID can be provided)","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-getgeometry-returns-the-geometry-of-the-particular-layer-on-the-basis-of-the-featureid-provided-by-the-user"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"featureID","in":"query","required":false,"description":"feature id of the particular feature of the layer whose geometry is required.","schema":{"type":"string","description":"feature id of the particular feature of the layer whose geometry is required.","example":"india.8"}},{"name":"filter","in":"query","required":false,"description":"query on the basis of which the geometry is required.","schema":{"type":"string","description":"query on the basis of which the geometry is required.","example":"id=368"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"geometry"},"geometry.type":{"type":"string","example":"Multipoint","x-mappls-field-path":"geometry.type"},"geometry.coordinates":{"type":"string","example":"28.612964,77.229463","x-mappls-field-path":"geometry.coordinates"},"geometry.geometry_name":{"type":"string","description":"geometry of the feature attribute.","example":"28.612964,77.229463","x-mappls-field-path":"geometry.geometry_name"},"geometry.properties":{"type":"string","example":{},"x-mappls-field-path":"geometry.properties"}}},"example":{"geometry":{"type":"Multipoint","coordinates":[80.3519,26.4634],"geometry_name":"geom","properties":{}}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"error due to missing param","example":"Mandatory Parameters missing","x-mappls-field-path":"error"}}},"example":{"error":"Mandatory Parameters missing"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/dqv-apis.yml","x-mappls-source-fingerprint":"ec78e94e77644b4d9ff44c58916c40813cc7f96798318569b33204ebd94fba04","x-mappls-evidence-score":13,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-get-getgeometry-810a0cb660","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/query_apply/join":{"post":{"operationId":"mgis-post-query-apply-join-fetches-the-results-of-the-query-applied-between-two-dataset-as-well-as-between-one-datset-and-user-defimed-geometry","summary":"Fetches the results of the query applied between two dataset as well as between one datset and user defimed geometry.","description":"User can performed both the following tasks: Non Spatial Query Spatial Query For spatial query user can perform the query between 2 datasets as well as between one dataset and user defined geometry in geojson format. Whereas Non-Spatial Query is only applicable between 2 datasets.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-query-apply-join-fetches-the-results-of-the-query-applied-between-two-dataset-as-well-as-between-one-datset-and-user-defimed-geometry"},"parameters":[{"name":"queryType","in":"query","required":true,"description":"queryType value can be basic, spatialOperation or functionBased .","schema":{"type":"string","description":"queryType value can be basic, spatialOperation or functionBased .","example":"functionBased"}},{"name":"datasetSource","in":"query","required":true,"description":"Source dataset name. Mandatory both in case of Spatial as well as Non-Spatial Query.","schema":{"type":"string","description":"Source dataset name. Mandatory both in case of Spatial as well as Non-Spatial Query.","example":"geocode_ii"}},{"name":"datasetRef","in":"query","required":false,"description":"Source dataset name. Mandatory both in case of Non-Spatial Query.","schema":{"type":"string","description":"Source dataset name. Mandatory both in case of Non-Spatial Query.","example":"geocode_iii"}},{"name":"operator","in":"query","required":true,"description":"Mandatory both in case of Spatial as well as Non-Spatial Query. Operators allowed for queryType = 'basic' are: =, =, , <>, IN and NOT IN Operators allowed for queryType = 'spatialOperation' are: Intersects, Disjoint, Overlaps, Equals, Touches, DWithin, Within, Contains and Crosses","schema":{"type":"string","description":"Mandatory both in case of Spatial as well as Non-Spatial Query. Operators allowed for queryType = 'basic' are: =, =, , <>, IN and NOT IN Operators allowed for queryType = 'spatialOperation' are: Intersects, Disjoint, Overlaps, Equals, Touches, DWithin, Within, Contains and Crosses","example":"Intersects"}},{"name":"sourceProperty","in":"query","required":true,"description":"Source property attributes to be queried. Mandatory both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Source property attributes to be queried. Mandatory both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"id"}},{"name":"refProperty","in":"query","required":false,"description":"Reference property attributes to be queried. Mandatory in case of Non-Spatial Query.","schema":{"type":"string","description":"Reference property attributes to be queried. Mandatory in case of Non-Spatial Query.","example":"id"}},{"name":"selectionParamSource","in":"query","required":false,"description":"Source property attributes to be reflected in the result. Optional in case of arithmetic operations, Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Source property attributes to be reflected in the result. Optional in case of arithmetic operations, Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"id, lat"}},{"name":"selectionParamRef","in":"query","required":false,"description":"Reference property attributes to be reflected in the result. Optional both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","schema":{"type":"string","description":"Reference property attributes to be reflected in the result. Optional both in case of Spatial(between 2 datasets) as well as Non-Spatial Query.","example":"osm_id, name"}},{"name":"userGeom","in":"query","required":false,"description":"Value of UserGeom will be 'true' if user wants to perform spatial filters with user-defined geometry.","schema":{"type":"string","description":"Value of UserGeom will be 'true' if user wants to perform spatial filters with user-defined geometry.","example":true}},{"name":"distance","in":"query","required":false,"description":"Mandatory in case of operator DWithin, else it is not required.","schema":{"type":"number","description":"Mandatory in case of operator DWithin, else it is not required.","example":10}},{"name":"comparisonFunction","in":"query","required":false,"description":"The functions allowed are: Area, Length and isEmpty . This parameter is mandatory for queryType functionBased.","schema":{"type":"string","description":"The functions allowed are: Area, Length and isEmpty . This parameter is mandatory for queryType functionBased.","example":"Area"}},{"name":"comparisonOperator","in":"query","required":false,"description":"The operators allowed are: =, >, , >= and <=. This parameter is mandatory for queryType functionBased.","schema":{"type":"string","description":"The operators allowed are: =, >, , >= and <=. This parameter is mandatory for queryType functionBased.","example":"="}},{"name":"comparisonValue","in":"query","required":false,"description":"The values allowed are: Numeric (in meters) (for comparisonFunction area and length) Boolean (for comparisonFunction isEmpty) . This parameter is mandatory for queryType functionBased.","schema":{"type":"string","description":"The values allowed are: Numeric (in meters) (for comparisonFunction area and length) Boolean (for comparisonFunction isEmpty) . This parameter is mandatory for queryType functionBased.","example":"100"}},{"name":"saveAsNewDataset","in":"query","required":false,"description":"Boolean if true cross join result will be saved in to db as new table.","schema":{"type":"string","description":"Boolean if true cross join result will be saved in to db as new table.","example":true}},{"name":"newDatasetNme","in":"query","required":false,"description":"Name of new Table(mandatory if saveAsNewDataset = true)","schema":{"type":"string","description":"Name of new Table(mandatory if saveAsNewDataset = true)","example":"JoinTable"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"type":{"type":"string","example":"FeatureCollection","x-mappls-field-path":"type"},"features":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"features"},"features[].type":{"type":"string","example":"Feature","x-mappls-field-path":"features[].type"},"features[].properties":{"type":"object","example":"example","x-mappls-field-path":"features[].properties"},"features[].geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"features[].geometry"},"features[].geometry.type":{"type":"string","example":"Polygon","x-mappls-field-path":"features[].geometry.type"},"features[].geometry.coordinates":{"type":"array","items":{"type":"string"},"example":"28.612964,77.229463","x-mappls-field-path":"features[].geometry.coordinates"}}},"example":{"type":"FeatureCollection","features":[{"type":"Feature","properties":"example","geometry":{"type":"Polygon","coordinates":[]}}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"result":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"result"},"result[].prop1":{"type":"string","description":"Prop1 value","example":"example","x-mappls-field-path":"result[].prop1"},"result[].prop2":{"type":"string","description":"Prop2 value","example":"example","x-mappls-field-path":"result[].prop2"},"result[].prop3":{"type":"string","description":"Prop3 value","example":"example","x-mappls-field-path":"result[].prop3"},"result[].prop4":{"type":"string","description":"Prop4 value","example":"example","x-mappls-field-path":"result[].prop4"},"result[].prop5":{"type":"string","description":"Prop5 value","example":"example","x-mappls-field-path":"result[].prop5"},"result[].prop6":{"type":"string","description":"Prop6 value","example":"example","x-mappls-field-path":"result[].prop6"},"result[].prop7":{"type":"string","description":"Prop7 value","example":"example","x-mappls-field-path":"result[].prop7"},"result[].prop8":{"type":"string","description":"Prop8 value","example":"example","x-mappls-field-path":"result[].prop8"}}},"example":{"code":"200","result":[{"prop1":"example","prop2":"example","prop3":"example","prop4":"example","prop5":"example","prop6":"example","prop7":"example","prop8":"example"}]}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Error exception code.","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"error due to authorization","example":"authorization unsuccesful","x-mappls-field-path":"error"}}},"example":{"error":"authorization unsuccesful"}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"error"}}},"example":{"error":"No data found in Database."}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"method not allowerd, wrong method or invalid parameters","example":"Method not allowed","x-mappls-field-path":"error"}}},"example":{"error":"Method not allowed"}}}},"409":{"description":"Conflict in parameters passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"wrong parameters","example":"wrong parameters","x-mappls-field-path":"error"}}},"example":{"error":"wrong parameters"}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"error"}}},"example":{"error":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/dqv-apis.yml","x-mappls-source-fingerprint":"ec78e94e77644b4d9ff44c58916c40813cc7f96798318569b33204ebd94fba04","x-mappls-evidence-score":53,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-post-query-apply-join-0a448610a0","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/query_apply/single":{"post":{"operationId":"mgis-post-query-apply-single-fetches-the-results-of-the-query-applied-on-the-single-dataset-you-cannot-pass-query-summerizevalue-and-uniquevalue-paramater-together","summary":"Fetches the results of the query applied on the single dataset. You cannot pass query, summerizeValue and uniqueValue paramater together.","description":"You cannot pass query, summerizeValue and uniqueValue paramater together. You can perform 'order(sort) By' and 'groupBy' in 'query'. This has 3 cases: Only Order By Only Group By Both Order By and Group By together You can perform geometric operation (area and length) when queryType = 'functionBased' is passed. The query parameter is an optional paramater in this case. summerizeValue and uniqueValue paramater are not applicable in this case.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-query-apply-single-fetches-the-results-of-the-query-applied-on-the-single-dataset-you-cannot-pass-query-summerizevalue-and-uniquevalue-paramater-together"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"queryType","in":"query","required":false,"description":"queryType value should be functionBased. Mandatory when user has to perform geometric operations with or without query.","schema":{"type":"string","description":"queryType value should be functionBased. Mandatory when user has to perform geometric operations with or without query.","example":"functionBased"}},{"name":"query","in":"query","required":false,"description":"Query to be applied on the dataset. Mandatory if uniqueValue, summerizeValue and queryType parameter is not passed. This is an optional paramter when queryType = 'functionBased' is passed.","schema":{"type":"string","description":"Query to be applied on the dataset. Mandatory if uniqueValue, summerizeValue and queryType parameter is not passed. This is an optional paramter when queryType = 'functionBased' is passed.","example":"state = 'Delhi'"}},{"name":"uniqueValue","in":"query","required":false,"description":"Unique values of a attribute of the dataset. Mandatory if query and summerizeValue parameter is not passed.","schema":{"type":"string","description":"Unique values of a attribute of the dataset. Mandatory if query and summerizeValue parameter is not passed.","example":"st_name"}},{"name":"summerizeValue","in":"query","required":false,"description":"Summerize values of a attribute of the dataset. Mandatory if query and uniqueValue parameter is not passed.","schema":{"type":"string","description":"Summerize values of a attribute of the dataset. Mandatory if query and uniqueValue parameter is not passed.","example":"st_name"}},{"name":"groupBy","in":"query","required":false,"description":"Pass ‘true’ to perform groupBy on the datsetNme. Applicable for 'query'. 'propertyName' paramter is mandatory for 'groupBy' parameter.","schema":{"type":"string","description":"Pass ‘true’ to perform groupBy on the datsetNme. Applicable for 'query'. 'propertyName' paramter is mandatory for 'groupBy' parameter.","example":"true"}},{"name":"propertyName","in":"query","required":false,"description":"Pass the column names list which you want to display in the resultant. Optional in case of order(sortBy). Mandatory in case of 'groupBy'.","schema":{"type":"string","description":"Pass the column names list which you want to display in the resultant. Optional in case of order(sortBy). Mandatory in case of 'groupBy'.","example":"street,poi"}},{"name":"sortBy","in":"query","required":false,"description":"Pass ‘A' for ascending and ‘D’ for descending to perform order(sort) By. Applicable for all. Mandatory when order(sort) By is to be performed.","schema":{"type":"string","description":"Pass ‘A' for ascending and ‘D’ for descending to perform order(sort) By. Applicable for all. Mandatory when order(sort) By is to be performed.","example":"A"}},{"name":"sortByProperty","in":"query","required":false,"description":"Pass the column names which the user wants to order(sort) By in the resultant. Applicable for 'query'. Mandatory when order(sort) By is to be performed.","schema":{"type":"string","description":"Pass the column names which the user wants to order(sort) By in the resultant. Applicable for 'query'. Mandatory when order(sort) By is to be performed.","example":"poi,street"}},{"name":"propertyName","in":"query","required":false,"description":"Property attributes to be reflected in the result. If not passed all the columns of the datasetNme will be displayed in the resultant.","schema":{"type":"string","description":"Property attributes to be reflected in the result. If not passed all the columns of the datasetNme will be displayed in the resultant.","example":"housenumber"}},{"name":"comparisonFunction","in":"query","required":false,"description":"The functions allowed are: Area and Length . This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","schema":{"type":"string","description":"The functions allowed are: Area and Length . This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","example":"Area"}},{"name":"comparisonOperator","in":"query","required":false,"description":"The operators allowed are: =, >, , >= and <=. This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","schema":{"type":"string","description":"The operators allowed are: =, >, , >= and <=. This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","example":"="}},{"name":"comparisonValue","in":"query","required":false,"description":"The value should be in numeric (in meters). This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","schema":{"type":"number","description":"The value should be in numeric (in meters). This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased","example":10}},{"name":"saveAsNewDataset","in":"query","required":false,"description":"Pass ‘true’ for the resultant to be saved in to user's workspace as a new table. Applicable for only queryType = 'functionBased","schema":{"type":"string","description":"Pass ‘true’ for the resultant to be saved in to user's workspace as a new table. Applicable for only queryType = 'functionBased","example":"true"}},{"name":"newDatasetNme","in":"query","required":false,"description":"Name of the table in which the resultant has to be stored. This parameter is mandatory if saveAsNewDataset = true. Applicable for only queryType = 'functionBased'","schema":{"type":"string","description":"Name of the table in which the resultant has to be stored. This parameter is mandatory if saveAsNewDataset = true. Applicable for only queryType = 'functionBased'","example":"geotest"}},{"name":"sortBy","in":"query","required":false,"description":"Sort the result in ascending(A) or descending(D) order. Applicable for 'orderBy', 'groupBy', 'uniqueValue' and 'summerizeValue'.","schema":{"type":"string","description":"Sort the result in ascending(A) or descending(D) order. Applicable for 'orderBy', 'groupBy', 'uniqueValue' and 'summerizeValue'.","example":"A"}},{"name":"startIndex","in":"query","required":false,"description":"To set the start index from which the user wants the result to be displayed. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","schema":{"type":"number","description":"To set the start index from which the user wants the result to be displayed. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","example":1}},{"name":"count","in":"query","required":false,"description":"To fix the number of results to be returned. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","schema":{"type":"number","description":"To fix the number of results to be returned. Applicable for 'query', 'uniqueValue' and 'summerizeValue'.","example":3}},{"name":"bbox","in":"query","required":false,"description":"Returns the bounding box of the dataset if set as true.","schema":{"type":"string","description":"Returns the bounding box of the dataset if set as true.","example":"false"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"result":{"type":"object","example":"example","x-mappls-field-path":"result"},"result.type":{"type":"string","example":"FeatureCollection","x-mappls-field-path":"result.type"},"result.features":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"result.features"},"result.features[].type":{"type":"string","example":"Feature","x-mappls-field-path":"result.features[].type"},"result.features[].id":{"type":"string","example":" india.2","x-mappls-field-path":"result.features[].id"},"result.features[].geometry":{"type":"string","example":"28.612964,77.229463","x-mappls-field-path":"result.features[].geometry"},"result.features[].properties":{"type":"object","example":"example","x-mappls-field-path":"result.features[].properties"},"result.features[].properties.st_name":{"type":"string","example":"Andhra Pradesh","x-mappls-field-path":"result.features[].properties.st_name"},"result.totalFeatures":{"type":"number","example":1,"x-mappls-field-path":"result.totalFeatures"},"result.numberMatched":{"type":"number","example":1,"x-mappls-field-path":"result.numberMatched"},"result.numberReturned":{"type":"number","example":1,"x-mappls-field-path":"result.numberReturned"},"result.timestamp":{"type":"string","example":"1700000000000","x-mappls-field-path":"result.timestamp"},"result.crs":{"type":"string","example":"null","x-mappls-field-path":"result.crs"},"layerBounds":{"type":"string","example":"null","x-mappls-field-path":"layerBounds"}}},"example":{"code":"200","result":{"type":"FeatureCollection","features":[{"type":"Feature","id":" india.2","geometry":"null","properties":{"st_name":"Andhra Pradesh"}}],"totalFeatures":1,"numberMatched":1,"numberReturned":1,"timestamp":"2020-08-10T13:59:51.624Z","crs":"null"},"layerBounds":"null"}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Error exception code.","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"error"}}},"example":{"error":"No data found in Database."}}}},"405":{"description":"Method not allowed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"method not allowerd, wrong method or invalid parameters","example":"Method not allowed","x-mappls-field-path":"error"}}},"example":{"error":"Method not allowed"}}}},"409":{"description":"Conflict in parameters passed.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"wrong parameters","example":"wrong parameters","x-mappls-field-path":"error"}}},"example":{"error":"wrong parameters"}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"error"}}},"example":{"error":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/dqv-apis.yml","x-mappls-source-fingerprint":"ec78e94e77644b4d9ff44c58916c40813cc7f96798318569b33204ebd94fba04","x-mappls-evidence-score":53,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-post-query-apply-single-b50343a051","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/query_validation":{"get":{"operationId":"mgis-get-query-validation-validates-the-query-to-be-applied-on-a-dataset","summary":"Validates the query to be applied on a dataset.","description":"Validates the query to be applied on a dataset.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mapmyindia.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-query-validation-validates-the-query-to-be-applied-on-a-dataset"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name of whose information has to be fetched.","schema":{"type":"string","description":"The dataset name of whose information has to be fetched.","example":"india"}},{"name":"query","in":"query","required":true,"description":"Query to be applied on the dataset. Mandatory if uniqueValue and summerizeValue parameter is not passed.","schema":{"type":"string","description":"Query to be applied on the dataset. Mandatory if uniqueValue and summerizeValue parameter is not passed.","example":"state = 'Delhi'"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"message":{"type":"string","description":"Displays the message wheather the query is valid or invalid.","example":"Valid Query","x-mappls-field-path":"message"},"message.type":{"type":"string","example":"FeatureCollection","x-mappls-field-path":"message.type"}}},"example":{"code":"200","message":"Valid Query"}}}},"206":{"description":"Impartial Content.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"number","description":"Error code.","example":206,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Error message.","example":"Invalid UniqueValue.","x-mappls-field-path":"message"}}},"example":{"code":206,"message":"Invalid UniqueValue."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Error exception code.","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Error message.","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"No data found in Database.","x-mappls-field-path":"error"}}},"example":{"error":"No data found in Database."}}}},"422":{"description":"Parameter missing","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"No data found in Database.","example":"Bad request. Username not found.","x-mappls-field-path":"error"}}},"example":{"error":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Internal server error.","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/dqv-apis.yml","x-mappls-source-fingerprint":"ec78e94e77644b4d9ff44c58916c40813cc7f96798318569b33204ebd94fba04","x-mappls-evidence-score":20,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-get-query-validation-29c9255f8f","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/describeDataset":{"get":{"operationId":"mgis-get-describedataset-fetches-the-attribute-names","summary":"fetches the attribute names.","description":"Fetches the attribute names of the dataset except geometry in response.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-describedataset-fetches-the-attribute-names"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"Returns all attribute names except geometry against a dataset.","schema":{"type":"string","description":"Returns all attribute names except geometry against a dataset.","example":"india"}},{"name":"dataStoreName","in":"query","required":false,"description":"Name of the dataStoreName in case of data adaptor.","schema":{"type":"string","description":"Name of the dataStoreName in case of data adaptor.","example":"india"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","x-mappls-field-path":"message"},"data":{"type":"object","example":"example","x-mappls-field-path":"data"},"data.propertyList":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"data.propertyList"},"data.propertyList[].ColumnName":{"type":"string","description":"Name of Column","example":"st_name","x-mappls-field-path":"data.propertyList[].ColumnName"},"data.propertyList[].ColumnType":{"type":"string","description":"Data Type of ColumnName","example":"string","x-mappls-field-path":"data.propertyList[].ColumnType"}}},"example":{"code":"200","success":true,"message":"","data":{"propertyList":[{"ColumnName":"st_name","ColumnType":"string"}]}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Layer not found.","x-mappls-field-path":"message"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"message":"Layer not found.","code":400}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Access defined.","x-mappls-field-path":"message"},"code":{"type":"number","description":"Error code.","example":401,"x-mappls-field-path":"code"}}},"example":{"message":"Access defined.","code":401}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":"500","message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/describe-dataset-api.yml","x-mappls-source-fingerprint":"ea4acadc9a13ed87bdc8f5b4a009cb6eebcc13efc93221a3103ac8f5ea70c9b6","x-mappls-evidence-score":19,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-describedataset-855417da71","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/export_feature":{"get":{"operationId":"mgis-get-export-feature-download-the-dataset-files-in-kml-shp-or-geojson-files-on-server","summary":"Download the dataset files in .kml, .shp or .geojson files on server.","description":"Download the dataset files in .kml, .shp or .geojson files on server.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-export-feature-download-the-dataset-files-in-kml-shp-or-geojson-files-on-server"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"layername","schema":{"type":"string","description":"layername","example":"ind_rails"}},{"name":"fileType","in":"query","required":true,"description":"Type of file you want to Download(.kml, .shp or .geojson).","schema":{"type":"string","description":"Type of file you want to Download(.kml, .shp or .geojson).","example":".kml, .shp or .geojson"}}],"responses":{"200":{"description":"Response when file successfully saved on server.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"integer","example":200,"x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","example":"File downloaded successfully.","x-mappls-field-path":"message"},"download_url":{"type":"string","example":"https://mgis-apiv2.mappls.com/export_data/prj_ID/datasetNme_timestamp.fileType","x-mappls-field-path":"download_url"}}},"example":{"code":200,"success":true,"message":"File downloaded successfully.","download_url":"https://mgis-apiv2.mappls.com/export_data/prj_ID/datasetNme_timestamp.fileType"}}}},"404":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"404","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"No such layer found.","x-mappls-field-path":"message"}}},"example":{"code":"404","message":"No such layer found."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/export-features-apis.yml","x-mappls-source-fingerprint":"0e6609fbac25fedcc94e168c9de96d9398dea70b3fdd3cdeaa12659133fa09ab","x-mappls-evidence-score":10,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-export-feature-835dd26cc7","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/getGeometryType":{"get":{"operationId":"mgis-get-getgeometrytype-fetches-geometry-type-of-datasetnme","summary":"Fetches Geometry type of datasetNme","description":"Fetches Geometry type of datasetNme includes vector and raster both.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-getgeometrytype-fetches-geometry-type-of-datasetnme"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The dataset name whose feature centroid or geometry is required.","schema":{"type":"string","description":"The dataset name whose feature centroid or geometry is required.","example":"india"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","x-mappls-field-path":"message"},"data":{"type":"object","description":"layer's Geometry Type","example":"linestring","x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"","data":"linestring"}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Invalid Authorization.","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Invalid Authorization."}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"404","x-mappls-field-path":"code"},"message":{"type":"string","example":"Bad request. Username not found.","x-mappls-field-path":"message"}}},"example":{"code":"404","message":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":"500","message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/get-geometry-type-api.yml","x-mappls-source-fingerprint":"4c85c54f75f91c3f3353aa5644b077a5c49aa91d6ed3a3d53cedf535fcfc7a54","x-mappls-evidence-score":20,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-getgeometrytype-97af5b353e","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/map/getFeatureInfo":{"get":{"operationId":"mgis-get-map-getfeatureinfo-fetches-the-feature-information","summary":"Fetches the feature information.","description":"Fetches the feature information of the dataset name of a bounding box.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-map-getfeatureinfo-fetches-the-feature-information"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The datasetNme of whose maptiles has to be fetched.","schema":{"type":"string","description":"The datasetNme of whose maptiles has to be fetched.","example":"india"}},{"name":"x","in":"query","required":true,"description":"To pass the x coordinate of the feature.","schema":{"type":"number","description":"To pass the x coordinate of the feature.","example":457}},{"name":"y","in":"query","required":true,"description":"To pass the y coordinate of the feature.","schema":{"type":"number","description":"To pass the y coordinate of the feature.","example":33}},{"name":"height","in":"query","required":true,"description":"To set the height of the maptiles.","schema":{"type":"number","description":"To set the height of the maptiles.","example":256}},{"name":"width","in":"query","required":true,"description":"To set the width of the maptiles.","schema":{"type":"number","description":"To set the width of the maptiles.","example":256}},{"name":"bbox","in":"query","required":true,"description":"Defines the set of substitution values that can be used in SLD variable substitution.","schema":{"type":"string","description":"Defines the set of substitution values that can be used in SLD variable substitution.","example":"7514065.628545968,2504688.542848655,8766409.899970295,3757032.8142729844"}},{"name":"transparent","in":"query","required":false,"description":"To set the transparency of the maptiles.","schema":{"type":"string","description":"To set the transparency of the maptiles.","example":"true"}},{"name":"srs","in":"query","required":false,"description":"To pass the projection of the maptiles.","schema":{"type":"string","description":"To pass the projection of the maptiles.","example":"EPSG:3857"}},{"name":"style","in":"query","required":false,"description":"To pass the style of the maptiles.","schema":{"type":"string","description":"To pass the style of the maptiles.","example":"example"}},{"name":"buffer","in":"query","required":false,"description":"To pass the y coordinate of the feature.","schema":{"type":"number","description":"To pass the y coordinate of the feature.","example":30}},{"name":"cql_filter","in":"query","required":false,"description":"To pass the cqlfilter for fetching the filtered features. This is an optional parameter.","schema":{"type":"string","description":"To pass the cqlfilter for fetching the filtered features. This is an optional parameter.","example":"name = 'India'"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Response code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","x-mappls-field-path":"message"},"data":{"type":"object","example":"example","x-mappls-field-path":"data"},"data.featureInfo":{"type":"object","example":"example","x-mappls-field-path":"data.featureInfo"},"data.featureInfo.st_name":{"example":"Rajasthan","x-mappls-field-path":"data.featureInfo.st_name"}}},"example":{"code":"200","success":true,"message":"","data":{"featureInfo":{"st_name":"Rajasthan"}}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","example":"Invalid Authorization.","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Invalid Authorization."}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"404","x-mappls-field-path":"code"},"message":{"type":"string","example":"Does not exist.","x-mappls-field-path":"message"}}},"example":{"code":"404","message":"Does not exist."}}}},"500":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":"500","message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/layer_visualization.yml","x-mappls-source-fingerprint":"789212df7cef0c3c95f49b37b2ce29dd4e8cedfaa496a797b04008071fc8fa34","x-mappls-evidence-score":32,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-map-getfeatureinfo-6dd132c52b","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/map/getLayerJoin":{"get":{"operationId":"mgis-get-map-getlayerjoin-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-for-spatial-join-between-2-datasets-as-well-as-between-one-dataset-and-userdefined-geometry","summary":"Fetches the maptiles of the dataset name of a bounding box for Spatial Join between 2 datasets as well as between one dataset and userDefined geometry.","description":"Fetches the maptiles of the dataset name of a bounding box for Spatial Join between 2 datasets as well as between one dataset and userDefined geometry.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-map-getlayerjoin-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-for-spatial-join-between-2-datasets-as-well-as-between-one-dataset-and-userdefined-geometry"},"parameters":[{"name":"queryType","in":"query","required":true,"description":"The queryType can be 'basic' or 'spatialOperation'.","schema":{"type":"string","description":"The queryType can be 'basic' or 'spatialOperation'.","example":"basic"}},{"name":"userGeom","in":"query","required":false,"description":"Value of UserGeom will be 'true' if user wants to perform geometric operations with user-defined geometry. It is mandatory in case of queryType 'spatialOperation' for userDefined geometry.","schema":{"type":"string","description":"Value of UserGeom will be 'true' if user wants to perform geometric operations with user-defined geometry. It is mandatory in case of queryType 'spatialOperation' for userDefined geometry.","example":"true"}},{"name":"datasetSource","in":"query","required":true,"description":"The datasetNme of whose maptiles has to be fetched. It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","schema":{"type":"string","description":"The datasetNme of whose maptiles has to be fetched. It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","example":"india"}},{"name":"datasetRef","in":"query","required":false,"description":"The datasetNme of whose maptiles has to be fetched. It is mandatory in case of queryType 'basic' as well as for queryType 'spatialOperation' in case of performing the operation between 2 datsets.","schema":{"type":"string","description":"The datasetNme of whose maptiles has to be fetched. It is mandatory in case of queryType 'basic' as well as for queryType 'spatialOperation' in case of performing the operation between 2 datsets.","example":"geo"}},{"name":"sourceProperty","in":"query","required":false,"description":"Source property on which the user wants to fetch the result. It is mandatory in case of queryType 'basic'","schema":{"type":"string","description":"Source property on which the user wants to fetch the result. It is mandatory in case of queryType 'basic'","example":"id"}},{"name":"refProperty","in":"query","required":false,"description":"Reference property on which the user wants to fetch the result. It is mandatory in case of queryType 'basic'","schema":{"type":"string","description":"Reference property on which the user wants to fetch the result. It is mandatory in case of queryType 'basic'","example":"id"}},{"name":"operator","in":"query","required":true,"description":"Operators acceptable for queryType 'basic' are: =, =, , <>, IN and NOT IN Operators acceptable for queryType 'spatialOperation' are: Intersects, Disjoint, Overlaps, Equals, Touches, DWithin, Within, Contains and Crosses It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","schema":{"type":"string","description":"Operators acceptable for queryType 'basic' are: =, =, , <>, IN and NOT IN Operators acceptable for queryType 'spatialOperation' are: Intersects, Disjoint, Overlaps, Equals, Touches, DWithin, Within, Contains and Crosses It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","example":"="}},{"name":"height","in":"query","required":true,"description":"To set the height of the maptiles. It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","schema":{"type":"number","description":"To set the height of the maptiles. It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","example":256}},{"name":"width","in":"query","required":true,"description":"To set the width of the maptiles. It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","schema":{"type":"number","description":"To set the width of the maptiles. It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","example":256}},{"name":"bbox","in":"query","required":true,"description":"Defines the set of substitution values that can be used in SLD variable substitution. It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","schema":{"type":"string","description":"Defines the set of substitution values that can be used in SLD variable substitution. It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","example":"7514065.628545968,2504688.542848655,8766409.899970295,3757032.8142729844"}},{"name":"access_token","in":"query","required":true,"description":"To authorization token for the API access. It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","schema":{"type":"string","description":"To authorization token for the API access. It is mandatory both in case of queryType 'basic' as well as queryType 'spatialOperation'.","example":"YOUR_ACCESS_TOKEN"}},{"name":"geom","in":"query","required":false,"description":"User defined geometry will be of geoJSON format. It will contain the geometry key-value part of the geojson. The geojson should contain the coordinates in [lon, lat] format . It is mandatory in case of queryType 'spatialOperation' for userDefined geometry.","schema":{"type":"string","description":"User defined geometry will be of geoJSON format. It will contain the geometry key-value part of the geojson. The geojson should contain the coordinates in [lon, lat] format . It is mandatory in case of queryType 'spatialOperation' for userDefined geometry.","example":"{ \"type\": \"Polygon\", \"coordinates\": [[[74.02587890625,21.739091217718574],[77.71728515624999,21.739091217718574],[77.71728515624999,25.20494115356912],[74.02587890625,25.20494115356912],[74.02587890625,21.739091217718574]]]}"}},{"name":"transparent","in":"query","required":false,"description":"To set the transparency of the maptiles.","schema":{"type":"string","description":"To set the transparency of the maptiles.","example":"true"}},{"name":"srs","in":"query","required":false,"description":"To pass the projection of the maptiles.","schema":{"type":"string","description":"To pass the projection of the maptiles.","example":"EPSG:3857"}},{"name":"distance","in":"query","required":false,"description":"Distance is only required when the operator is DWITHIN .","schema":{"type":"number","description":"Distance is only required when the operator is DWITHIN .","example":10}},{"name":"env","in":"query","required":false,"description":"Enables the user to change the styling of the layer.","schema":{"type":"string","description":"Enables the user to change the styling of the layer.","example":"fillcolor:023e8a, fillopacity:2a9d8f, strokecolor:283618,strokewidth:1,labelsize: 18, labelcolor: 772e25"}},{"name":"style","in":"query","required":false,"description":"To pass the style of the maptiles.","schema":{"type":"string","description":"To pass the style of the maptiles.","example":"example"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"example"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","example":"Invalid Authorization.","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Invalid Authorization."}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"404","x-mappls-field-path":"code"},"message":{"type":"string","example":"Does not exist.","x-mappls-field-path":"message"}}},"example":{"code":"404","message":"Does not exist."}}}},"500":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":"500","message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/layer_visualization.yml","x-mappls-source-fingerprint":"789212df7cef0c3c95f49b37b2ce29dd4e8cedfaa496a797b04008071fc8fa34","x-mappls-evidence-score":32,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-map-getlayerjoin-9a1aac1c53","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/map/getMap":{"get":{"operationId":"mgis-get-map-getmap-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box","summary":"Fetches the maptiles of the dataset name of a bounding box.","description":"Fetches the maptiles of the dataset name of a bounding box in response.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-map-getmap-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The datasetNme of whose maptiles has to be fetched.","schema":{"type":"string","description":"The datasetNme of whose maptiles has to be fetched.","example":"india"}},{"name":"height","in":"query","required":true,"description":"To set the height of the maptiles.","schema":{"type":"number","description":"To set the height of the maptiles.","example":256}},{"name":"width","in":"query","required":true,"description":"To set the width of the maptiles.","schema":{"type":"number","description":"To set the width of the maptiles.","example":256}},{"name":"bbox","in":"query","required":true,"description":"Defines the set of substitution values that can be used in SLD variable substitution.","schema":{"type":"string","description":"Defines the set of substitution values that can be used in SLD variable substitution.","example":"7514065.628545968,2504688.542848655,8766409.899970295,3757032.8142729844"}},{"name":"access_token","in":"query","required":true,"description":"To authorization token for the API access. It is mandatory both in case of user-defined geometry as well as for the published dataset.","schema":{"type":"string","description":"To authorization token for the API access. It is mandatory both in case of user-defined geometry as well as for the published dataset.","example":"YOUR_ACCESS_TOKEN"}},{"name":"queryType","in":"query","required":false,"description":"queryType value should be 'functionBased'. Mandatory when user has to perform geometric operations with or without 'cqlfilter'.","schema":{"type":"string","description":"queryType value should be 'functionBased'. Mandatory when user has to perform geometric operations with or without 'cqlfilter'.","example":"functionBased"}},{"name":"comparisonFunction","in":"query","required":false,"description":"The functions allowed are: Area and Length . This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased'.","schema":{"type":"string","description":"The functions allowed are: Area and Length . This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased'.","example":"Area"}},{"name":"comparisonOperator","in":"query","required":false,"description":"The operators allowed are: =, >, , >= and <=. This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased'.","schema":{"type":"string","description":"The operators allowed are: =, >, , >= and <=. This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased'.","example":"="}},{"name":"comparisonValue","in":"query","required":false,"description":"The value should be in numeric (in meters). This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased'.","schema":{"type":"number","description":"The value should be in numeric (in meters). This parameter is mandatory for queryType functionBased. Applicable for only queryType = 'functionBased'.","example":10}},{"name":"transparent","in":"query","required":false,"description":"To set the transparency of the maptiles.","schema":{"type":"string","description":"To set the transparency of the maptiles.","example":"true"}},{"name":"env","in":"query","required":false,"description":"Enables the user to change the styling of the layer.","schema":{"type":"string","description":"Enables the user to change the styling of the layer.","example":"fillcolor:023e8a, fillopacity:2a9d8f, strokecolor:283618,strokewidth:1,labelsize: 18, labelcolor: 772e25"}},{"name":"cql_filter","in":"query","required":false,"description":"To pass the cqlfilter for fetching the filtered maptiles. This is an optional paramter when queryType = 'functionBased' is passed.","schema":{"type":"string","description":"To pass the cqlfilter for fetching the filtered maptiles. This is an optional paramter when queryType = 'functionBased' is passed.","example":"name = 'India'"}},{"name":"srs","in":"query","required":false,"description":"To pass the projection of the maptiles.","schema":{"type":"string","description":"To pass the projection of the maptiles.","example":"EPSG:3857"}},{"name":"style","in":"query","required":false,"description":"To pass the style of the maptiles.","schema":{"type":"string","description":"To pass the style of the maptiles.","example":"example"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{},"example":"example"}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Invalid Parameter value","x-mappls-field-path":"error"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Layer not found.","x-mappls-field-path":"message"},"auth":{"type":"string","example":"unsuccessful","x-mappls-field-path":"auth"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Invalid Parameter value","message":"Layer not found.","auth":"unsuccessful","code":400}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","example":"Invalid Authorization.","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Invalid Authorization."}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"404","x-mappls-field-path":"code"},"message":{"type":"string","example":"Does not exist.","x-mappls-field-path":"message"}}},"example":{"code":"404","message":"Does not exist."}}}},"500":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":"500","message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/layer_visualization.yml","x-mappls-source-fingerprint":"789212df7cef0c3c95f49b37b2ce29dd4e8cedfaa496a797b04008071fc8fa34","x-mappls-evidence-score":29,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-map-getmap-ee5f026cd2","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/getLayersList":{"get":{"operationId":"mgis-get-getlayerslist-fetches-the-names-of-all-the-datasets-available-in-the-user-s-workspace-on-the-geoserver","summary":"Fetches the names of all the datasets available in the user's workspace on the geoserver.","description":"Fetches the names of all the datasets available in the user's workspace on the geoserver.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-getlayerslist-fetches-the-names-of-all-the-datasets-available-in-the-user-s-workspace-on-the-geoserver"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","description":"Make connection with database with valid credentials.","x-mappls-field-path":"message"},"data":{"example":{"layername":"geocode_ii","geometrytype":"POLYGON","source":"example"},"x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"","data":{"layername":"geocode_ii","geometrytype":"POLYGON","source":"example"}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"404","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Bad request. Username not found.","x-mappls-field-path":"error"}}},"example":{"code":"404","error":"Bad request. Username not found."}}}},"404":{"description":"No data found in database.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"404","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Bad request. Username not found.","x-mappls-field-path":"error"}}},"example":{"code":"404","error":"Bad request. Username not found."}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/get-layer-list-legends-apis.yml","x-mappls-source-fingerprint":"cc9f61d938cafd0f18558bd2ec18e73b5293bb526b53a74b2d6e6373f0d087bf","x-mappls-evidence-score":14,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-getlayerslist-7a2d5959c7","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/getLegendsImg":{"get":{"operationId":"mgis-get-getlegendsimg-fetches-the-image-of-legends-for-the-given-dataset","summary":"Fetches the image of legends for the given dataset.","description":"Fetches the image of legends for the given dataset.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-get-getlegendsimg-fetches-the-image-of-legends-for-the-given-dataset"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"geoserver layername","schema":{"type":"string","description":"geoserver layername","example":"ind_rails"}},{"name":"stylename","in":"query","required":false,"description":"Any available styles for layer.","schema":{"type":"string","description":"Any available styles for layer.","example":"line"}},{"name":"polygonfillcolor","in":"query","required":false,"description":"Any color hex code.","schema":{"type":"string","description":"Any color hex code.","example":"ffffff"}},{"name":"polygonfillopacity","in":"query","required":false,"description":"value between 0-1.","schema":{"type":"string","description":"value between 0-1.","example":0.5}},{"name":"linestrokecolor","in":"query","required":false,"description":"Any color hex code.","schema":{"type":"string","description":"Any color hex code.","example":"ffffff"}},{"name":"linestrokewidth","in":"query","required":false,"description":"with value.","schema":{"type":"string","description":"with value.","example":10}},{"name":"linestrokeopacity","in":"query","required":false,"description":"value between 0-1.","schema":{"type":"string","description":"value between 0-1.","example":0.2}},{"name":"pointfillcolor","in":"query","required":false,"description":"Any color hex code.","schema":{"type":"string","description":"Any color hex code.","example":"ffffff"}},{"name":"pointfillopacity","in":"query","required":false,"description":"value between 0-1.","schema":{"type":"string","description":"value between 0-1.","example":0.3}},{"name":"pointsize","in":"query","required":false,"description":"size value.","schema":{"type":"string","description":"size value.","example":20}}],"responses":{"200":{"description":"Legend image in PNG format","content":{"application/json":{"schema":{},"example":"Image"}}},"500":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/get-layer-list-legends-apis.yml","x-mappls-source-fingerprint":"cc9f61d938cafd0f18558bd2ec18e73b5293bb526b53a74b2d6e6373f0d087bf","x-mappls-evidence-score":14,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-get-getlegendsimg-eed36ebbd0","x-mappls-generation-count":2,"x-mappls-preferred-generation":true}},"/copy/style":{"post":{"operationId":"mgis-post-copy-style-copy-dataset-on-mgis-engine","summary":"copy dataset on mGIS engine","description":"Creates a copy of an existing dataset and takes input of the dataset in the form of geojson and other parameters to create/publish dataset on mGIS engine, so that it can be used for manipulation/analysis/visualization on mGIS platform","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-copy-style-copy-dataset-on-mgis-engine"},"parameters":[{"name":"oldDatasetNme","in":"query","required":true,"description":"old dataset Name.","schema":{"type":"string","description":"old dataset Name.","example":"example"}},{"name":"newDatasetNme","in":"query","required":true,"description":"new dataset Name.","schema":{"type":"string","description":"new dataset Name.","example":"example"}},{"name":"propertyNames","in":"query","required":false,"description":"Names of columns that are required in the copy dataset.","schema":{"type":"string","description":"Names of columns that are required in the copy dataset.","example":"district,state,hospital,literacy"}},{"name":"newPropertyList","in":"query","required":false,"description":"Names of new columns that need to be added in the copy dataset.","schema":{"type":"string","description":"Names of new columns that need to be added in the copy dataset.","example":"{\"items\":[{\"propertyName\":\"name1\",\"propertyType\":\"text\"},{\"propertyName\":\"name2\",\"propertyType\":\"text\",\"defaultValue\":\"shsh\"}]}"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the layer has been published/modified previous dataset Name on mGIS platform","example":"Published new DatasetName","x-mappls-field-path":"message"}}},"example":{"message":"Published new DatasetName"}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"error"}}},"example":{"code":400,"error":"Mandatory parameters missing."}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":500,"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/sat-apis.yml","x-mappls-source-fingerprint":"15348c512128c6a43cfaf8fb29f24a78551008d1ee356cb76baa85a2724a65a8","x-mappls-evidence-score":12,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-post-copy-style-7b168c99ed","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/deleteFeature":{"delete":{"operationId":"mgis-delete-deletefeature-deletes-the-feature-from-the-featurelist","summary":"Deletes the feature from the featureList.","description":"Deletes the feature from the featureList on the basis of the filter value or the featureID value provided by the user.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-delete-deletefeature-deletes-the-feature-from-the-featurelist"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"dataset name","schema":{"type":"string","description":"dataset name","example":"a01072020"}},{"name":"filter","in":"query","required":false,"description":"filter value","schema":{"type":"string","description":"filter value","example":"id=34801"}},{"name":"featureID","in":"query","required":false,"description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","schema":{"type":"string","description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","example":"a01072020.55,a01072020.60,a01072020.57"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":200,"x-mappls-field-path":"code"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the columns specified by the user in the updatedValues have been updated.","example":"Feature deleted.","x-mappls-field-path":"message"}}},"example":{"code":200,"message":"Feature deleted."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"error"}}},"example":{"code":400,"error":"Mandatory parameters missing."}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":500,"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"retire","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/sat-apis.yml","x-mappls-source-fingerprint":"15348c512128c6a43cfaf8fb29f24a78551008d1ee356cb76baa85a2724a65a8","x-mappls-evidence-score":12,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-delete-deletefeature-d40a668d91","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/rename/style":{"post":{"operationId":"mgis-post-rename-style-rename-an-existing-dataset-on-mgis-engine","summary":"Rename an existing dataset on mGIS engine","description":"Renames an existing dataset and takes input of the dataset in the form of geojson and other parameters to create/publish dataset on mGIS engine, so that it can be used for manipulation/analysis/visualization on mGIS platform","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-rename-style-rename-an-existing-dataset-on-mgis-engine"},"parameters":[{"name":"oldDatasetNme","in":"query","required":true,"description":"old dataset Name.","schema":{"type":"string","description":"old dataset Name.","example":"example"}},{"name":"newDatasetNme","in":"query","required":true,"description":"new dataset Name.","schema":{"type":"string","description":"new dataset Name.","example":"example"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the layer has been published/modified with new Dataset Name on mGIS platform","example":"New Layer has been successfuly renamed with new style name.","x-mappls-field-path":"message"}}},"example":{"message":"New Layer has been successfuly renamed with new style name."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"error"}}},"example":{"code":400,"error":"Mandatory parameters missing."}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":500,"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/sat-apis.yml","x-mappls-source-fingerprint":"15348c512128c6a43cfaf8fb29f24a78551008d1ee356cb76baa85a2724a65a8","x-mappls-evidence-score":10,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-post-rename-style-059297d641","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/sat/copy/style":{"post":{"operationId":"mgis-post-sat-copy-style-duplicate-dataset-within-mgis-engine","summary":"Duplicate dataset within mGIS engine.","description":"Produces a duplicate of an established dataset and accepts input in the form of geojson and additional parameters to generate/publish it on the mGIS engine, enabling its application for manipulation, analysis, and visualization within the mGIS platform.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-sat-copy-style-duplicate-dataset-within-mgis-engine"},"parameters":[{"name":"oldDatasetNme","in":"query","required":true,"description":"old dataset Name.","schema":{"type":"string","description":"old dataset Name.","example":"example"}},{"name":"newDatasetNme","in":"query","required":true,"description":"new dataset Name.","schema":{"type":"string","description":"new dataset Name.","example":"example"}},{"name":"propertyNames","in":"query","required":false,"description":"Names of columns that are required in the copy dataset.","schema":{"type":"string","description":"Names of columns that are required in the copy dataset.","example":"district,state,hospital,literacy"}},{"name":"newPropertyList","in":"query","required":false,"description":"Names of new columns that need to be added in the copy dataset.","schema":{"type":"string","description":"Names of new columns that need to be added in the copy dataset.","example":"{\"items\":[{\"propertyName\":\"name1\",\"propertyType\":\"text\"},{\"propertyName\":\"name2\",\"propertyType\":\"text\",\"defaultValue\":\"shsh\"}]}"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the layer has been published/modified previous dataset Name on mGIS platform","example":"Published new DatasetName","x-mappls-field-path":"message"},"data":{"example":{},"x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"Published new DatasetName","data":{}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"message"}}},"example":{"code":400,"message":"Mandatory parameters missing."}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Authorization Unsuccessful","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Authorization Unsuccessful"}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/sat-apis.yml","x-mappls-source-fingerprint":"a2a4cba3e839f88138a9856683d09a09e1ca7a5a9f0ab93785da7b28f3ba215e","x-mappls-evidence-score":18,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-post-sat-copy-style-68356d18b8","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/sat/deleteFeature":{"delete":{"operationId":"mgis-delete-sat-deletefeature-deletes-the-feature-from-the-featurelist","summary":"Deletes the feature from the featureList.","description":"Deletes the feature from the featureList on the basis of the filter value or the featureID value provided by the user.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-delete-sat-deletefeature-deletes-the-feature-from-the-featurelist"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The name of the datasetNme that user wants to delete.","schema":{"type":"string","description":"The name of the datasetNme that user wants to delete.","example":"a01072020"}},{"name":"filter","in":"query","required":false,"description":"The unique filter condition specifically used to selectively include or exclude items from a set or dataset.","schema":{"type":"string","description":"The unique filter condition specifically used to selectively include or exclude items from a set or dataset.","example":"id=34801"}},{"name":"featureID","in":"query","required":false,"description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","schema":{"type":"string","description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","example":"a01072020.55,a01072020.60,a01072020.57"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the columns specified by the user in the updatedValues have been updated.","example":"Feature deleted.","x-mappls-field-path":"message"},"data":{"example":{},"x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"Feature deleted.","data":{}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"message"}}},"example":{"code":400,"message":"Mandatory parameters missing."}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Authorization Unsuccessful","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Authorization Unsuccessful"}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"retire","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/sat-apis.yml","x-mappls-source-fingerprint":"a2a4cba3e839f88138a9856683d09a09e1ca7a5a9f0ab93785da7b28f3ba215e","x-mappls-evidence-score":17,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-delete-sat-deletefeature-664040f8a5","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/sat/rename/style":{"post":{"operationId":"mgis-post-sat-rename-style-rename-an-existing-dataset-on-mgis-engine","summary":"Rename an existing dataset on mGIS engine","description":"Changes the name of an existing dataset, and accepts input in the form of geojson and additional parameters to generate/publish it on the mGIS engine. This facilitates its utilization for manipulation, analysis, and visualization within the mGIS platform.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-sat-rename-style-rename-an-existing-dataset-on-mgis-engine"},"parameters":[{"name":"oldDatasetNme","in":"query","required":true,"description":"old dataset Name.","schema":{"type":"string","description":"old dataset Name.","example":"example"}},{"name":"newDatasetNme","in":"query","required":true,"description":"new dataset Name.","schema":{"type":"string","description":"new dataset Name.","example":"example"}},{"name":"styleID","in":"query","required":false,"description":"Style identifier and its corresponding description.","schema":{"type":"string","description":"Style identifier and its corresponding description.","example":"example"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the layer has been published/modified with new Dataset Name on mGIS platform","example":"New Layer has been successfuly renamed with new style name.","x-mappls-field-path":"message"},"data":{"example":{},"x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"New Layer has been successfuly renamed with new style name.","data":{}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"message"}}},"example":{"code":400,"message":"Mandatory parameters missing."}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Authorization Unsuccessful","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Authorization Unsuccessful"}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/sat-apis.yml","x-mappls-source-fingerprint":"a2a4cba3e839f88138a9856683d09a09e1ca7a5a9f0ab93785da7b28f3ba215e","x-mappls-evidence-score":17,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-post-sat-rename-style-0a77e17789","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/sat/saveDataset/file":{"post":{"operationId":"mgis-post-sat-savedataset-file-uploads-and-publishes-the-dataset-on-mgis-engine","summary":"Uploads and publishes the dataset on mGIS engine","description":"Accepts a dataset in formats like JSON, GeoJSON, CSV, XLSX, KML, ZIP, XLT, TIF, along with additional parameters, to generate/publish it on the mGIS engine. This enables further utilization for manipulation, analysis, and visualization within the mGIS platform.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-sat-savedataset-file-uploads-and-publishes-the-dataset-on-mgis-engine"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"datasetNme":{"type":"string","description":"Name of the dataset that will be used while saving/appending/truncating [If not provided filename is taken as datasetNme]","example":"test","x-mappls-field-path":"datasetNme"},"file":{"type":"string","description":"File that data contains data that needs to be published/appended [max size: 20 MB]","example":"example","x-mappls-field-path":"file"},"sheetName":{"type":"string","description":"Name of the sheet incase the file is one of the spreadsheet formats [If not provided first sheet of the document is taken by default]","example":"example","x-mappls-field-path":"sheetName"},"lat":{"type":"string","description":"Name of the column containing latitude incase the file is one of the spreadsheet formats [If not provided 'Lat' is taken by default]","example":"28.612964","x-mappls-field-path":"lat"},"lng":{"type":"string","description":"Name of the column containing longitude incase the file is one of the spreadsheet formats [If not provided 'Lng' is taken by default]","example":"77.229463","x-mappls-field-path":"lng"},"appendStatus":{"type":"string","description":"If set to true, the file provided will be appended to pre-existing data within the dataset of name provided in datasetNme param [condition is that the data should exist / no need to set it to false in case of non-appending]","example":"example","x-mappls-field-path":"appendStatus"},"truncateStatus":{"type":"string","description":"If set to true, the file provided will be appended and pre-existing data within the dataset of name provided in datasetNme param will be truncated/deleted [condition is that the data provided should be of same structure OR should contain previous structure else there can be loss of information / no need to set it to false]","example":"example","x-mappls-field-path":"truncateStatus"},"polygonfillcolor":{"type":"string","description":"hex color without '#' of the polygon/s","example":"f2e824","x-mappls-field-path":"polygonfillcolor"},"polygonfillopacity":{"type":"string","description":"opacity of polygon/s ranging from 0-1","example":0.7,"x-mappls-field-path":"polygonfillopacity"},"linestrokecolor":{"type":"string","description":"hex color without '#' of the line/s","example":"2ce622","x-mappls-field-path":"linestrokecolor"},"linestrokewidth":{"type":"string","description":"width of the line/s in pixels","example":2,"x-mappls-field-path":"linestrokewidth"},"linestrokeopacity":{"type":"string","description":"opacity of line/s ranging from 0-1","example":0.5,"x-mappls-field-path":"linestrokeopacity"},"pointfillcolor":{"type":"string","description":"hex color without '#' of the point/s","example":"2266e3","x-mappls-field-path":"pointfillcolor"},"pointfillopacity":{"type":"string","description":"opacity of point/s ranging from 0-1","example":0.8,"x-mappls-field-path":"pointfillopacity"},"pointsize":{"type":"string","description":"size of point/s in pixels","example":10,"x-mappls-field-path":"pointsize"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the layer has been published/modified on mGIS platform","example":"Layer 'LAYER_NAME' has been published/modified in workspace 'WORKSPACE_NAME'","x-mappls-field-path":"message"},"data":{"example":{},"x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"Layer 'LAYER_NAME' has been published/modified in workspace 'WORKSPACE_NAME'","data":{}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"message"}}},"example":{"code":400,"message":"Mandatory parameters missing."}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Authorization Unsuccessful","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Authorization Unsuccessful"}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/sat-apis.yml","x-mappls-source-fingerprint":"a2a4cba3e839f88138a9856683d09a09e1ca7a5a9f0ab93785da7b28f3ba215e","x-mappls-evidence-score":29,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-post-sat-savedataset-file-25b107f9a6","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/sat/saveDataset/object":{"post":{"operationId":"mgis-post-sat-savedataset-object-transfers-and-deploys-the-dataset-onto-the-mgis-engine","summary":"Transfers and deploys the dataset onto the mGIS engine.","description":"Accepts a dataset in geojson format along with specified parameters to generate/publish it on the mGIS engine, enabling further manipulation, analysis, and visualization within the mGIS platform.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-sat-savedataset-object-transfers-and-deploys-the-dataset-onto-the-mgis-engine"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"datasetNme":{"type":"string","description":"Name of the dataset that will be used while saving/appending/truncating","example":"test","x-mappls-field-path":"datasetNme"},"geoJSON":{"type":"string","description":"String representation of GEOJSON object that you want to save as a dataset","example":"{ \"type\": \"FeatureCollection\", \"features\": [ { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 80.1727294921875, 27.581329075043357 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 78.848876953125, 26.711266913515747 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 81.309814453125, 26.23430203240673 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 79.1015625, 25.596948323286135 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Polygon\", \"coordinates\": [ [ [ 80.4473876953125, 27.332735136859146 ], [ 79.881591796875, 27.176469131898898 ], [ 79.73876953125, 27.029770731463536 ], [ 79.85412597656249, 26.544308558627424 ], [ 80.1727294921875, 26.249083096330665 ], [ 80.8154296875, 26.80446076654616 ], [ 80.4473876953125, 27.332735136859146 ] ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 76.66259765625, 26.31311263768267 ], [ 77.71728515624999, 25.16517336866393 ], [ 79.1455078125, 24.647017162630366 ], [ 80.771484375, 25.005972656239187 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.7392578125, 27.410785702577023 ], [ 79.43115234375, 29.05616970274342 ], [ 82.24365234375, 29.094577077511826 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 74.77294921875, 21.453068633086783 ], [ 74.72900390625, 22.59372606392931 ], [ 75.1904296875, 22.207749178410847 ], [ 75.849609375, 22.63429269379353 ], [ 75.89355468749999, 21.57571893245848 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.2119140625, 22.79643932091949 ], [ 76.552734375, 22.63429269379353 ], [ 76.31103515625, 22.14670778001263 ], [ 76.37695312499999, 21.57571893245848 ], [ 76.88232421875, 21.43261686447735 ], [ 77.431640625, 21.3303150734318 ], [ 77.431640625, 22.004174972902003 ], [ 76.9482421875, 22.004174972902003 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.80517578125, 22.79643932091949 ], [ 78.92578124999999, 22.87744046489713 ], [ 78.28857421875, 22.79643932091949 ], [ 78.33251953125, 21.759499730719817 ], [ 77.82714843749999, 21.69826549685252 ], [ 78.99169921875, 21.759499730719817 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 80.22216796875, 22.695120184965695 ], [ 79.7607421875, 22.998851594142913 ], [ 79.40917968749999, 22.553147478403194 ], [ 80.0244140625, 22.105998799750566 ], [ 80.15625, 21.657428197370653 ], [ 79.6728515625, 21.4121622297254 ], [ 79.365234375, 21.820707853875017 ] ] } } ] }","x-mappls-field-path":"geoJSON"},"appendStatus":{"type":"string","description":"If set to true, the geoJSON provided will be appended to pre-existing data within the dataset of name provided in datasetNme param [condition is that the data should exist / no need to set it to false in case of non-appending]","example":"example","x-mappls-field-path":"appendStatus"},"truncateStatus":{"type":"string","description":"If set to true, the geoJSON provided will be appended and pre-existing data within the dataset of name provided in datasetNme param will be truncated/deleted [condition is that the data provided should be of same structure OR should contain previous structure else there can be loss of information / no need to set it to false]","example":"example","x-mappls-field-path":"truncateStatus"},"polygonfillcolor":{"type":"string","description":"hex color without '#' of the polygon/s","example":"f2e824","x-mappls-field-path":"polygonfillcolor"},"polygonfillopacity":{"type":"string","description":"opacity of polygon/s ranging from 0-1","example":0.7,"x-mappls-field-path":"polygonfillopacity"},"linestrokecolor":{"type":"string","description":"hex color without '#' of the line/s","example":"2ce622","x-mappls-field-path":"linestrokecolor"},"linestrokewidth":{"type":"string","description":"width of the line/s in pixels","example":2,"x-mappls-field-path":"linestrokewidth"},"linestrokeopacity":{"type":"string","description":"opacity of line/s ranging from 0-1","example":0.5,"x-mappls-field-path":"linestrokeopacity"},"pointfillcolor":{"type":"string","description":"hex color without '#' of the point/s","example":"2266e3","x-mappls-field-path":"pointfillcolor"},"pointfillopacity":{"type":"string","description":"opacity of point/s ranging from 0-1","example":0.8,"x-mappls-field-path":"pointfillopacity"},"pointsize":{"type":"string","description":"size of point/s in pixels","example":10,"x-mappls-field-path":"pointsize"},"featureID":{"type":"string","description":"unique feature id to delete the particular feature id.","example":"india.1","x-mappls-field-path":"featureID"}},"required":["datasetNme","geoJSON"]},"example":{"datasetNme":"test","geoJSON":"{ \"type\": \"FeatureCollection\", \"features\": [ { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 80.1727294921875, 27.581329075043357 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 78.848876953125, 26.711266913515747 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 81.309814453125, 26.23430203240673 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 79.1015625, 25.596948323286135 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Polygon\", \"coordinates\": [ [ [ 80.4473876953125, 27.332735136859146 ], [ 79.881591796875, 27.176469131898898 ], [ 79.73876953125, 27.029770731463536 ], [ 79.85412597656249, 26.544308558627424 ], [ 80.1727294921875, 26.249083096330665 ], [ 80.8154296875, 26.80446076654616 ], [ 80.4473876953125, 27.332735136859146 ] ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 76.66259765625, 26.31311263768267 ], [ 77.71728515624999, 25.16517336866393 ], [ 79.1455078125, 24.647017162630366 ], [ 80.771484375, 25.005972656239187 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.7392578125, 27.410785702577023 ], [ 79.43115234375, 29.05616970274342 ], [ 82.24365234375, 29.094577077511826 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 74.77294921875, 21.453068633086783 ], [ 74.72900390625, 22.59372606392931 ], [ 75.1904296875, 22.207749178410847 ], [ 75.849609375, 22.63429269379353 ], [ 75.89355468749999, 21.57571893245848 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.2119140625, 22.79643932091949 ], [ 76.552734375, 22.63429269379353 ], [ 76.31103515625, 22.14670778001263 ], [ 76.37695312499999, 21.57571893245848 ], [ 76.88232421875, 21.43261686447735 ], [ 77.431640625, 21.3303150734318 ], [ 77.431640625, 22.004174972902003 ], [ 76.9482421875, 22.004174972902003 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.80517578125, 22.79643932091949 ], [ 78.92578124999999, 22.87744046489713 ], [ 78.28857421875, 22.79643932091949 ], [ 78.33251953125, 21.759499730719817 ], [ 77.82714843749999, 21.69826549685252 ], [ 78.99169921875, 21.759499730719817 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 80.22216796875, 22.695120184965695 ], [ 79.7607421875, 22.998851594142913 ], [ 79.40917968749999, 22.553147478403194 ], [ 80.0244140625, 22.105998799750566 ], [ 80.15625, 21.657428197370653 ], [ 79.6728515625, 21.4121622297254 ], [ 79.365234375, 21.820707853875017 ] ] } } ] }"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the layer has been published/modified on mGIS platform","example":"Layer 'LAYER_NAME' has been published/modified in workspace 'WORKSPACE_NAME'","x-mappls-field-path":"message"},"data":{"example":{},"x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"Layer 'LAYER_NAME' has been published/modified in workspace 'WORKSPACE_NAME'","data":{}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"message"}}},"example":{"code":400,"message":"Mandatory parameters missing."}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Authorization Unsuccessful","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Authorization Unsuccessful"}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/sat-apis.yml","x-mappls-source-fingerprint":"a2a4cba3e839f88138a9856683d09a09e1ca7a5a9f0ab93785da7b28f3ba215e","x-mappls-evidence-score":27,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-post-sat-savedataset-object-3ca562f60c","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/sat/saveDataset/subset":{"post":{"operationId":"mgis-post-sat-savedataset-subset-uploads-and-publishes-the-subset-of-datasets-on-mgis-engine","summary":"Uploads and publishes the subset of datasets on mGIS engine","description":"Generates and deploys subsets of existing datasets, filtered by specific conditions (either attribute-based or spatial), for subsequent utilization in manipulation, analysis, and visualization within the mGIS platform.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-sat-savedataset-subset-uploads-and-publishes-the-subset-of-datasets-on-mgis-engine"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"datasetNme":{"type":"string","description":"Name of the parent dataset which will be used to create sub-dataset","example":"example","x-mappls-field-path":"datasetNme"},"newDatasetNme":{"type":"string","description":"Name of the sub-dataset which will be created from parent dataset","example":"example","x-mappls-field-path":"newDatasetNme"},"filter":{"type":"string","description":"WHERE clause which filters the parent dataset","example":"id > 20","x-mappls-field-path":"filter"},"properties":{"type":"string","description":"Comma separated name of the columns that will be used to create sub-dataset [If not provided all the column will be used by default]","example":"column1,column2,column3","x-mappls-field-path":"properties"},"polygonfillcolor":{"type":"string","description":"hex color without '#' of the polygon/s","example":"f2e824","x-mappls-field-path":"polygonfillcolor"},"polygonfillopacity":{"type":"string","description":"opacity of polygon/s ranging from 0-1","example":0.7,"x-mappls-field-path":"polygonfillopacity"},"linestrokecolor":{"type":"string","description":"hex color without '#' of the line/s","example":"2ce622","x-mappls-field-path":"linestrokecolor"},"linestrokewidth":{"type":"string","description":"width of the line/s in pixels","example":2,"x-mappls-field-path":"linestrokewidth"},"linestrokeopacity":{"type":"string","description":"opacity of line/s ranging from 0-1","example":0.5,"x-mappls-field-path":"linestrokeopacity"},"pointfillcolor":{"type":"string","description":"hex color without '#' of the point/s","example":"2266e3","x-mappls-field-path":"pointfillcolor"},"pointfillopacity":{"type":"string","description":"opacity of point/s ranging from 0-1","example":0.8,"x-mappls-field-path":"pointfillopacity"},"pointsize":{"type":"string","description":"size of point/s in pixels","example":10,"x-mappls-field-path":"pointsize"},"layerType":{"type":"string","description":"Type of the layer that can only be 'user' or 'admin'.","example":"user,admin","x-mappls-field-path":"layerType"},"countryNme":{"type":"string","description":"The countryNme parameter to get the data of the specific country datasets(nepal,bhutan)","example":"nepal,bhutan","x-mappls-field-path":"countryNme"}},"required":["datasetNme","newDatasetNme"]},"example":{"datasetNme":"example","newDatasetNme":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the layer has been published on mGIS platform","example":"Subset DATASET_NAME has been published for user USERNAME successfully","x-mappls-field-path":"message"},"data":{"example":{},"x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"Subset DATASET_NAME has been published for user USERNAME successfully","data":{}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"message"}}},"example":{"code":400,"message":"Mandatory parameters missing."}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Authorization Unsuccessful","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Authorization Unsuccessful"}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/sat-apis.yml","x-mappls-source-fingerprint":"a2a4cba3e839f88138a9856683d09a09e1ca7a5a9f0ab93785da7b28f3ba215e","x-mappls-evidence-score":28,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-post-sat-savedataset-subset-c5f14d1641","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/sat/updateFeature":{"post":{"operationId":"mgis-post-sat-updatefeature-modifies-one-or-more-features-with-the-provided-updated-values","summary":"Modifies one or more features with the provided updated values.","description":"This operation involves making changes to individual or multiple features within a dataset by applying updated values. This process allows for the refinement or adjustment of specific attributes or characteristics associated with the geographic elements, ensuring that the dataset accurately reflects the most current information.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-sat-updatefeature-modifies-one-or-more-features-with-the-provided-updated-values"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The name of the datasetNme that user wants to delete.","schema":{"type":"string","description":"The name of the datasetNme that user wants to delete.","example":"a01072020"}},{"name":"updatedValues","in":"query","required":true,"description":"Array of objects containing properties and their values to be updated in a feature (any one filter or featureID or replaceAll must be passed along with updatedValues).","schema":{"type":"string","description":"Array of objects containing properties and their values to be updated in a feature (any one filter or featureID or replaceAll must be passed along with updatedValues).","example":"[{\"propertyName\":\"parentcate\",\"newValue\":\"6\"}]"}},{"name":"filter","in":"query","required":false,"description":"The unique filter condition specifically used to selectively include or exclude items from a set or dataset.","schema":{"type":"string","description":"The unique filter condition specifically used to selectively include or exclude items from a set or dataset.","example":"id=34801"}},{"name":"featureID","in":"query","required":false,"description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","schema":{"type":"string","description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","example":"a01072020.55,a01072020.60,a01072020.57"}},{"name":"replaceAll","in":"query","required":false,"description":"valueless parameter to replace all the features with the updated values provided.No value is required to be passed in replaceAll.","schema":{"type":"string","description":"valueless parameter to replace all the features with the updated values provided.No value is required to be passed in replaceAll.","example":"example"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the columns specified by the user in the updatedValues have been updated.","example":"Columns Updated.","x-mappls-field-path":"message"},"data":{"example":{},"x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"Columns Updated.","data":{}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"message"}}},"example":{"code":400,"message":"Mandatory parameters missing."}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Authorization Unsuccessful","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Authorization Unsuccessful"}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/sat-apis.yml","x-mappls-source-fingerprint":"a2a4cba3e839f88138a9856683d09a09e1ca7a5a9f0ab93785da7b28f3ba215e","x-mappls-evidence-score":19,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-post-sat-updatefeature-c3b4032f26","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/sat/updateGeom":{"post":{"operationId":"mgis-post-sat-updategeom-updates-the-geometry-of-the-feature-on-the-basis-of-the-dataset-name-and-any-one-of-the-filter-or-featureid-provided-by-the-user","summary":"Updates the geometry of the feature on the basis of the dataset name and any one of the filter or featureId provided by the user.","description":"Updates the geometry of the feature on the basis of the dataset name and any one of the filter or featureId provided by the user.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-sat-updategeom-updates-the-geometry-of-the-feature-on-the-basis-of-the-dataset-name-and-any-one-of-the-filter-or-featureid-provided-by-the-user"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"The name of the datasetNme that user wants to delete.","schema":{"type":"string","description":"The name of the datasetNme that user wants to delete.","example":"a01072020"}},{"name":"filter","in":"query","required":false,"description":"The unique filter condition specifically used to selectively include or exclude items from a set or dataset.","schema":{"type":"string","description":"The unique filter condition specifically used to selectively include or exclude items from a set or dataset.","example":"id=34801"}},{"name":"featureID","in":"query","required":false,"description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","schema":{"type":"string","description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","example":"a01072020.55,a01072020.60,a01072020.57"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"geometry"},"geometry.coordinates":{"description":"updated geomtery coordinates. Case-1 multipoint {\"geometry\":{\"coordinates\":[500000,54505678]}} Case-2 multipolygon {\"geometry\":{\"coordinates\":[[[76.55555,24.046464],[76.552734,28.844674],[83.056641,28.844674],[83.056641,24.046464],[76.55555,24.046464]]]}} Case-3 multiline {\"geometry\":{\"coordinates\":[[500000,54505678],[0,540000],[5450000,0]]}}","example":"28.612964,77.229463","x-mappls-field-path":"geometry.coordinates"}}},"example":{"geometry":{"coordinates":"example"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that geometry updated on mGIS platform","example":"Geometry Updated","x-mappls-field-path":"message"},"data":{"example":{},"x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"Geometry Updated","data":{}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"message"}}},"example":{"code":400,"message":"Mandatory parameters missing."}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Authorization Unsuccessful","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Authorization Unsuccessful"}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/sat-apis.yml","x-mappls-source-fingerprint":"a2a4cba3e839f88138a9856683d09a09e1ca7a5a9f0ab93785da7b28f3ba215e","x-mappls-evidence-score":19,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-post-sat-updategeom-c904383ab9","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/sat/updateStructure":{"post":{"operationId":"mgis-post-sat-updatestructure-add-or-delete-column-in-a-given-dataset-on-mgis-engine","summary":"Add or delete column in a given Dataset on mGIS engine","description":"Performs operation like add and delete for columns on the given dataset table.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-sat-updatestructure-add-or-delete-column-in-a-given-dataset-on-mgis-engine"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"dataset Name.","schema":{"type":"string","description":"dataset Name.","example":"test"}},{"name":"operation","in":"query","required":true,"description":"only two possible operation add or delete.","schema":{"type":"string","description":"only two possible operation add or delete.","example":"add"}},{"name":"updateColumns","in":"query","required":true,"description":"an array of objects which contain column name , its type and default value. example [{\"name\":\"id\",\"type\":\"int\",\"defaultValue\":55}]","schema":{"type":"string","description":"an array of objects which contain column name , its type and default value. example [{\"name\":\"id\",\"type\":\"int\",\"defaultValue\":55}]","example":"[{\"name\":\"id\",\"type\":\"int\",\"defaultValue\":55}]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"200","x-mappls-field-path":"code"},"success":{"type":"string","example":true,"x-mappls-field-path":"success"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that structure updated successfully on mGIS platform","example":"Structure updated successfully","x-mappls-field-path":"message"},"data":{"example":{},"x-mappls-field-path":"data"}}},"example":{"code":"200","success":true,"message":"Structure updated successfully","data":{}}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"message"}}},"example":{"code":400,"message":"Mandatory parameters missing."}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"401","x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Authorization Unsuccessful","x-mappls-field-path":"message"}}},"example":{"code":"401","message":"Authorization Unsuccessful"}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"message":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"message"}}},"example":{"code":500,"message":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/sat-apis.yml","x-mappls-source-fingerprint":"a2a4cba3e839f88138a9856683d09a09e1ca7a5a9f0ab93785da7b28f3ba215e","x-mappls-evidence-score":17,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-post-sat-updatestructure-db18ed4c48","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/saveDataset/file":{"post":{"operationId":"mgis-post-savedataset-file-uploads-and-publishes-the-dataset-on-mgis-engine","summary":"Uploads and publishes the dataset on mGIS engine","description":"Takes input of the dataset in the following format => JSON | json | geojson | GEOJSON | csv | CSV | xlsx | xls | XLSX | XLS | kml | KML | zip | ZIP | xlt | XLT | xlsm | XLSM | xltx | XLTX | TIF | tif along with other parameters to create/publish dataset on mGIS engine, so that it can be used for manipulation/analysis/visualization on mGIS platform","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-savedataset-file-uploads-and-publishes-the-dataset-on-mgis-engine"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"datasetNme":{"type":"string","description":"Name of the dataset that will be used while saving/appending/truncating [If not provided filename is taken as datasetNme]","example":"test","x-mappls-field-path":"datasetNme"},"file":{"type":"string","description":"File that data contains data that needs to be published/appended [max size: 20 MB]","example":"example","x-mappls-field-path":"file"},"sheetName":{"type":"string","description":"Name of the sheet incase the file is one of the spreadsheet formats [If not provided first sheet of the document is taken by default]","example":"example","x-mappls-field-path":"sheetName"},"lat":{"type":"string","description":"Name of the column containing latitude incase the file is one of the spreadsheet formats [If not provided 'Lat' is taken by default]","example":"28.612964","x-mappls-field-path":"lat"},"lng":{"type":"string","description":"Name of the column containing longitude incase the file is one of the spreadsheet formats [If not provided 'Lng' is taken by default]","example":"77.229463","x-mappls-field-path":"lng"},"appendStatus":{"type":"string","description":"If set to true, the file provided will be appended to pre-existing data within the dataset of name provided in datasetNme param [condition is that the data should exist / no need to set it to false in case of non-appending]","example":"example","x-mappls-field-path":"appendStatus"},"truncateStatus":{"type":"string","description":"If set to true, the file provided will be appended and pre-existing data within the dataset of name provided in datasetNme param will be truncated/deleted [condition is that the data provided should be of same structure OR should contain previous structure else there can be loss of information / no need to set it to false]","example":"example","x-mappls-field-path":"truncateStatus"},"polygonfillcolor":{"type":"string","description":"hex color without '#' of the polygon/s","example":"f2e824","x-mappls-field-path":"polygonfillcolor"},"polygonfillopacity":{"type":"string","description":"opacity of polygon/s ranging from 0-1","example":0.7,"x-mappls-field-path":"polygonfillopacity"},"linestrokecolor":{"type":"string","description":"hex color without '#' of the line/s","example":"2ce622","x-mappls-field-path":"linestrokecolor"},"linestrokewidth":{"type":"string","description":"width of the line/s in pixels","example":2,"x-mappls-field-path":"linestrokewidth"},"linestrokeopacity":{"type":"string","description":"opacity of line/s ranging from 0-1","example":0.5,"x-mappls-field-path":"linestrokeopacity"},"pointfillcolor":{"type":"string","description":"hex color without '#' of the point/s","example":"2266e3","x-mappls-field-path":"pointfillcolor"},"pointfillopacity":{"type":"string","description":"opacity of point/s ranging from 0-1","example":0.8,"x-mappls-field-path":"pointfillopacity"},"pointsize":{"type":"string","description":"size of point/s in pixels","example":10,"x-mappls-field-path":"pointsize"}},"required":["file"]},"example":{"file":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the layer has been published/modified on mGIS platform","example":"Layer 'LAYER_NAME' has been published/modified in workspace 'WORKSPACE_NAME'","x-mappls-field-path":"message"}}},"example":{"message":"Layer 'LAYER_NAME' has been published/modified in workspace 'WORKSPACE_NAME'"}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"error"}}},"example":{"code":400,"error":"Mandatory parameters missing."}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":500,"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/sat-apis.yml","x-mappls-source-fingerprint":"15348c512128c6a43cfaf8fb29f24a78551008d1ee356cb76baa85a2724a65a8","x-mappls-evidence-score":23,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-post-savedataset-file-1d08b94a01","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/saveDataset/object":{"post":{"operationId":"mgis-post-savedataset-object-uploads-and-publishes-the-dataset-on-mgis-engine","summary":"Uploads and publishes the dataset on mGIS engine","description":"Takes input of the dataset in the form of geojson and other parameters to create/publish dataset on mGIS engine, so that it can be used for manipulation/analysis/visualization on mGIS platform","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-savedataset-object-uploads-and-publishes-the-dataset-on-mgis-engine"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"datasetNme":{"type":"string","description":"Name of the dataset that will be used while saving/appending/truncating","example":"test","x-mappls-field-path":"datasetNme"},"geoJSON":{"type":"string","description":"String representation of GEOJSON object that you want to save as a dataset","example":"{ \"type\": \"FeatureCollection\", \"features\": [ { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 80.1727294921875, 27.581329075043357 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 78.848876953125, 26.711266913515747 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 81.309814453125, 26.23430203240673 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 79.1015625, 25.596948323286135 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Polygon\", \"coordinates\": [ [ [ 80.4473876953125, 27.332735136859146 ], [ 79.881591796875, 27.176469131898898 ], [ 79.73876953125, 27.029770731463536 ], [ 79.85412597656249, 26.544308558627424 ], [ 80.1727294921875, 26.249083096330665 ], [ 80.8154296875, 26.80446076654616 ], [ 80.4473876953125, 27.332735136859146 ] ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 76.66259765625, 26.31311263768267 ], [ 77.71728515624999, 25.16517336866393 ], [ 79.1455078125, 24.647017162630366 ], [ 80.771484375, 25.005972656239187 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.7392578125, 27.410785702577023 ], [ 79.43115234375, 29.05616970274342 ], [ 82.24365234375, 29.094577077511826 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 74.77294921875, 21.453068633086783 ], [ 74.72900390625, 22.59372606392931 ], [ 75.1904296875, 22.207749178410847 ], [ 75.849609375, 22.63429269379353 ], [ 75.89355468749999, 21.57571893245848 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.2119140625, 22.79643932091949 ], [ 76.552734375, 22.63429269379353 ], [ 76.31103515625, 22.14670778001263 ], [ 76.37695312499999, 21.57571893245848 ], [ 76.88232421875, 21.43261686447735 ], [ 77.431640625, 21.3303150734318 ], [ 77.431640625, 22.004174972902003 ], [ 76.9482421875, 22.004174972902003 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.80517578125, 22.79643932091949 ], [ 78.92578124999999, 22.87744046489713 ], [ 78.28857421875, 22.79643932091949 ], [ 78.33251953125, 21.759499730719817 ], [ 77.82714843749999, 21.69826549685252 ], [ 78.99169921875, 21.759499730719817 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 80.22216796875, 22.695120184965695 ], [ 79.7607421875, 22.998851594142913 ], [ 79.40917968749999, 22.553147478403194 ], [ 80.0244140625, 22.105998799750566 ], [ 80.15625, 21.657428197370653 ], [ 79.6728515625, 21.4121622297254 ], [ 79.365234375, 21.820707853875017 ] ] } } ] }","x-mappls-field-path":"geoJSON"},"appendStatus":{"type":"string","description":"If set to true, the geoJSON provided will be appended to pre-existing data within the dataset of name provided in datasetNme param [condition is that the data should exist / no need to set it to false in case of non-appending]","example":"example","x-mappls-field-path":"appendStatus"},"truncateStatus":{"type":"string","description":"If set to true, the geoJSON provided will be appended and pre-existing data within the dataset of name provided in datasetNme param will be truncated/deleted [condition is that the data provided should be of same structure OR should contain previous structure else there can be loss of information / no need to set it to false]","example":"example","x-mappls-field-path":"truncateStatus"},"polygonfillcolor":{"type":"string","description":"hex color without '#' of the polygon/s","example":"f2e824","x-mappls-field-path":"polygonfillcolor"},"polygonfillopacity":{"type":"string","description":"opacity of polygon/s ranging from 0-1","example":0.7,"x-mappls-field-path":"polygonfillopacity"},"linestrokecolor":{"type":"string","description":"hex color without '#' of the line/s","example":"2ce622","x-mappls-field-path":"linestrokecolor"},"linestrokewidth":{"type":"string","description":"width of the line/s in pixels","example":2,"x-mappls-field-path":"linestrokewidth"},"linestrokeopacity":{"type":"string","description":"opacity of line/s ranging from 0-1","example":0.5,"x-mappls-field-path":"linestrokeopacity"},"pointfillcolor":{"type":"string","description":"hex color without '#' of the point/s","example":"2266e3","x-mappls-field-path":"pointfillcolor"},"pointfillopacity":{"type":"string","description":"opacity of point/s ranging from 0-1","example":0.8,"x-mappls-field-path":"pointfillopacity"},"pointsize":{"type":"string","description":"size of point/s in pixels","example":10,"x-mappls-field-path":"pointsize"}},"required":["datasetNme","geoJSON"]},"example":{"datasetNme":"test","geoJSON":"{ \"type\": \"FeatureCollection\", \"features\": [ { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 80.1727294921875, 27.581329075043357 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 78.848876953125, 26.711266913515747 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 81.309814453125, 26.23430203240673 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Point\", \"coordinates\": [ 79.1015625, 25.596948323286135 ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"Polygon\", \"coordinates\": [ [ [ 80.4473876953125, 27.332735136859146 ], [ 79.881591796875, 27.176469131898898 ], [ 79.73876953125, 27.029770731463536 ], [ 79.85412597656249, 26.544308558627424 ], [ 80.1727294921875, 26.249083096330665 ], [ 80.8154296875, 26.80446076654616 ], [ 80.4473876953125, 27.332735136859146 ] ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 76.66259765625, 26.31311263768267 ], [ 77.71728515624999, 25.16517336866393 ], [ 79.1455078125, 24.647017162630366 ], [ 80.771484375, 25.005972656239187 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.7392578125, 27.410785702577023 ], [ 79.43115234375, 29.05616970274342 ], [ 82.24365234375, 29.094577077511826 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 74.77294921875, 21.453068633086783 ], [ 74.72900390625, 22.59372606392931 ], [ 75.1904296875, 22.207749178410847 ], [ 75.849609375, 22.63429269379353 ], [ 75.89355468749999, 21.57571893245848 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.2119140625, 22.79643932091949 ], [ 76.552734375, 22.63429269379353 ], [ 76.31103515625, 22.14670778001263 ], [ 76.37695312499999, 21.57571893245848 ], [ 76.88232421875, 21.43261686447735 ], [ 77.431640625, 21.3303150734318 ], [ 77.431640625, 22.004174972902003 ], [ 76.9482421875, 22.004174972902003 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 77.80517578125, 22.79643932091949 ], [ 78.92578124999999, 22.87744046489713 ], [ 78.28857421875, 22.79643932091949 ], [ 78.33251953125, 21.759499730719817 ], [ 77.82714843749999, 21.69826549685252 ], [ 78.99169921875, 21.759499730719817 ] ] } }, { \"type\": \"Feature\", \"properties\": {}, \"geometry\": { \"type\": \"LineString\", \"coordinates\": [ [ 80.22216796875, 22.695120184965695 ], [ 79.7607421875, 22.998851594142913 ], [ 79.40917968749999, 22.553147478403194 ], [ 80.0244140625, 22.105998799750566 ], [ 80.15625, 21.657428197370653 ], [ 79.6728515625, 21.4121622297254 ], [ 79.365234375, 21.820707853875017 ] ] } } ] }"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the layer has been published/modified on mGIS platform","example":"Layer 'LAYER_NAME' has been published/modified in workspace 'WORKSPACE_NAME'","x-mappls-field-path":"message"}}},"example":{"message":"Layer 'LAYER_NAME' has been published/modified in workspace 'WORKSPACE_NAME'"}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"error"}}},"example":{"code":400,"error":"Mandatory parameters missing."}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":500,"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/sat-apis.yml","x-mappls-source-fingerprint":"15348c512128c6a43cfaf8fb29f24a78551008d1ee356cb76baa85a2724a65a8","x-mappls-evidence-score":20,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-post-savedataset-object-484fad7990","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/saveDataset/subset":{"post":{"operationId":"mgis-post-savedataset-subset-uploads-and-publishes-the-subset-of-datasets-on-mgis-engine","summary":"Uploads and publishes the subset of datasets on mGIS engine","description":"Creates and publishes subset of the existing datasets based on certain conditions (attributes based / spatial) so that the resultant sub-dataset can be used for further manipulation/analysis/visualization on mGIS platform","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-savedataset-subset-uploads-and-publishes-the-subset-of-datasets-on-mgis-engine"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"datasetNme":{"type":"string","description":"Name of the parent dataset which will be used to create sub-dataset","example":"example","x-mappls-field-path":"datasetNme"},"newDatasetNme":{"type":"string","description":"Name of the sub-dataset which will be created from parent dataset","example":"example","x-mappls-field-path":"newDatasetNme"},"filter":{"type":"string","description":"WHERE clause which filters the parent dataset","example":"id > 20","x-mappls-field-path":"filter"},"properties":{"type":"string","description":"Comma separated name of the columns that will be used to create sub-dataset [If not provided all the column will be used by default]","example":"column1,column2,column3","x-mappls-field-path":"properties"},"polygonfillcolor":{"type":"string","description":"hex color without '#' of the polygon/s","example":"f2e824","x-mappls-field-path":"polygonfillcolor"},"polygonfillopacity":{"type":"string","description":"opacity of polygon/s ranging from 0-1","example":0.7,"x-mappls-field-path":"polygonfillopacity"},"linestrokecolor":{"type":"string","description":"hex color without '#' of the line/s","example":"2ce622","x-mappls-field-path":"linestrokecolor"},"linestrokewidth":{"type":"string","description":"width of the line/s in pixels","example":2,"x-mappls-field-path":"linestrokewidth"},"linestrokeopacity":{"type":"string","description":"opacity of line/s ranging from 0-1","example":0.5,"x-mappls-field-path":"linestrokeopacity"},"pointfillcolor":{"type":"string","description":"hex color without '#' of the point/s","example":"2266e3","x-mappls-field-path":"pointfillcolor"},"pointfillopacity":{"type":"string","description":"opacity of point/s ranging from 0-1","example":0.8,"x-mappls-field-path":"pointfillopacity"},"pointsize":{"type":"string","description":"size of point/s in pixels","example":10,"x-mappls-field-path":"pointsize"}},"required":["datasetNme","newDatasetNme"]},"example":{"datasetNme":"example","newDatasetNme":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the layer has been published on mGIS platform","example":"Subset DATASET_NAME has been published for user USERNAME successfully","x-mappls-field-path":"message"}}},"example":{"message":"Subset DATASET_NAME has been published for user USERNAME successfully"}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"error"}}},"example":{"code":400,"error":"Mandatory parameters missing."}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":500,"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/sat-apis.yml","x-mappls-source-fingerprint":"15348c512128c6a43cfaf8fb29f24a78551008d1ee356cb76baa85a2724a65a8","x-mappls-evidence-score":20,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-post-savedataset-subset-ef01d482ce","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/updateFeature":{"post":{"operationId":"mgis-post-updatefeature-updates-a-single-or-multiple-features-with-the-updated-values-provided","summary":"Updates a single or multiple features with the updated values provided.","description":"Updates the a feature or multiple features with the updated values provided.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-updatefeature-updates-a-single-or-multiple-features-with-the-updated-values-provided"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"dataset name","schema":{"type":"string","description":"dataset name","example":"a01072020"}},{"name":"updatedValues","in":"query","required":true,"description":"Array of objects containing properties and their values to be updated in a feature (any one filter or featureID or replaceAll must be passed along with updatedValues).","schema":{"type":"string","description":"Array of objects containing properties and their values to be updated in a feature (any one filter or featureID or replaceAll must be passed along with updatedValues).","example":"[{\"propertyName\":\"parentcate\",\"newValue\":\"6\"}]"}},{"name":"filter","in":"query","required":false,"description":"filter value","schema":{"type":"string","description":"filter value","example":"id=34801"}},{"name":"featureID","in":"query","required":false,"description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","schema":{"type":"string","description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","example":"a01072020.55,a01072020.60,a01072020.57"}},{"name":"replaceAll","in":"query","required":false,"description":"valueless parameter to replace all the features with the updated values provided.No value is required to be passed in replaceAll.","schema":{"type":"string","description":"valueless parameter to replace all the features with the updated values provided.No value is required to be passed in replaceAll.","example":"example"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":200,"x-mappls-field-path":"code"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that the columns specified by the user in the updatedValues have been updated.","example":"Columns Updated.","x-mappls-field-path":"message"}}},"example":{"code":200,"message":"Columns Updated."}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"error"}}},"example":{"code":400,"error":"Mandatory parameters missing."}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":500,"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/sat-apis.yml","x-mappls-source-fingerprint":"15348c512128c6a43cfaf8fb29f24a78551008d1ee356cb76baa85a2724a65a8","x-mappls-evidence-score":14,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-post-updatefeature-cbe90dc227","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/updateGeom":{"post":{"operationId":"mgis-post-updategeom-updates-the-geometry-of-the-feature-on-the-basis-of-the-dataset-name-and-any-one-of-the-filter-or-featureid-provided-by-the-user","summary":"Updates the geometry of the feature on the basis of the dataset name and any one of the filter or featureId provided by the user.","description":"Updates the geometry of the feature on the basis of the dataset name and any one of the filter or featureId provided by the user.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-updategeom-updates-the-geometry-of-the-feature-on-the-basis-of-the-dataset-name-and-any-one-of-the-filter-or-featureid-provided-by-the-user"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"dataset name","schema":{"type":"string","description":"dataset name","example":"a01072020"}},{"name":"filter","in":"query","required":false,"description":"filter value","schema":{"type":"string","description":"filter value","example":"id=34801"}},{"name":"featureID","in":"query","required":false,"description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","schema":{"type":"string","description":"unique feature id to delete the particular feature id. featureID can take input multiple values which should be comma separated.It can delete multiple feature.","example":"a01072020.55,a01072020.60,a01072020.57"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"geometry"},"geometry.coordinates":{"description":"updated geomtery coordinates. Case-1 multipoint {\"geometry\":{\"coordinates\":[500000,54505678]}} Case-2 multipolygon {\"geometry\":{\"coordinates\":[[[76.55555,24.046464],[76.552734,28.844674],[83.056641,28.844674],[83.056641,24.046464],[76.55555,24.046464]]]}} Case-3 multiline {\"geometry\":{\"coordinates\":[[500000,54505678],[0,540000],[5450000,0]]}}","example":"28.612964,77.229463","x-mappls-field-path":"geometry.coordinates"}}},"example":{"geometry":{"coordinates":"example"}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":200,"x-mappls-field-path":"code"},"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that geometry updated on mGIS platform","example":"Geometry Updated","x-mappls-field-path":"message"}}},"example":{"code":200,"message":"Geometry Updated"}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"error"}}},"example":{"code":400,"error":"Mandatory parameters missing."}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":500,"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/sat-apis.yml","x-mappls-source-fingerprint":"15348c512128c6a43cfaf8fb29f24a78551008d1ee356cb76baa85a2724a65a8","x-mappls-evidence-score":14,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-post-updategeom-b721973ace","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/updateStructure":{"post":{"operationId":"mgis-post-updatestructure-add-or-delete-column-in-a-given-dataset-on-mgis-engine","summary":"Add or delete column in a given Dataset on mGIS engine","description":"Performs operation like add and delete for columns on the given dataset table.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-api.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-updatestructure-add-or-delete-column-in-a-given-dataset-on-mgis-engine"},"parameters":[{"name":"datasetNme","in":"query","required":true,"description":"dataset Name.","schema":{"type":"string","description":"dataset Name.","example":"test"}},{"name":"operation","in":"query","required":true,"description":"only two possible operation add or delete.","schema":{"type":"string","description":"only two possible operation add or delete.","example":"add"}},{"name":"updateColumns","in":"query","required":true,"description":"an array of objects which contain column name , its type and default value. example [{\"name\":\"id\",\"type\":\"int\",\"defaultValue\":55}]","schema":{"type":"string","description":"an array of objects which contain column name , its type and default value. example [{\"name\":\"id\",\"type\":\"int\",\"defaultValue\":55}]","example":"[{\"name\":\"id\",\"type\":\"int\",\"defaultValue\":55}]"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"message":{"type":"string","description":"If everything goes ok then user receives a message indicating that structure updated successfully on mGIS platform","example":"Structure updated successfully","x-mappls-field-path":"message"}}},"example":{"message":"Structure updated successfully"}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":400,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory parameters missing.","x-mappls-field-path":"error"}}},"example":{"code":400,"error":"Mandatory parameters missing."}}}},"401":{"description":"Unauthorized, accesscode is not valid for the request","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Authorization Unsuccessful","x-mappls-field-path":"error"}}},"example":{"error":"Authorization Unsuccessful"}}}},"500":{"description":"Internal Server Error, the request caused an error in our systems.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","example":500,"x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":500,"error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/sat-apis.yml","x-mappls-source-fingerprint":"15348c512128c6a43cfaf8fb29f24a78551008d1ee356cb76baa85a2724a65a8","x-mappls-evidence-score":13,"x-mappls-source-generation":"v1","x-mappls-generation-group":"mgis-post-updatestructure-46244ca230","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/ai_ml/imageSegmentation":{"post":{"operationId":"mgis-post-ai-ml-imagesegmentation-returns-the-array-of-features-which-contains-objects-of-geometry-of-the-uploaded-image","summary":"Returns the array of features which contains objects of geometry of the uploaded image.","description":"Fetches the featureList of the uploaded image on the basis of the geotag, featureNme, bounds provided by the user. File, geotag, featureNme are the mandatory parameters.","tags":["mGIS Analytics"],"deprecated":false,"servers":[{"url":"https://mgis-apiv2.mappls.com/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/mgis-post-ai-ml-imagesegmentation-returns-the-array-of-features-which-contains-objects-of-geometry-of-the-uploaded-image"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"file":{"type":"string","description":"Image file in .tiff or .jpg or .png. formats","example":"example","x-mappls-field-path":"file"},"geotag":{"type":"string","description":"Case1 - Will be 0 for .jpeg, .jpg and .png images without bounds and will return geoJson reponse in pixels. Case2- Will be 1 for .tiff and .tif images without bounds and will return geoJson reponse in pixels. Case3-Will be 2 for .jpg, .jpeg and .png images with bounds and returns geoJson response.","example":"example","x-mappls-field-path":"geotag"},"featureNme":{"type":"string","description":"Can be either FP, RD, SOIL, VEG and WATER.","example":"example","x-mappls-field-path":"featureNme"},"bounds":{"type":"object","description":"will be an object containing south-west and north-east corner of the image uploaded. Bounds is mandatory in case when geotag value is 2 and is not required in case when geotag value is 0 and 1.","example":"example","x-mappls-field-path":"bounds"},"imageType":{"type":"string","description":"type of image i.e. google or bhuwan.","example":"example","x-mappls-field-path":"imageType"},"scale":{"type":"integer","description":"integer value which should greater than 0.","example":"1","x-mappls-field-path":"scale"}},"required":["file","geotag","featureNme"]},"example":{"file":"example","geotag":"example","featureNme":"example"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"Features":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"Features"},"Features[].geometry":{"type":"object","example":"28.612964,77.229463","x-mappls-field-path":"Features[].geometry"},"Features[].geometry.coordinates":{"type":"array","items":{"type":"string"},"example":"28.612964,77.229463","x-mappls-field-path":"Features[].geometry.coordinates"}}},"example":{"Features":[{"geometry":{"coordinates":[]}}]}}}},"400":{"description":"Bad Request, User made an error while creating a valid request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Mandatory Parameter Missing","x-mappls-field-path":"error"},"code":{"type":"number","description":"Error code.","example":400,"x-mappls-field-path":"code"}}},"example":{"error":"Mandatory Parameter Missing","code":400}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"code":{"type":"string","description":"Error code.","example":"500","x-mappls-field-path":"code"},"error":{"type":"string","description":"Different error messages that might have occured while making a particular request to the server","example":"Something went wrong.","x-mappls-field-path":"error"}}},"example":{"code":"500","error":"Something went wrong."}}}}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"source-snapshot","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"public-mapmyindia-mgis-apis","x-mappls-source-file":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/imagesegmentation.yml","x-mappls-source-fingerprint":"1d9a9ed6968df6392a22084195c34db67eb5989ac544b44341637caaf4dd2943","x-mappls-evidence-score":16,"x-mappls-source-generation":"v2","x-mappls-generation-group":"mgis-post-ai-ml-imagesegmentation-681344c9ca","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/models":{"get":{"operationId":"skydnn-ai-get-models-returns-the-details-of-all-the-models","summary":"Returns the details of all the models","description":"Image classification and segmentation APIs enable state-of-the-art Computer Vision AI inferences to detect and catgorise objects in the photographs and generate localisation as well as map view of geospatial objects useful for a wide range of geospatial analytics and applications. On a Mission to \"Make our world better through maps, location technologies & IoT\" , Mappls is continuously enabling real time hyper-local information access through its map & location services. Skydnn APIs are a part of Skydnn AI platform and the document describes API's usage and specifications for their integration into any solution. The document covers : List of APIs along with use cases Explanation of resources and query parameters Listing of response structure and data type","tags":["SkyDNN AI & Vision"],"deprecated":false,"servers":[{"url":"https://ai.mappls.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/skydnn-ai-get-models-returns-the-details-of-all-the-models"},"responses":{"200":{"description":"Successful."},"400":{"description":"No current models in port"},"500":{"description":"Internal Error. Exception during processing whoami."}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"current-source","x-mappls-state-model":"hybrid","x-mappls-journey-role":"observe","x-mappls-source-id":"local-aihub-docs-skydnn-aiapi-docs","x-mappls-source-file":"aihub/docs/skydnn-aiapi-docs/docs/swagger/swagger-aimldl-auth-min-v2.yml","x-mappls-source-fingerprint":"e19a9fcee8a760b1e7d50bae49991bafda1928ae51958c4400be4e5010f7c779","x-mappls-evidence-score":3,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"skydnn-ai-get-models-8e291288ae","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/models/{api_model_key}":{"get":{"operationId":"skydnn-ai-get-models-api-model-key-returns-the-details-of-provided-model","summary":"Returns the details of provided model","description":"Image classification and segmentation APIs enable state-of-the-art Computer Vision AI inferences to detect and catgorise objects in the photographs and generate localisation as well as map view of geospatial objects useful for a wide range of geospatial analytics and applications. On a Mission to \"Make our world better through maps, location technologies & IoT\" , Mappls is continuously enabling real time hyper-local information access through its map & location services. Skydnn APIs are a part of Skydnn AI platform and the document describes API's usage and specifications for their integration into any solution. The document covers : List of APIs along with use cases Explanation of resources and query parameters Listing of response structure and data type","tags":["SkyDNN AI & Vision"],"deprecated":false,"servers":[{"url":"https://ai.mappls.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/skydnn-ai-get-models-api-model-key-returns-the-details-of-provided-model"},"parameters":[{"name":"api_model_key","in":"path","required":true,"description":"model key","schema":{"type":"string","description":"model key","example":"vidteq-ods-9"}}],"responses":{"200":{"description":"Successful."},"400":{"description":"No current models in port"},"500":{"description":"Internal Error. Exception during processing whoami."}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"current-source","x-mappls-state-model":"hybrid","x-mappls-journey-role":"observe","x-mappls-source-id":"local-aihub-docs-skydnn-aiapi-docs","x-mappls-source-file":"aihub/docs/skydnn-aiapi-docs/docs/swagger/swagger-aimldl-auth-min-v2.yml","x-mappls-source-fingerprint":"e19a9fcee8a760b1e7d50bae49991bafda1928ae51958c4400be4e5010f7c779","x-mappls-evidence-score":4,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"skydnn-ai-get-models-api-model-key-b008e6d6bb","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/predict":{"post":{"operationId":"skydnn-ai-post-predict-returns-the-prediction-as-response-in-form-of-json","summary":"Returns the prediction as response in form of JSON","description":"Image classification and segmentation APIs enable state-of-the-art Computer Vision AI inferences to detect and catgorise objects in the photographs and generate localisation as well as map view of geospatial objects useful for a wide range of geospatial analytics and applications. On a Mission to \"Make our world better through maps, location technologies & IoT\" , Mappls is continuously enabling real time hyper-local information access through its map & location services. Skydnn APIs are a part of Skydnn AI platform and the document describes API's usage and specifications for their integration into any solution. The document covers : List of APIs along with use cases Explanation of resources and query parameters Listing of response structure and data type","tags":["SkyDNN AI & Vision"],"deprecated":false,"servers":[{"url":"https://ai.mappls.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/skydnn-ai-post-predict-returns-the-prediction-as-response-in-form-of-json"},"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","additionalProperties":true,"properties":{"image":{"type":"string","example":"example","x-mappls-field-path":"image"}}},"example":{"image":"example"}}}},"responses":{"200":{"description":"Successful."},"400":{"description":"Invalid Image Type"},"500":{"description":"Internal Error. Exception in detection"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"current-source","x-mappls-state-model":"hybrid","x-mappls-journey-role":"command","x-mappls-source-id":"local-aihub-docs-skydnn-aiapi-docs","x-mappls-source-file":"aihub/docs/skydnn-aiapi-docs/docs/swagger/swagger-aimldl-auth-min-v2.yml","x-mappls-source-fingerprint":"e19a9fcee8a760b1e7d50bae49991bafda1928ae51958c4400be4e5010f7c779","x-mappls-evidence-score":4,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"skydnn-ai-post-predict-7a0fcb1bbb","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/server/whoami":{"get":{"operationId":"skydnn-ai-get-server-whoami-returns-the-current-models-in-port","summary":"Returns the current models in port","description":"Image classification and segmentation APIs enable state-of-the-art Computer Vision AI inferences to detect and catgorise objects in the photographs and generate localisation as well as map view of geospatial objects useful for a wide range of geospatial analytics and applications. On a Mission to \"Make our world better through maps, location technologies & IoT\" , Mappls is continuously enabling real time hyper-local information access through its map & location services. Skydnn APIs are a part of Skydnn AI platform and the document describes API's usage and specifications for their integration into any solution. The document covers : List of APIs along with use cases Explanation of resources and query parameters Listing of response structure and data type","tags":["SkyDNN AI & Vision"],"deprecated":false,"servers":[{"url":"https://ai.mappls.com"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/skydnn-ai-get-server-whoami-returns-the-current-models-in-port"},"responses":{"200":{"description":"Successful."},"400":{"description":"No current models in port"},"500":{"description":"Internal Error. Exception during processing whoami."}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"bearer","x-mappls-contract-status":"current-source","x-mappls-state-model":"hybrid","x-mappls-journey-role":"observe","x-mappls-source-id":"local-aihub-docs-skydnn-aiapi-docs","x-mappls-source-file":"aihub/docs/skydnn-aiapi-docs/docs/swagger/swagger-aimldl-auth-min-v2.yml","x-mappls-source-fingerprint":"e19a9fcee8a760b1e7d50bae49991bafda1928ae51958c4400be4e5010f7c779","x-mappls-evidence-score":3,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"skydnn-ai-get-server-whoami-4f03367bac","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/clients":{"get":{"operationId":"workmate-get-clients-to-get-all-your-client-details","summary":"To get all your client details","description":"Get all your client details that comes under your organization. Using this API you will be able to identify the client's unique id, name, address,lat, long, and the contact person details. Also, you can get client's department details belong to the client.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-get-clients-to-get-all-your-client-details"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","schema":{"type":"string","description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","example":"v1.0.0"}},{"name":"startTime","in":"query","required":false,"description":"EPOCH time stamp in local time. Records will be fetched from this start time.","schema":{"type":"integer","description":"EPOCH time stamp in local time. Records will be fetched from this start time.","example":"1700000000000"}},{"name":"endTime","in":"query","required":false,"description":"EPOCH time stamp in local time. Records will be fetched till this end time.","schema":{"type":"integer","description":"EPOCH time stamp in local time. Records will be fetched till this end time.","example":"1700000000000"}},{"name":"userId","in":"query","required":false,"description":"Unique ID of the user. Once it is mentioned, only client created by these user will be displayed.","schema":{"type":"integer","description":"Unique ID of the user. Once it is mentioned, only client created by these user will be displayed.","example":"332,4323"}},{"name":"clientId","in":"query","required":false,"description":"Unique ID of the client. To get the details about only the mentioned client.","schema":{"type":"integer","description":"Unique ID of the client. To get the details about only the mentioned client.","example":"YOUR_CLIENT_ID"}}],"responses":{"200":{"description":"successful API call","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"clients":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"clients"},"clients[].id":{"type":"integer","description":"Unique ID of the client or Customer","example":3232,"x-mappls-field-path":"clients[].id"},"clients[].status":{"type":"integer","description":"Client status. 1 - active, 0 - inactive","example":1,"x-mappls-field-path":"clients[].status"},"clients[].name":{"type":"string","description":"Name of the client or customer","example":"ABN pvt.ltd","x-mappls-field-path":"clients[].name"},"clients[].address":{"type":"string","description":"Location address of the client or customer.","example":"237, okhla phase 3, new delhi -110020","x-mappls-field-path":"clients[].address"},"clients[].contactPersonName":{"type":"string","description":"Contact person name of client or customer location","example":"Dinesh","x-mappls-field-path":"clients[].contactPersonName"},"clients[].emailId":{"type":"string","description":"Client or Customer contact email id.","example":"workmate@mapmyindia.com","x-mappls-field-path":"clients[].emailId"},"clients[].mobileNo":{"type":"string","description":"Client or Customer contact mobile number","example":9348332321,"x-mappls-field-path":"clients[].mobileNo"},"clients[].userId":{"type":"integer","description":"The Id of the user who created this client or customer","example":3232,"x-mappls-field-path":"clients[].userId"},"clients[].userName":{"type":"string","description":"Name of the user who has created this client.","example":"kalaivanan","x-mappls-field-path":"clients[].userName"},"clients[].typeId":{"type":"integer","description":"Unqiue ID of the client type/category.","example":0,"x-mappls-field-path":"clients[].typeId"},"clients[].typeName":{"type":"string","description":"Client category/type name","example":"Service stations","x-mappls-field-path":"clients[].typeName"},"clients[].lat":{"type":"number","description":"Latitude of the client location.","example":"28.612964","x-mappls-field-path":"clients[].lat"},"clients[].long":{"type":"number","description":"Longitude of the client location.","example":77.268118,"x-mappls-field-path":"clients[].long"},"clients[].creationTime":{"type":"integer","description":"Client creatation time in Local Epoch Time stamp.","example":"1700000000000","x-mappls-field-path":"clients[].creationTime"},"clients[].updationTime":{"type":"integer","description":"Last updated time against the client in Epoch Time.","example":"1700000000000","x-mappls-field-path":"clients[].updationTime"},"clients[].creationTimeStr":{"type":"string","description":"Client creation time in string format","example":"1700000000000","x-mappls-field-path":"clients[].creationTimeStr"},"clients[].updationTimeStr":{"type":"string","description":"Client updation time in string format","example":"1700000000000","x-mappls-field-path":"clients[].updationTimeStr"},"clients[].viewRight":{"type":"integer","description":"view rights of the client. 0-public , 1-team , 2-manager","example":2,"x-mappls-field-path":"clients[].viewRight"},"clients[].departments":{"type":"array","items":{"type":"object"},"description":"Details of Departments associated with the clients","example":"example","x-mappls-field-path":"clients[].departments"},"clients[].departments[].id":{"type":"string","description":"Unqiue Id of the department","example":32,"x-mappls-field-path":"clients[].departments[].id"},"clients[].departments[].name":{"type":"string","description":"Name of the department","example":"product team","x-mappls-field-path":"clients[].departments[].name"},"clients[].departments[].contactPersonName":{"type":"string","description":"Name of the department contact person","example":"sundaram","x-mappls-field-path":"clients[].departments[].contactPersonName"},"clients[].departments[].mobileNo":{"type":"string","description":"Department cotnact person mobile number","example":9349439334,"x-mappls-field-path":"clients[].departments[].mobileNo"},"clients[].departments[].emailId":{"type":"string","description":"Department cotnact person email Id","example":"sales@mapmyindia.com","x-mappls-field-path":"clients[].departments[].emailId"},"clients[].departments[].creationTime":{"type":"string","description":"Time at which this department is being added. EPoch time.","example":"1700000000000","x-mappls-field-path":"clients[].departments[].creationTime"},"clients[].departments[].updationTime":{"type":"string","description":"Time at which this department is being upated last time. It is in Epoch time.","example":"1700000000000","x-mappls-field-path":"clients[].departments[].updationTime"},"clients[].lastActivity":{"type":"object","example":"example","x-mappls-field-path":"clients[].lastActivity"},"clients[].lastActivity.Status":{"type":"integer","description":"Last activity done by the user. 3- check-in , 4- check out, 5- client created.","example":4,"x-mappls-field-path":"clients[].lastActivity.Status"},"clients[].lastActivity.time":{"type":"integer","description":"Time at which last activity is being carried out in EPOCH Time.","example":"1700000000000","x-mappls-field-path":"clients[].lastActivity.time"},"clients[].lastActivity.Lat":{"type":"number","description":"Last activity location latitude.","example":"28.612964","x-mappls-field-path":"clients[].lastActivity.Lat"},"clients[].lastActivity.Long":{"type":"number","description":"Last activity location Longitude.","example":77.269003,"x-mappls-field-path":"clients[].lastActivity.Long"},"clients[].lastActivity.visitedUserId":{"type":"integer","description":"Unique ID of the user who has done the last activity against this client.","example":3223,"x-mappls-field-path":"clients[].lastActivity.visitedUserId"},"clients[].lastActivity.vistedUserName":{"type":"string","description":"Name of the user who has done the last activity aginst this client.","example":"Megha Soni","x-mappls-field-path":"clients[].lastActivity.vistedUserName"}}},"example":{"clients":[{"id":3232,"status":1,"name":"ABN pvt.ltd","address":"237, okhla phase 3, new delhi -110020","contactPersonName":"Dinesh","emailId":"workmate@mapmyindia.com","mobileNo":9348332321,"userId":3232}]}}}},"204":{"description":"Content not available for the selected period."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"User type is Field user. Only manager and admin type user have the access to this API"},"404":{"description":"Not Found - URL Not Found"},"406":{"description":"userId not belong to your account"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Client-Management.json","x-mappls-source-fingerprint":"61d557dd95d6c5b53e7beff879c160d64a1a449abd0f1a5ed3b76f6e7ff467ce","x-mappls-evidence-score":48,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-get-clients-13667b3461","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"post":{"operationId":"workmate-post-clients-to-create-new-client","summary":"To create new client","description":"Create Client API allows you to add a new client to your organization. Using this API, You can create a new client with a name, address, lat,long, contact details, Department along with their contact details.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-post-clients-to-create-new-client"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","schema":{"type":"string","description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","example":"v1.0.0"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"clientName":{"type":"string","description":"Name of the client or customer location","example":"ABN pvt.ltd","x-mappls-field-path":"clientName"},"address":{"type":"string","description":"Client location address.","example":"237, okhla phase 3, new delhi -110020","x-mappls-field-path":"address"},"contactPersonName":{"type":"string","description":"Clients or customers Contact person name","example":"Dinesh","x-mappls-field-path":"contactPersonName"},"emailId":{"type":"string","description":"Clients or Customers contact email id.","example":"workmate@mapmyindia.com","x-mappls-field-path":"emailId"},"mobileNo":{"type":"string","description":"Client or Customer contact mobile number","example":9348332321,"x-mappls-field-path":"mobileNo"},"typeId":{"type":"integer","description":"Customer or client category based on your compnay details","example":1,"x-mappls-field-path":"typeId"},"lat":{"type":"number","description":"Latitude of the client location.","example":"28.612964","x-mappls-field-path":"lat"},"long":{"type":"number","description":"Longitude of the client location.","example":77.268118,"x-mappls-field-path":"long"},"viewRight":{"type":"integer","description":"Clients view right to the users. 0-public , 1-team , 2-manager","example":2,"x-mappls-field-path":"viewRight"},"departments":{"type":"array","items":{"type":"object"},"description":"Departments details associated with the clients","example":"example","x-mappls-field-path":"departments"},"departments[].name":{"type":"string","description":"Name of the department","example":"product team","x-mappls-field-path":"departments[].name"},"departments[].contactPersonName":{"type":"string","description":"Name of the department contact person","example":"sundaram","x-mappls-field-path":"departments[].contactPersonName"},"departments[].mobileNo":{"type":"string","description":"Department cotnact person mobile number","example":9349439334,"x-mappls-field-path":"departments[].mobileNo"},"departments[].emailId":{"type":"string","description":"Department cotnact person email Id","example":"sales@mapmyindia.com","x-mappls-field-path":"departments[].emailId"}},"required":["clientName"]},"example":{"clientName":"ABN pvt.ltd"}}}},"responses":{"201":{"description":"Client Created","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Unique Id of the client","example":1212,"x-mappls-field-path":"id"}}},"example":{"id":1212}}}},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"The user type is Field user. Only manager and admin type users have the access to this API"},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Client-Management.json","x-mappls-source-fingerprint":"61d557dd95d6c5b53e7beff879c160d64a1a449abd0f1a5ed3b76f6e7ff467ce","x-mappls-evidence-score":23,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-post-clients-a667fb2528","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/configurations/categories":{"get":{"operationId":"workmate-get-configurations-categories-to-get-the-list-of-client-category-in-an-account","summary":"To get the list of client category in an account","description":"It gives all the client categories in an particular account. Category id can be used to create a client.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-get-configurations-categories-to-get-the-list-of-client-category-in-an-account"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","schema":{"type":"string","description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","example":"v1.0.0"}}],"responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"categories":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"categories"},"categories[].categoryId":{"type":"string","description":"Unique Id for the category","example":122,"x-mappls-field-path":"categories[].categoryId"},"categories[].categoryName":{"type":"string","description":"Name of the category","example":"Service Stations","x-mappls-field-path":"categories[].categoryName"}}},"example":{"categories":[{"categoryId":122,"categoryName":"Service Stations"}]}}}},"204":{"description":"Content Not available."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"User type is Field user. Only manager and admin type user have the access to this API"},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Company-Configurations.json","x-mappls-source-fingerprint":"e5d6101b29f0c3ebb3c3191472423b61b80757b15266721c0c72961804669f97","x-mappls-evidence-score":12,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-get-configurations-categories-47ed5af6c2","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/configurations/forms":{"get":{"operationId":"workmate-get-configurations-forms-to-get-the-form-s-id-and-their-details-from-your-account","summary":"To get the form's Id and their details from your account.","description":"It gives all the forms which are created under your account. using this API you can get the unique Ids of different form and it can be used in custom form data API.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-get-configurations-forms-to-get-the-form-s-id-and-their-details-from-your-account"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","schema":{"type":"string","description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","example":"v1.0.0"}}],"responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"forms":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"forms"},"forms[].formId":{"type":"string","description":"Forms unique ID, Which will be used in Custom Forms data API to get the details.","example":"5bb5e97a390bec703259364d","x-mappls-field-path":"forms[].formId"},"forms[].formName":{"type":"string","description":"Name of the Form.","example":"Delivery Details","x-mappls-field-path":"forms[].formName"},"forms[].formDescription":{"type":"string","description":"Detailed description of the Form","example":"Enter the delivery details while doing checkout","x-mappls-field-path":"forms[].formDescription"}}},"example":{"forms":[{"formId":"5bb5e97a390bec703259364d","formName":"Delivery Details","formDescription":"Enter the delivery details while doing checkout"}]}}}},"204":{"description":"Content Not available."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"User type is Field user. Only manager and admin type user have the access to this API"},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Company-Configurations.json","x-mappls-source-fingerprint":"e5d6101b29f0c3ebb3c3191472423b61b80757b15266721c0c72961804669f97","x-mappls-evidence-score":13,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-get-configurations-forms-ab55883c8c","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/reports/attendances":{"get":{"operationId":"workmate-get-reports-attendances-get-users-attendance-details-with-travelled-distance","summary":"Get users attendance details with travelled distance.","description":"These APIs follow OAuth2 based security. To know more about how to create your authorization tokens, please use our authorization token URL. More details available here. The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for an access token using their clientid and clientsecret to the OAuth API. Once validated from the OAuth API, the accesstoken and the tokentype need to be sent as Authorization header with the value: \"{tokentype} {accesstoken}”. Authorization : tokentype accesstoken.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-get-reports-attendances-get-users-attendance-details-with-travelled-distance"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","schema":{"type":"string","description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","example":"v1.0.0"}},{"name":"userId","in":"query","required":false,"schema":{"type":"integer","example":"1"}},{"name":"startTime","in":"query","required":true,"schema":{"type":"integer","example":"1700000000000"}},{"name":"endTime","in":"query","required":true,"schema":{"type":"integer","example":"1700000000000"}}],"responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"attendances":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"attendances"},"attendances[].name":{"type":"string","description":"Name of the user.","example":"Lok Priya","x-mappls-field-path":"attendances[].name"},"attendances[].employeeId":{"type":"string","description":"Id of the employee","example":"ce003232","x-mappls-field-path":"attendances[].employeeId"},"attendances[].branchName":{"type":"string","description":"Employees Branch Name","example":"Bangalore","x-mappls-field-path":"attendances[].branchName"},"attendances[].branchCode":{"type":"string","description":"Employee's Branch Code","example":232,"x-mappls-field-path":"attendances[].branchCode"},"attendances[].userId":{"type":"string","description":"Employee's Branch Code","example":232,"x-mappls-field-path":"attendances[].userId"},"attendances[].workStartTime":{"type":"integer","description":"Time at which work is being started in Epoch Time.","example":"1700000000000","x-mappls-field-path":"attendances[].workStartTime"},"attendances[].workEndTime":{"type":"integer","description":"Time at which work is being started in Epoch Time.","example":"1700000000000","x-mappls-field-path":"attendances[].workEndTime"},"attendances[].workEndRemark":{"type":"string","description":"Remarks entered by the user while concluding the work.","example":"Completed todays work.","x-mappls-field-path":"attendances[].workEndRemark"},"attendances[].workStartRemark":{"type":"string","description":"emarks entered by the user while starting the work.","example":"Starting my work from client location.","x-mappls-field-path":"attendances[].workStartRemark"},"attendances[].workEndAddress":{"type":"string","description":"Location at which work is being concluded","example":"237,okhla phase3, New delhi -110020","x-mappls-field-path":"attendances[].workEndAddress"},"attendances[].workStartAddress":{"type":"string","description":"Location at which work is being concluded","example":"237,okhla phase3, New delhi -110020","x-mappls-field-path":"attendances[].workStartAddress"},"attendances[].workEndLatitude":{"type":"number","description":"Latitude value of Work end location","example":"28.612964","x-mappls-field-path":"attendances[].workEndLatitude"},"attendances[].workEndLongitude":{"type":"number","description":"Longitude value of Work end location","example":"77.229463","x-mappls-field-path":"attendances[].workEndLongitude"},"attendances[].workStartLatitude":{"type":"number","description":"Longitude value of Work Start location","example":"28.612964","x-mappls-field-path":"attendances[].workStartLatitude"},"attendances[].workStartLongitude":{"type":"number","description":"Longitude value of Work Start location","example":"77.229463","x-mappls-field-path":"attendances[].workStartLongitude"},"attendances[].workEndOdometer":{"type":"number","description":"work end Odometer reading.","example":20,"x-mappls-field-path":"attendances[].workEndOdometer"},"attendances[].workStartOdometer":{"type":"number","description":"Work start Odometer reading.","example":10,"x-mappls-field-path":"attendances[].workStartOdometer"},"attendances[].costFactor":{"type":"number","description":"Per km traveled cost. It will be multiplied against distance traveled by the user.","example":3.5,"x-mappls-field-path":"attendances[].costFactor"},"attendances[].distance":{"type":"number","description":"Total travel distance between work start to work end activity. It is calculated based on the location details collected from app","example":26.07931,"x-mappls-field-path":"attendances[].distance"}}},"example":{"attendances":[{"name":"Lok Priya","employeeId":"ce003232","branchName":"Bangalore","branchCode":232,"userId":232,"workStartTime":1573064999,"workEndTime":1573018435,"workEndRemark":"Completed todays work."}]}}}},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"The user type is Field user. Only manager and admin user type user has the access to this API."},"404":{"description":"Not Found - URL Not Found"},"406":{"description":"userId not belong to your account"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Reports.json","x-mappls-source-fingerprint":"901e189918998963dadf539e83def7723571ac3dc1533fe9d89590bac178b33f","x-mappls-evidence-score":32,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-get-reports-attendances-1f97a6a469","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/reports/forms/{formId}":{"get":{"operationId":"workmate-get-reports-forms-formid-to-get-form-based-check-in-out-details","summary":"To get form based check in/out details","description":"Get the complete detail about the check in/check-out activity against the particular form. Get the form Id from the custom form API.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-get-reports-forms-formid-to-get-form-based-check-in-out-details"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","schema":{"type":"string","description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","example":"v1.0.0"}},{"name":"formId","in":"path","required":true,"description":"Unique ID of the Form. It can be fetched from company setting forms API.","schema":{"type":"string","description":"Unique ID of the Form. It can be fetched from company setting forms API.","example":"AD329238910921"}},{"name":"startTime","in":"query","required":true,"description":"Start time of the report. At a time maximum of 31 days can data can be fetched together. Time in epoch time.","schema":{"type":"integer","description":"Start time of the report. At a time maximum of 31 days can data can be fetched together. Time in epoch time.","example":"1700000000000"}},{"name":"endTime","in":"query","required":true,"description":"Start time of the report. At a time maximum of 31 days can data can be fetched together. Time in epoch time.","schema":{"type":"integer","description":"Start time of the report. At a time maximum of 31 days can data can be fetched together. Time in epoch time.","example":"1700000000000"}},{"name":"userId","in":"query","required":false,"description":"Unique ID of the user.","schema":{"type":"number","description":"Unique ID of the user.","example":32323}},{"name":"clientId","in":"query","required":false,"description":"Unique ID of the client.","schema":{"type":"number","description":"Unique ID of the client.","example":"YOUR_CLIENT_ID"}}],"responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"formsData":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"formsData"},"formsData[].employeeName":{"type":"string","description":"Name of the Employee","example":"kalaivanan Sundaram","x-mappls-field-path":"formsData[].employeeName"},"formsData[].employeeId":{"type":"string","description":"Id of the employee","example":"ce12345","x-mappls-field-path":"formsData[].employeeId"},"formsData[].branchName":{"type":"string","description":"Name of the branch","example":"okhla","x-mappls-field-path":"formsData[].branchName"},"formsData[].branchCode":{"type":"string","description":"Code number of the branch","example":3232,"x-mappls-field-path":"formsData[].branchCode"},"formsData[].userId":{"type":"number","description":"Unique id of the workmate user.","example":3232,"x-mappls-field-path":"formsData[].userId"},"formsData[].clientName":{"type":"string","description":"Name of Checked in Client.","example":"Mapmyindia","x-mappls-field-path":"formsData[].clientName"},"formsData[].departmentName":{"type":"string","description":"Name of the Checked in department","example":"product","x-mappls-field-path":"formsData[].departmentName"},"formsData[].contactPersonName":{"type":"string","description":"Either client or department contact person name","example":"sundaram","x-mappls-field-path":"formsData[].contactPersonName"},"formsData[].checkinDateTime":{"type":"string","description":"Date & Time at which user checked in against the client","example":"1700000000000","x-mappls-field-path":"formsData[].checkinDateTime"},"formsData[].checkinAddress":{"type":"string","description":"checked in location address","example":"1134, indira nagar, second stage, Bangalore -560008","x-mappls-field-path":"formsData[].checkinAddress"},"formsData[].checkoutDateTime":{"type":"string","description":"Date & Time at which user checked out against the client","example":"1700000000000","x-mappls-field-path":"formsData[].checkoutDateTime"},"formsData[].checkoutAddress":{"type":"string","description":"checked out location address","example":"1135, indira nagar, second stage, Bangalore -560008","x-mappls-field-path":"formsData[].checkoutAddress"},"formsData[].totalHoursSpent":{"type":"string","description":"Total time spent at the client location. The time differnece between check-in to check out.","example":"00:03:00","x-mappls-field-path":"formsData[].totalHoursSpent"},"formsData[].remarks":{"type":"string","description":"Comments entered by the user during the check-out process.","example":"collected the parcel.","x-mappls-field-path":"formsData[].remarks"},"formsData[].tags":{"type":"string","description":"List of selected tags during check in. It indicates the check in purpose.","example":"Meeting","x-mappls-field-path":"formsData[].tags"},"formsData[].customFormData":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"formsData[].customFormData"},"formsData[].customFormData[].label":{"type":"string","description":"Name of the question or title.","example":"Enter the cash collection details.","x-mappls-field-path":"formsData[].customFormData[].label"},"formsData[].customFormData[].value":{"type":"string","description":"Response to the question (lable)","example":"Rs. 250 is being collected.","x-mappls-field-path":"formsData[].customFormData[].value"},"formsData[].clientEmailId":{"type":"string","description":"Contact person email id of the checked in client or the department","example":"sundaram@gmail.com","x-mappls-field-path":"formsData[].clientEmailId"},"formsData[].clientMobileNo":{"type":"string","description":"Contact person mobile number of the checked in client or department","example":934838232,"x-mappls-field-path":"formsData[].clientMobileNo"}}},"example":{"formsData":[{"employeeName":"kalaivanan Sundaram","employeeId":"ce12345","branchName":"okhla","branchCode":3232,"userId":3232,"clientName":"Mapmyindia","departmentName":"product","contactPersonName":"sundaram"}]}}}},"204":{"description":"Content Not available for the selected period."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"User type is Field user. Only manager and admin type user have the access to this API"},"404":{"description":"Not Found - URL Not Found"},"406":{"description":"userId not belong to your account"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Reports.json","x-mappls-source-fingerprint":"901e189918998963dadf539e83def7723571ac3dc1533fe9d89590bac178b33f","x-mappls-evidence-score":36,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-get-reports-forms-formid-b82d2c7882","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/reports/movements/{userId}":{"get":{"operationId":"workmate-get-reports-movements-userid-get-users-movement-details","summary":"Get users movement details","description":"Get individual users location data which includes address, time, speed, phones's battery level.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-get-reports-movements-userid-get-users-movement-details"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","schema":{"type":"string","description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","example":"v1.0.0"}},{"name":"userId","in":"path","required":true,"description":"Unique ID of the user.","schema":{"type":"number","description":"Unique ID of the user.","example":32323}},{"name":"startTime","in":"query","required":true,"description":"Start time of the report. At a time maximum of 31 days can data can be fetched together. Time in epoch time.","schema":{"type":"integer","description":"Start time of the report. At a time maximum of 31 days can data can be fetched together. Time in epoch time.","example":"1700000000000"}},{"name":"endTime","in":"query","required":true,"description":"Start time of the report. At a time maximum of 31 days can data can be fetched together. Time in epoch time.","schema":{"type":"integer","description":"Start time of the report. At a time maximum of 31 days can data can be fetched together. Time in epoch time.","example":"1700000000000"}}],"responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"movements":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"movements"},"movements[].address":{"type":"string","description":"Users location address for the given time.","example":"40/2, Kalasipalyam, Bengaluru, Karnataka. 18 m from MP Auto Consultancy pin- 560002 (India)","x-mappls-field-path":"movements[].address"},"movements[].distance":{"type":"string","description":"Total traveled distance from start time to this location for the selected period. It is in a kilometer.","example":"10. 00","x-mappls-field-path":"movements[].distance"},"movements[].driftStatus":{"type":"integer","description":"Based on the GPS drift this location data is accepted or rejected will be stated. 1 - accepted, 0 - rejected.","example":1,"x-mappls-field-path":"movements[].driftStatus"},"movements[].heading":{"type":"integer","description":"GPS angle. It gives the direction of the user.","example":234,"x-mappls-field-path":"movements[].heading"},"movements[].lat":{"type":"number","description":"Latitude value of location","example":"28.612964","x-mappls-field-path":"movements[].lat"},"movements[].long":{"type":"number","description":"longitude value of the location.","example":77.843835,"x-mappls-field-path":"movements[].long"},"movements[].speed":{"type":"integer","description":"Speed of user at that time. It is a GPS speed.It is in Km/hr","example":234,"x-mappls-field-path":"movements[].speed"},"movements[].movementStatus":{"type":"string","description":"Stopped or moving status will be there for the user.","example":"stopped","x-mappls-field-path":"movements[].movementStatus"},"movements[].gpsTime":{"type":"integer","description":"GPS time in epochtime stamp. It is the time at which location is being collected from the mobile phone.","example":"1700000000000","x-mappls-field-path":"movements[].gpsTime"},"movements[].insertTime":{"type":"integer","description":"Time at which location packet is being received at the server end. It is normally called as GPRS time. it is in EPOCH time format.","example":"1700000000000","x-mappls-field-path":"movements[].insertTime"},"movements[].internalBatteryLevel":{"type":"integer","description":"Phones battery percentage.","example":24,"x-mappls-field-path":"movements[].internalBatteryLevel"}}},"example":{"movements":[{"address":"40/2, Kalasipalyam, Bengaluru, Karnataka. 18 m from MP Auto Consultancy pin- 560002 (India)","distance":"10. 00","driftStatus":1,"heading":234,"lat":28.550607,"long":77.843835,"speed":234,"movementStatus":"stopped"}]}}}},"204":{"description":"Content Not available for the selected period."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"The user type is Field user. Only manager and admin type user have the access to this API"},"404":{"description":"Not Found - URL Not Found"},"406":{"description":"userId not belong to your account"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Reports.json","x-mappls-source-fingerprint":"901e189918998963dadf539e83def7723571ac3dc1533fe9d89590bac178b33f","x-mappls-evidence-score":25,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-get-reports-movements-userid-a9df3fbbf2","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/taskLists":{"get":{"operationId":"workmate-get-tasklists-to-get-the-task-list-details","summary":"To get the task list details.","description":"These APIs follow OAuth2 based security. To know more about how to create your authorization tokens, please use our authorization token URL. More details available here. The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for an access token using their clientid and clientsecret to the OAuth API. Once validated from the OAuth API, the accesstoken and the tokentype need to be sent as Authorization header with the value: \"{tokentype} {accesstoken}”. Authorization : tokentype accesstoken.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-get-tasklists-to-get-the-task-list-details"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"Header for this API. Available values are v1.0.0, Default value is v1.0.0","schema":{"type":"string","description":"Header for this API. Available values are v1.0.0, Default value is v1.0.0","example":"v1.0.0"}}],"responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"taskLists":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"taskLists"},"taskLists[].id":{"type":"string","description":"Unique Id of the task","example":32,"x-mappls-field-path":"taskLists[].id"},"taskLists[].name":{"type":"string","description":"Name of the task","example":"Document Collection from client","x-mappls-field-path":"taskLists[].name"},"taskLists[].description":{"type":"string","description":"Detailed description of task.","example":"Collect documents like PAN Card, Passport and the application form.","x-mappls-field-path":"taskLists[].description"},"taskLists[].taskListId":{"type":"string","description":"Unique Id number of the task list. It can be used while creating the Task","example":23,"x-mappls-field-path":"taskLists[].taskListId"}}},"example":{"taskLists":[{"id":32,"name":"Document Collection from client","description":"Collect documents like PAN Card, Passport and the application form.","taskListId":23}]}}}},"204":{"description":"Content Not available."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"User type is Field user. Only manager and admin type user have the access to this API"},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Task-Management.json","x-mappls-source-fingerprint":"0e978659200a849331e1bf5dca4d90ff915eb72100ef85155b046cd98b007365","x-mappls-evidence-score":14,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-get-tasklists-28035b4d18","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/tasks":{"get":{"operationId":"workmate-get-tasks-to-get-the-list-of-tasks-and-their-details","summary":"To get the list of tasks and their details","description":"These APIs follow OAuth2 based security. To know more about how to create your authorization tokens, please use our authorization token URL. More details available here. The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for an access token using their clientid and clientsecret to the OAuth API. Once validated from the OAuth API, the accesstoken and the tokentype need to be sent as Authorization header with the value: \"{tokentype} {accesstoken}”. Authorization : tokentype accesstoken.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-get-tasks-to-get-the-list-of-tasks-and-their-details"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"Header for this API. Available values are v1.0.0, Default value is v1.0.0","schema":{"type":"string","description":"Header for this API. Available values are v1.0.0, Default value is v1.0.0","example":"v1.0.0"}},{"name":"startTime","in":"query","required":false,"description":"Enter the start time for the select period. It is in Epoch Time.","schema":{"type":"number","description":"Enter the start time for the select period. It is in Epoch Time.","example":"1700000000000"}},{"name":"endTime","in":"query","required":false,"description":"Enter the end time for the select period. It is in EPOCH Time.","schema":{"type":"number","description":"Enter the end time for the select period. It is in EPOCH Time.","example":"1700000000000"}},{"name":"ownerId","in":"query","required":false,"description":"Unqiue Id of the the user who has created this task.","schema":{"type":"number","description":"Unqiue Id of the the user who has created this task.","example":"1"}},{"name":"assigneeId","in":"query","required":false,"description":"Unique Id of the user who performs this task.","schema":{"type":"number","description":"Unique Id of the user who performs this task.","example":"1"}},{"name":"clientDetails","in":"query","required":false,"description":"To get client location details for the task.","schema":{"type":"boolean","description":"To get client location details for the task.","example":"true"}},{"name":"activityDetails","in":"query","required":false,"description":"To get Activity details against the task.","schema":{"type":"boolean","description":"To get Activity details against the task.","example":"true"}}],"responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"tasks":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"tasks"},"tasks[].id":{"type":"string","description":"Unique Id of the task","example":32,"x-mappls-field-path":"tasks[].id"},"tasks[].name":{"type":"string","description":"Name of the task","example":"Document Collection from client","x-mappls-field-path":"tasks[].name"},"tasks[].description":{"type":"string","description":"Detailed description of task.","example":"Collect documents like PAN Card, Passport and the application form.","x-mappls-field-path":"tasks[].description"},"tasks[].priority":{"type":"number","description":"Task priority . 0 - None, 1- Low, 2 - Medium, 3 - High.","example":1,"x-mappls-field-path":"tasks[].priority"},"tasks[].taskListId":{"type":"string","description":"Unique Id number of the task list","example":23,"x-mappls-field-path":"tasks[].taskListId"},"tasks[].taskListName":{"type":"string","description":"Name of the Task list","example":323,"x-mappls-field-path":"tasks[].taskListName"},"tasks[].ownerId":{"type":"number","description":"Unique user Id of the Task owner. The user who created this task","example":23,"x-mappls-field-path":"tasks[].ownerId"},"tasks[].status":{"type":"string","description":"Indicates the current status of the task like 1- unassigned, 2- assigned, 3- read, 4- work in progress, 5- overdue, 6- completed, 7- completed early, 8- completed later, 9- manually closed.","example":2,"x-mappls-field-path":"tasks[].status"},"tasks[].creationDate":{"type":"number","description":"Date in which the task is created. It is in EPOCH time.","example":1472668079,"x-mappls-field-path":"tasks[].creationDate"},"tasks[].dueDate":{"type":"number","description":"Due date of the task. Task should be completed on or before this date. It is in EPOCH time.","example":1472667900,"x-mappls-field-path":"tasks[].dueDate"},"tasks[].assigneeId":{"type":"number","description":"Unique id of the user who is going to perform this task.","example":148,"x-mappls-field-path":"tasks[].assigneeId"},"tasks[].clientId":{"type":"number","description":"Unique Id of the client. The task should be perfomed at this locaton. It is a Task location.","example":"YOUR_CLIENT_ID","x-mappls-field-path":"tasks[].clientId"},"tasks[].updationDate":{"type":"number","description":"Last activity time against this task.","example":1472742952,"x-mappls-field-path":"tasks[].updationDate"},"tasks[].departmentId":{"type":"number","description":"Unique ID of the Department where task need to be done.","example":"1","x-mappls-field-path":"tasks[].departmentId"},"tasks[].checkinId":{"type":"number","description":"Unique Id of the check in activity against this task","example":323,"x-mappls-field-path":"tasks[].checkinId"},"tasks[].clientName":{"type":"string","description":"Name of the client. The task should be performed at this client lcoation.","example":"Cafe coffee day Indiranagar","x-mappls-field-path":"tasks[].clientName"},"tasks[].departmentName":{"type":"string","description":"Department Name of the client. The task should be perfomed at this client department lcoation.","example":"Sales department","x-mappls-field-path":"tasks[].departmentName"},"tasks[].ownerName":{"type":"string","description":"Name of the task owner.","example":"sandeep kumar","x-mappls-field-path":"tasks[].ownerName"},"tasks[].asigneeName":{"type":"string","description":"Name of the assinee. who is going to perform this task.","example":"lok priya.","x-mappls-field-path":"tasks[].asigneeName"},"tasks[].clientDetails":{"type":"object","example":"example","x-mappls-field-path":"tasks[].clientDetails"},"tasks[].clientDetails.lat":{"type":"number","description":"Latitude value of the task location","example":"28.612964","x-mappls-field-path":"tasks[].clientDetails.lat"},"tasks[].clientDetails.long":{"type":"number","description":"Longitude value of the task location","example":77.392323,"x-mappls-field-path":"tasks[].clientDetails.long"},"tasks[].clientDetails.address":{"type":"string","description":"Task location address","example":"237, okhla phase 3, delhi -110020","x-mappls-field-path":"tasks[].clientDetails.address"},"tasks[].clientDetails.personName":{"type":"string","description":"Either client or department Contact person name","example":"Dinesh","x-mappls-field-path":"tasks[].clientDetails.personName"},"tasks[].clientDetails.emailId":{"type":"string","description":"Either client or department contact person email id.","example":"workmate@mapmyindia.com","x-mappls-field-path":"tasks[].clientDetails.emailId"},"tasks[].clientDetails.mobileNo":{"type":"string","description":"Either client or department contact contact mobile number","example":9348332321,"x-mappls-field-path":"tasks[].clientDetails.mobileNo"},"tasks[].activityDetails":{"type":"object","example":"example","x-mappls-field-path":"tasks[].activityDetails"},"tasks[].activityDetails.checkInDetails":{"type":"object","example":"example","x-mappls-field-path":"tasks[].activityDetails.checkInDetails"},"tasks[].activityDetails.checkInDetails.lat":{"type":"number","description":"Latitude value of the check in location","example":"28.612964","x-mappls-field-path":"tasks[].activityDetails.checkInDetails.lat"},"tasks[].activityDetails.checkInDetails.long":{"type":"number","description":"Longitude value of the check in location","example":77.32823,"x-mappls-field-path":"tasks[].activityDetails.checkInDetails.long"},"tasks[].activityDetails.checkInDetails.address":{"type":"string","description":"Check in location address","example":"236, oklha phase 3 , new delhi - 110020","x-mappls-field-path":"tasks[].activityDetails.checkInDetails.address"},"tasks[].activityDetails.checkInDetails.time":{"type":"number","description":"Check in time, in Epoch Timestamp","example":"1700000000000","x-mappls-field-path":"tasks[].activityDetails.checkInDetails.time"},"tasks[].activityDetails.checkOutDetails":{"type":"object","example":"example","x-mappls-field-path":"tasks[].activityDetails.checkOutDetails"},"tasks[].activityDetails.checkOutDetails.lat":{"type":"number","description":"Latitude value of the check in location","example":"28.612964","x-mappls-field-path":"tasks[].activityDetails.checkOutDetails.lat"},"tasks[].activityDetails.checkOutDetails.long":{"type":"number","description":"Longitude value of the check in location","example":77.32823,"x-mappls-field-path":"tasks[].activityDetails.checkOutDetails.long"},"tasks[].activityDetails.checkOutDetails.address":{"type":"string","description":"Check in location address","example":"236, oklha phase 3 , new delhi - 110020","x-mappls-field-path":"tasks[].activityDetails.checkOutDetails.address"},"tasks[].activityDetails.checkOutDetails.time":{"type":"number","description":"Check in time, in Epoch Timestamp","example":"1700000000000","x-mappls-field-path":"tasks[].activityDetails.checkOutDetails.time"},"tasks[].activityDetails.checkOutDetails.comments":{"type":"string","description":"check out comments","example":"Task is completed","x-mappls-field-path":"tasks[].activityDetails.checkOutDetails.comments"}}},"example":{"tasks":[{"id":32,"name":"Document Collection from client","description":"Collect documents like PAN Card, Passport and the application form.","priority":1,"taskListId":23,"taskListName":323,"ownerId":23,"status":2}]}}}},"204":{"description":"Content Not available for the selected period."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"User type is Field user. Only manager and admin type user have the access to this API"},"404":{"description":"Not Found - URL Not Found"},"406":{"description":"userId does not belong to your account"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Task-Management.json","x-mappls-source-fingerprint":"0e978659200a849331e1bf5dca4d90ff915eb72100ef85155b046cd98b007365","x-mappls-evidence-score":55,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-get-tasks-c1e4e3bb58","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"post":{"operationId":"workmate-post-tasks-to-create-new-task","summary":"To create new Task","description":"Create Task API allows you to assign a new Task to your users. Using this API, You can Assign a new task with a task summary, description, assigned to user, task owner, the priority of the task, task location","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-post-tasks-to-create-new-task"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","schema":{"type":"string","description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","example":"v1.0.0"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","description":"Name of the Task or Task Summary","example":"Collect the cash from customer","x-mappls-field-path":"name"},"description":{"type":"string","description":"Deatailed description for the Task","example":"Collect the cash and give the invoice and update the System","x-mappls-field-path":"description"},"ownerId":{"type":"string","description":"The user who creates the task. Unique id of the user","example":2121,"x-mappls-field-path":"ownerId"},"assigneeId":{"type":"number","description":"Id of the user to whom this task is assinged. Unique id of the user.","example":3232,"x-mappls-field-path":"assigneeId"},"clientId":{"type":"number","description":"Unique id of the client. This is the place user will perform the task.","example":"YOUR_CLIENT_ID","x-mappls-field-path":"clientId"},"prioirity":{"type":"number","description":"priority of the Task. 0 - None, 1 - Low, 2 - Medium, 3- High.","example":1,"x-mappls-field-path":"prioirity"},"taskListId":{"type":"string","description":"Unique Id number of the task list.","example":23,"x-mappls-field-path":"taskListId"}},"required":["name","assigneeId","clientId"]},"example":{"name":"Collect the cash from customer","assigneeId":3232,"clientId":3222}}}},"responses":{"201":{"description":"Task Created","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"number","description":"Unique Id of the Task.","example":12,"x-mappls-field-path":"id"}}},"example":{"id":12}}}},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"User type is Field user. Only manager and admin type user have the access to this API"},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"command","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Task-Management.json","x-mappls-source-fingerprint":"0e978659200a849331e1bf5dca4d90ff915eb72100ef85155b046cd98b007365","x-mappls-evidence-score":16,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-post-tasks-4438d8708d","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/tasks/{taskId}":{"get":{"operationId":"workmate-get-tasks-taskid-to-get-the-task-details-for-the-given-task-id","summary":"To get the task details for the given task id.","description":"These APIs follow OAuth2 based security. To know more about how to create your authorization tokens, please use our authorization token URL. More details available here. The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for an access token using their clientid and clientsecret to the OAuth API. Once validated from the OAuth API, the accesstoken and the tokentype need to be sent as Authorization header with the value: \"{tokentype} {accesstoken}”. Authorization : tokentype accesstoken.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-get-tasks-taskid-to-get-the-task-details-for-the-given-task-id"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"Header for this API. Available values are v1.0.0, Default value is v1.0.0","schema":{"type":"string","description":"Header for this API. Available values are v1.0.0, Default value is v1.0.0","example":"v1.0.0"}},{"name":"taskId","in":"path","required":true,"description":"Unique Id of the task.","schema":{"type":"number","description":"Unique Id of the task.","example":"1"}},{"name":"clientDetails","in":"query","required":false,"description":"To get client location details for the task.","schema":{"type":"boolean","description":"To get client location details for the task.","example":"true"}},{"name":"activityDetails","in":"query","required":false,"description":"To get Activity details against the task.","schema":{"type":"boolean","description":"To get Activity details against the task.","example":"true"}}],"responses":{"200":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"tasks":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"tasks"},"tasks[].id":{"type":"string","description":"Unique Id of the task","example":32,"x-mappls-field-path":"tasks[].id"},"tasks[].name":{"type":"string","description":"Name of the task","example":"Document Collection from client","x-mappls-field-path":"tasks[].name"},"tasks[].description":{"type":"string","description":"Detailed description of task.","example":"Collect documents like PAN Card, Passport and the application form.","x-mappls-field-path":"tasks[].description"},"tasks[].priority":{"type":"number","description":"Task priority . 0 - None, 1- Low, 2 - Medium, 3 - High.","example":1,"x-mappls-field-path":"tasks[].priority"},"tasks[].taskListId":{"type":"string","description":"Unique Id number of the task list","example":23,"x-mappls-field-path":"tasks[].taskListId"},"tasks[].taskListName":{"type":"string","description":"Name of the Task list","example":323,"x-mappls-field-path":"tasks[].taskListName"},"tasks[].ownerId":{"type":"number","description":"Unique user Id of the Task owner. The user who created this task","example":23,"x-mappls-field-path":"tasks[].ownerId"},"tasks[].status":{"type":"string","description":"Indicates the current status of the task like 1- unassigned, 2- assigned, 3- read, 4- work in progress, 5- overdue, 6- completed, 7- completed early, 8- completed later, 9- manually closed.","example":2,"x-mappls-field-path":"tasks[].status"},"tasks[].creationDate":{"type":"number","description":"Date in which the task is created. It is in EPOCH time.","example":1472668079,"x-mappls-field-path":"tasks[].creationDate"},"tasks[].dueDate":{"type":"number","description":"Due date of the task. Task should be completed on or before this date. It is in EPOCH time.","example":1472667900,"x-mappls-field-path":"tasks[].dueDate"},"tasks[].assigneeId":{"type":"number","description":"Unique id of the user who is going to perform this task.","example":148,"x-mappls-field-path":"tasks[].assigneeId"},"tasks[].clientId":{"type":"number","description":"Unique Id of the client. The task should be perfomed at this locaton. It is a Task location.","example":"YOUR_CLIENT_ID","x-mappls-field-path":"tasks[].clientId"},"tasks[].updationDate":{"type":"number","description":"Last activity time against this task.","example":1472742952,"x-mappls-field-path":"tasks[].updationDate"},"tasks[].departmentId":{"type":"number","description":"Unique ID of the Department where task need to be done.","example":"1","x-mappls-field-path":"tasks[].departmentId"},"tasks[].checkinId":{"type":"number","description":"Unique Id of the check in activity against this task","example":323,"x-mappls-field-path":"tasks[].checkinId"},"tasks[].clientName":{"type":"string","description":"Name of the client. The task should be performed at this client lcoation.","example":"Cafe coffee day Indiranagar","x-mappls-field-path":"tasks[].clientName"},"tasks[].departmentName":{"type":"string","description":"Department Name of the client. The task should be perfomed at this client department lcoation.","example":"Sales department","x-mappls-field-path":"tasks[].departmentName"},"tasks[].ownerName":{"type":"string","description":"Name of the task owner.","example":"sandeep kumar","x-mappls-field-path":"tasks[].ownerName"},"tasks[].asigneeName":{"type":"string","description":"Name of the assinee. who is going to perform this task.","example":"lok priya.","x-mappls-field-path":"tasks[].asigneeName"},"tasks[].clientDetails":{"type":"object","example":"example","x-mappls-field-path":"tasks[].clientDetails"},"tasks[].clientDetails.lat":{"type":"number","description":"Latitude value of the task location","example":"28.612964","x-mappls-field-path":"tasks[].clientDetails.lat"},"tasks[].clientDetails.long":{"type":"number","description":"Longitude value of the task location","example":77.392323,"x-mappls-field-path":"tasks[].clientDetails.long"},"tasks[].clientDetails.address":{"type":"string","description":"Task location address","example":"237, okhla phase 3, delhi -110020","x-mappls-field-path":"tasks[].clientDetails.address"},"tasks[].clientDetails.personName":{"type":"string","description":"Either client or department Contact person name","example":"Dinesh","x-mappls-field-path":"tasks[].clientDetails.personName"},"tasks[].clientDetails.emailId":{"type":"string","description":"Either client or department contact person email id.","example":"workmate@mapmyindia.com","x-mappls-field-path":"tasks[].clientDetails.emailId"},"tasks[].clientDetails.mobileNo":{"type":"string","description":"Either client or department contact contact mobile number","example":9348332321,"x-mappls-field-path":"tasks[].clientDetails.mobileNo"},"tasks[].activityDetails":{"type":"object","example":"example","x-mappls-field-path":"tasks[].activityDetails"},"tasks[].activityDetails.checkInDetails":{"type":"object","example":"example","x-mappls-field-path":"tasks[].activityDetails.checkInDetails"},"tasks[].activityDetails.checkInDetails.lat":{"type":"number","description":"Latitude value of the check in location","example":"28.612964","x-mappls-field-path":"tasks[].activityDetails.checkInDetails.lat"},"tasks[].activityDetails.checkInDetails.long":{"type":"number","description":"Longitude value of the check in location","example":77.32823,"x-mappls-field-path":"tasks[].activityDetails.checkInDetails.long"},"tasks[].activityDetails.checkInDetails.address":{"type":"string","description":"Check in location address","example":"236, oklha phase 3 , new delhi - 110020","x-mappls-field-path":"tasks[].activityDetails.checkInDetails.address"},"tasks[].activityDetails.checkInDetails.time":{"type":"number","description":"Check in time, in Epoch Timestamp","example":"1700000000000","x-mappls-field-path":"tasks[].activityDetails.checkInDetails.time"},"tasks[].activityDetails.checkOutDetails":{"type":"object","example":"example","x-mappls-field-path":"tasks[].activityDetails.checkOutDetails"},"tasks[].activityDetails.checkOutDetails.lat":{"type":"number","description":"Latitude value of the check in location","example":"28.612964","x-mappls-field-path":"tasks[].activityDetails.checkOutDetails.lat"},"tasks[].activityDetails.checkOutDetails.long":{"type":"number","description":"Longitude value of the check in location","example":77.32823,"x-mappls-field-path":"tasks[].activityDetails.checkOutDetails.long"},"tasks[].activityDetails.checkOutDetails.address":{"type":"string","description":"Check in location address","example":"236, oklha phase 3 , new delhi - 110020","x-mappls-field-path":"tasks[].activityDetails.checkOutDetails.address"},"tasks[].activityDetails.checkOutDetails.time":{"type":"number","description":"Check in time, in Epoch Timestamp","example":"1700000000000","x-mappls-field-path":"tasks[].activityDetails.checkOutDetails.time"},"tasks[].activityDetails.checkOutDetails.comments":{"type":"string","description":"check out comments","example":"Task is completed","x-mappls-field-path":"tasks[].activityDetails.checkOutDetails.comments"}}},"example":{"tasks":[{"id":32,"name":"Document Collection from client","description":"Collect documents like PAN Card, Passport and the application form.","priority":1,"taskListId":23,"taskListName":323,"ownerId":23,"status":2}]}}}},"204":{"description":"Content Not available for the selected Task Id."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"User type is Field user. Only manager and admin type user have the access to this API"},"404":{"description":"Not Found - URL Not Found"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Task-Management.json","x-mappls-source-fingerprint":"0e978659200a849331e1bf5dca4d90ff915eb72100ef85155b046cd98b007365","x-mappls-evidence-score":51,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-get-tasks-taskid-dffa1e0229","x-mappls-generation-count":1,"x-mappls-preferred-generation":true},"put":{"operationId":"workmate-put-tasks-taskid-to-update-the-task-description-status","summary":"To update the task description & status.","description":"These APIs follow OAuth2 based security. To know more about how to create your authorization tokens, please use our authorization token URL. More details available here. The API leverages OAuth 2.0 based security. Hence, the developer would need to send a request for an access token using their clientid and clientsecret to the OAuth API. Once validated from the OAuth API, the accesstoken and the tokentype need to be sent as Authorization header with the value: \"{tokentype} {accesstoken}”. Authorization : tokentype accesstoken.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-put-tasks-taskid-to-update-the-task-description-status"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"Header for this API. Available values are v1.0.0, Default value is v1.0.0","schema":{"type":"string","description":"Header for this API. Available values are v1.0.0, Default value is v1.0.0","example":"v1.0.0"}},{"name":"taskId","in":"path","required":true,"description":"Unique Id of the task.","schema":{"type":"number","description":"Unique Id of the task.","example":"1"}},{"name":"status","in":"query","required":false,"description":"To close the task manually send the value as 9.","schema":{"type":"number","description":"To close the task manually send the value as 9.","example":"1"}},{"name":"description","in":"query","required":false,"description":"Task description","schema":{"type":"string","description":"Task description","example":"example"}}],"responses":{"200":{"description":"Task updated successfully"},"204":{"description":"Invalid Task Id."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"User type is Field user. Only manager and admin type user have the access to this API"},"404":{"description":"Not Found - URL Not Found"},"406":{"description":"Criteria is not met. Not able to update the status beacuse of current status."}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"transition","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/Task-Management.json","x-mappls-source-fingerprint":"0e978659200a849331e1bf5dca4d90ff915eb72100ef85155b046cd98b007365","x-mappls-evidence-score":13,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-put-tasks-taskid-085976cb20","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}},"/users":{"get":{"operationId":"workmate-get-users-to-get-all-the-user-details-which-belongs-to-your-organization","summary":"To get all the user details which belongs to your organization.","description":"Gives all the users details of your organization. Using this API, you will be able to identify the workmate user id, workplace location, employee Id and other important details related to a user profile. You can only get the list of users who belongs to your organization.","tags":["Workmate Workforce"],"deprecated":false,"servers":[{"url":"https://workmate.mapmyindia.com/apis/"}],"externalDocs":{"description":"Human-readable Mappls contract","url":"https://developer.mappls.com/api-reference/workmate-get-users-to-get-all-the-user-details-which-belongs-to-your-organization"},"parameters":[{"name":"apiVersion","in":"header","required":true,"description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","schema":{"type":"string","description":"API version should be mentioned in the header along with bearer Token. Available version is v1.0.0, Default version is v1.0.0","example":"v1.0.0"}},{"name":"workPlace","in":"query","required":false,"description":"Send true if you want to get the work place location details","schema":{"type":"boolean","description":"Send true if you want to get the work place location details","example":"true"}},{"name":"userId","in":"query","required":false,"description":"send the user Ids in comma separated format to get the list of selected user details. If it is not passed all the user details will be fetched.","schema":{"type":"number","description":"send the user Ids in comma separated format to get the list of selected user details. If it is not passed all the user details will be fetched.","example":"3223,23"}}],"responses":{"200":{"description":"API call is succesful","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"users":{"type":"array","items":{"type":"object"},"example":"example","x-mappls-field-path":"users"},"users[].id":{"type":"integer","description":"Unqiue workmate Id of the user","example":232,"x-mappls-field-path":"users[].id"},"users[].emailId":{"type":"string","description":"Unique email Id of the user. This will be used to login to workmate account.","example":"vtsupport@mapmyindia.com","x-mappls-field-path":"users[].emailId"},"users[].originId":{"type":"integer","description":"Users workmate account id","example":32,"x-mappls-field-path":"users[].originId"},"users[].name":{"type":"string","description":"Name of the user.","example":"kalaivanan","x-mappls-field-path":"users[].name"},"users[].status":{"type":"string","description":"It gives users active or inactive status . 1 - Active user, 0- Inactive user.","example":1,"x-mappls-field-path":"users[].status"},"users[].type":{"type":"integer","description":"Three user type is there in workmate. 0 -admin, 1 -manager, 2 - field user","example":0,"x-mappls-field-path":"users[].type"},"users[].creationTime":{"type":"integer","description":"Time at which user is being created over workmate. It is an Local EPCH time.","example":"1700000000000","x-mappls-field-path":"users[].creationTime"},"users[].workplaceId":{"type":"integer","description":"Unique Id of the Work place.","example":"MMI000","x-mappls-field-path":"users[].workplaceId"},"users[].costFactor":{"type":"number","description":"per km travelled cost. It will be multiplyed against distance travelled by the user.","example":3.4,"x-mappls-field-path":"users[].costFactor"},"users[].reportingToName":{"type":"string","description":"Direct manager of the user.","example":"Sanjay","x-mappls-field-path":"users[].reportingToName"},"users[].reportingToId":{"type":"string","description":"Manger's unique user Id","example":2323,"x-mappls-field-path":"users[].reportingToId"},"users[].employeeId":{"type":"string","description":"Employee unquie ID based on the company record","example":"CE003121","x-mappls-field-path":"users[].employeeId"},"users[].branchName":{"type":"string","description":"Users branch name of the work place.","example":"Bangalore","x-mappls-field-path":"users[].branchName"},"users[].branchCode":{"type":"string","description":"Users branch code of the work place.","example":"CE12","x-mappls-field-path":"users[].branchCode"},"users[].workPlace":{"type":"object","example":"example","x-mappls-field-path":"users[].workPlace"},"users[].workPlace.lat":{"type":"number","description":"Workmate place location latitude","example":"28.612964","x-mappls-field-path":"users[].workPlace.lat"},"users[].workPlace.long":{"type":"number","description":"Workmate place location longitude.","example":78.3223,"x-mappls-field-path":"users[].workPlace.long"},"users[].workPlace.name":{"type":"string","description":"Work location name","example":"Bangalore office","x-mappls-field-path":"users[].workPlace.name"},"users[].workPlace.address":{"type":"string","description":"work place address","example":"1134, Dr SK Karim Khan Road, HAL Stage 2, Indiranagar, Bengaluru, Karnataka. 0 m from MapmyIndia Bangalore pin-560008 (India)","x-mappls-field-path":"users[].workPlace.address"}}},"example":{"users":[{"id":232,"emailId":"vtsupport@mapmyindia.com","originId":32,"name":"kalaivanan","status":1,"type":0,"creationTime":1458987749,"workplaceId":32}]}}}},"204":{"description":"content not found. Check your input values."},"400":{"description":"Bad Request - Invalid ID supplied or invalid data type.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","description":"Status Code Name","example":400,"x-mappls-field-path":"status"},"message":{"type":"string","description":"Describes the type of error based on the type of response code.","example":"Missing parameter name.","x-mappls-field-path":"message"}}},"example":{"status":400,"message":"Missing parameter name."}}}},"401":{"description":"Unauthorized Request. Access to API is forbidden."},"403":{"description":"User type is Field user. Only manager and admin type user have the access to this API"},"404":{"description":"Not Found - URL Not Found"},"406":{"description":"userId not belong to your account"}},"security":[{"BearerAuth":[]}],"x-mappls-auth-mode":"oauth2-bearer","x-mappls-contract-status":"legacy-source","x-mappls-state-model":"stateful","x-mappls-journey-role":"observe","x-mappls-source-id":"local-contenthub-dochub-mapmyindia-workmate-apis","x-mappls-source-file":"contenthub/dochub/mapmyindia-workmate-apis/custom/User-Details.json","x-mappls-source-fingerprint":"46675d4ad523c600efb696a87e7aca9de0e5f629ab8906a31e40fd5d3dfdae3e","x-mappls-evidence-score":32,"x-mappls-source-generation":"v1-0-0","x-mappls-generation-group":"workmate-get-users-ecf2e35177","x-mappls-generation-count":1,"x-mappls-preferred-generation":true}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Mappls access token","description":"Supply a server-held, appropriately scoped Mappls bearer credential. Never embed it in browser or mobile source."}}},"x-mappls-generated-at":"2026-08-17T11:44:25Z","x-mappls-operation-count":145,"x-mappls-retained-operation-count":162,"x-mappls-contract-generations":{"schemaVersion":"mappls.contract-generations.v1","groups":[{"slug":"intouch-get-alarm-10c842d182","family":"intouch","familyName":"InTouch Telematics","product":"InTouch","stateModel":"stateful","method":"GET","path":"/alarm","title":"GET /alarm","preferredGeneration":"v2-0-0","preferredSlug":"intouch-get-alarm-this-api-will-get-all-the-alarm-configurations-for-a-user","variants":[{"generation":"v1-0-0","apiVersion":"1.0.0","slug":"intouch-get-alarm-this-api-will-get-all-the-alarm-configurations-for-a-user-v1-0-0","href":"/api-reference/intouch-get-alarm-this-api-will-get-all-the-alarm-configurations-for-a-user-v1-0-0","summary":"This API will get all the alarm configurations for a user.","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","sourceFingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["query:alarmType","query:deviceId","query:id"],"requiredParameterKeys":[],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","203","400","401","404"],"responseFields":["200:data","200:data[].alarmType","200:data[].creationTime","200:data[].deviceId","200:data[].duration","200:data[].geofenceId","200:data[].id","200:data[].limit","200:data[].severity","200:data[].type","200:data[].updationTime","400:error","400:message","400:status"],"isPreferredGeneration":false},{"generation":"v2-0-0","apiVersion":"2.0.0","slug":"intouch-get-alarm-this-api-will-get-all-the-alarm-configurations-for-a-user","href":"/api-reference/intouch-get-alarm-this-api-will-get-all-the-alarm-configurations-for-a-user","summary":"This API will get all the alarm configurations for a user.","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.yaml","sourceFingerprint":"9789c0e53eba5ec44918ca8aade24d4b856aaade5c692109943d1e262fb2545a","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["query:alarmType","query:deviceId","query:id"],"requiredParameterKeys":[],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","203","400","401","404"],"responseFields":["200:data","200:data[].alarmType","200:data[].creationTime","200:data[].deviceId","200:data[].duration","200:data[].geofenceId","200:data[].id","200:data[].limit","200:data[].severity","200:data[].type","200:data[].updationTime","400:error","400:message","400:status"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1-0-0","fromSlug":"intouch-get-alarm-this-api-will-get-all-the-alarm-configurations-for-a-user-v1-0-0","toGeneration":"v2-0-0","toSlug":"intouch-get-alarm-this-api-will-get-all-the-alarm-configurations-for-a-user","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2-0-0; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"intouch-post-alarm-8579e8cb93","family":"intouch","familyName":"InTouch Telematics","product":"InTouch","stateModel":"stateful","method":"POST","path":"/alarm","title":"POST /alarm","preferredGeneration":"v2-0-0","preferredSlug":"intouch-post-alarm-this-api-will-create-an-alarm","variants":[{"generation":"v1-0-0","apiVersion":"1.0.0","slug":"intouch-post-alarm-this-api-will-create-an-alarm-v1-0-0","href":"/api-reference/intouch-post-alarm-this-api-will-create-an-alarm-v1-0-0","summary":"This API will create an alarm.","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","sourceFingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":[],"requiredParameterKeys":[],"requestFields":["alarmType","deviceId","duration","geofenceId","limit","severity","type"],"requiredRequestFields":[],"responseStatuses":["201","203","400","401","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":false},{"generation":"v2-0-0","apiVersion":"2.0.0","slug":"intouch-post-alarm-this-api-will-create-an-alarm","href":"/api-reference/intouch-post-alarm-this-api-will-create-an-alarm","summary":"This API will create an alarm.","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.yaml","sourceFingerprint":"9789c0e53eba5ec44918ca8aade24d4b856aaade5c692109943d1e262fb2545a","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":[],"requiredParameterKeys":[],"requestFields":["alarmType","deviceId","duration","geofenceId","limit","severity","type"],"requiredRequestFields":[],"responseStatuses":["201","203","400","401","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1-0-0","fromSlug":"intouch-post-alarm-this-api-will-create-an-alarm-v1-0-0","toGeneration":"v2-0-0","toSlug":"intouch-post-alarm-this-api-will-create-an-alarm","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2-0-0; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"intouch-delete-alarm-id-ca6df54f47","family":"intouch","familyName":"InTouch Telematics","product":"InTouch","stateModel":"stateful","method":"DELETE","path":"/alarm/{id}","title":"DELETE /alarm/{id}","preferredGeneration":"v2-0-0","preferredSlug":"intouch-delete-alarm-id-deletes-an-alarm-config","variants":[{"generation":"v1-0-0","apiVersion":"1.0.0","slug":"intouch-delete-alarm-id-deletes-an-alarm-config-v1-0-0","href":"/api-reference/intouch-delete-alarm-id-deletes-an-alarm-config-v1-0-0","summary":"Deletes An Alarm Config","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","sourceFingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["path:id"],"requiredParameterKeys":["path:id"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","204","400","401","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":false},{"generation":"v2-0-0","apiVersion":"2.0.0","slug":"intouch-delete-alarm-id-deletes-an-alarm-config","href":"/api-reference/intouch-delete-alarm-id-deletes-an-alarm-config","summary":"Deletes An Alarm Config","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.yaml","sourceFingerprint":"9789c0e53eba5ec44918ca8aade24d4b856aaade5c692109943d1e262fb2545a","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["path:id"],"requiredParameterKeys":["path:id"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","204","400","401","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1-0-0","fromSlug":"intouch-delete-alarm-id-deletes-an-alarm-config-v1-0-0","toGeneration":"v2-0-0","toSlug":"intouch-delete-alarm-id-deletes-an-alarm-config","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2-0-0; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"intouch-post-alarm-id-352bd7eab8","family":"intouch","familyName":"InTouch Telematics","product":"InTouch","stateModel":"stateful","method":"POST","path":"/alarm/{id}","title":"POST /alarm/{id}","preferredGeneration":"v2-0-0","preferredSlug":"intouch-post-alarm-id-updates-an-alarm-config","variants":[{"generation":"v1-0-0","apiVersion":"1.0.0","slug":"intouch-post-alarm-id-updates-an-alarm-config-v1-0-0","href":"/api-reference/intouch-post-alarm-id-updates-an-alarm-config-v1-0-0","summary":"Updates An Alarm Config","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","sourceFingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["path:id"],"requiredParameterKeys":["path:id"],"requestFields":["deviceId","duration","geofenceId","limit","severity","type"],"requiredRequestFields":[],"responseStatuses":["200","400","401","403","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":false},{"generation":"v2-0-0","apiVersion":"2.0.0","slug":"intouch-post-alarm-id-updates-an-alarm-config","href":"/api-reference/intouch-post-alarm-id-updates-an-alarm-config","summary":"Updates An Alarm Config","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.yaml","sourceFingerprint":"9789c0e53eba5ec44918ca8aade24d4b856aaade5c692109943d1e262fb2545a","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["path:id"],"requiredParameterKeys":["path:id"],"requestFields":["deviceId","duration","geofenceId","limit","severity","type"],"requiredRequestFields":[],"responseStatuses":["200","400","401","403","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1-0-0","fromSlug":"intouch-post-alarm-id-updates-an-alarm-config-v1-0-0","toGeneration":"v2-0-0","toSlug":"intouch-post-alarm-id-updates-an-alarm-config","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2-0-0; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"intouch-get-alarm-alarmlog-0de27f90fb","family":"intouch","familyName":"InTouch Telematics","product":"InTouch","stateModel":"stateful","method":"GET","path":"/alarm/alarmLog/","title":"GET /alarm/alarmLog/","preferredGeneration":"v2-0-0","preferredSlug":"intouch-get-alarm-alarmlog-gets-the-list-of-alarm-config-s","variants":[{"generation":"v1-0-0","apiVersion":"1.0.0","slug":"intouch-get-alarm-alarmlog-gets-the-list-of-alarm-config-s-v1-0-0","href":"/api-reference/intouch-get-alarm-alarmlog-gets-the-list-of-alarm-config-s-v1-0-0","summary":"Gets The List Of Alarm Config(s)","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","sourceFingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["query:alarmType","query:deviceId","query:endTime","query:startTime"],"requiredParameterKeys":["query:endTime","query:startTime"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","203","400","401","404"],"responseFields":["200:data","200:data[].actualDuration","200:data[].actualLimit","200:data[].address","200:data[].alarmType","200:data[].data","200:data[].deviceId","200:data[].duration","200:data[].geofenceId","200:data[].latitude","200:data[].limit","200:data[].longitude","200:data[].severity","200:data[].timestamp","400:error","400:message","400:status"],"isPreferredGeneration":false},{"generation":"v2-0-0","apiVersion":"2.0.0","slug":"intouch-get-alarm-alarmlog-gets-the-list-of-alarm-config-s","href":"/api-reference/intouch-get-alarm-alarmlog-gets-the-list-of-alarm-config-s","summary":"Gets The List Of Alarm Config(s)","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/alarm.yaml","sourceFingerprint":"9789c0e53eba5ec44918ca8aade24d4b856aaade5c692109943d1e262fb2545a","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["query:alarmType","query:deviceId","query:endTime","query:startTime"],"requiredParameterKeys":["query:endTime","query:startTime"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","203","400","401","404"],"responseFields":["200:data","200:data[].actualDuration","200:data[].actualLimit","200:data[].address","200:data[].alarmType","200:data[].data","200:data[].deviceId","200:data[].duration","200:data[].geofenceId","200:data[].latitude","200:data[].limit","200:data[].longitude","200:data[].severity","200:data[].timestamp","400:error","400:message","400:status"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1-0-0","fromSlug":"intouch-get-alarm-alarmlog-gets-the-list-of-alarm-config-s-v1-0-0","toGeneration":"v2-0-0","toSlug":"intouch-get-alarm-alarmlog-gets-the-list-of-alarm-config-s","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2-0-0; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"intouch-get-geofence-0428994c0e","family":"intouch","familyName":"InTouch Telematics","product":"InTouch","stateModel":"stateful","method":"GET","path":"/geofence/","title":"GET /geofence/","preferredGeneration":"v2-0-0","preferredSlug":"intouch-get-geofence-gets-all-the-configured-geofence-s","variants":[{"generation":"v1-0-0","apiVersion":"1.0.0","slug":"intouch-get-geofence-gets-all-the-configured-geofence-s-v1-0-0","href":"/api-reference/intouch-get-geofence-gets-all-the-configured-geofence-s-v1-0-0","summary":"Gets All The Configured Geofence(s)","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","sourceFingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["query:ignoreGeometry"],"requiredParameterKeys":[],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","203","400","401","404"],"responseFields":["200:data","200:data[].buffer","200:data[].creationTime","200:data[].geometry","200:data[].geometry.coordinates","200:data[].geometry.type","200:data[].id","200:data[].name","200:data[].type","200:data[].updationTime","400:error","400:message","400:status"],"isPreferredGeneration":false},{"generation":"v2-0-0","apiVersion":"2.0.0","slug":"intouch-get-geofence-gets-all-the-configured-geofence-s","href":"/api-reference/intouch-get-geofence-gets-all-the-configured-geofence-s","summary":"Gets All The Configured Geofence(s)","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.yaml","sourceFingerprint":"03d663d784a8ea9af1a3915cad4395ab716b167774dbf54a73c516bd10bc887a","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["query:ignoreGeometry"],"requiredParameterKeys":[],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","203","400","401","404"],"responseFields":["200:data","200:data[].buffer","200:data[].creationTime","200:data[].geometry","200:data[].geometry.coordinates","200:data[].geometry.type","200:data[].id","200:data[].name","200:data[].type","200:data[].updationTime","400:error","400:message","400:status"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1-0-0","fromSlug":"intouch-get-geofence-gets-all-the-configured-geofence-s-v1-0-0","toGeneration":"v2-0-0","toSlug":"intouch-get-geofence-gets-all-the-configured-geofence-s","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2-0-0; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"intouch-post-geofence-9930a2a5a4","family":"intouch","familyName":"InTouch Telematics","product":"InTouch","stateModel":"stateful","method":"POST","path":"/geofence/","title":"POST /geofence/","preferredGeneration":"v2-0-0","preferredSlug":"intouch-post-geofence-create-a-new-geofence","variants":[{"generation":"v1-0-0","apiVersion":"1.0.0","slug":"intouch-post-geofence-create-a-new-geofence-v1-0-0","href":"/api-reference/intouch-post-geofence-create-a-new-geofence-v1-0-0","summary":"Create A New Geofence","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","sourceFingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":[],"requiredParameterKeys":[],"requestFields":["buffer","geometry","name"],"requiredRequestFields":[],"responseStatuses":["201","203","400","401","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":false},{"generation":"v2-0-0","apiVersion":"2.0.0","slug":"intouch-post-geofence-create-a-new-geofence","href":"/api-reference/intouch-post-geofence-create-a-new-geofence","summary":"Create A New Geofence","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.yaml","sourceFingerprint":"03d663d784a8ea9af1a3915cad4395ab716b167774dbf54a73c516bd10bc887a","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":[],"requiredParameterKeys":[],"requestFields":["buffer","geometry","name"],"requiredRequestFields":[],"responseStatuses":["201","203","400","401","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1-0-0","fromSlug":"intouch-post-geofence-create-a-new-geofence-v1-0-0","toGeneration":"v2-0-0","toSlug":"intouch-post-geofence-create-a-new-geofence","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2-0-0; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"intouch-delete-geofence-id-acd58f4735","family":"intouch","familyName":"InTouch Telematics","product":"InTouch","stateModel":"stateful","method":"DELETE","path":"/geofence/{id}","title":"DELETE /geofence/{id}","preferredGeneration":"v2-0-0","preferredSlug":"intouch-delete-geofence-id-delete-a-geofence","variants":[{"generation":"v1-0-0","apiVersion":"1.0.0","slug":"intouch-delete-geofence-id-delete-a-geofence-v1-0-0","href":"/api-reference/intouch-delete-geofence-id-delete-a-geofence-v1-0-0","summary":"Delete A Geofence.","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","sourceFingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["path:id"],"requiredParameterKeys":["path:id"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":false},{"generation":"v2-0-0","apiVersion":"2.0.0","slug":"intouch-delete-geofence-id-delete-a-geofence","href":"/api-reference/intouch-delete-geofence-id-delete-a-geofence","summary":"Delete A Geofence.","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.yaml","sourceFingerprint":"03d663d784a8ea9af1a3915cad4395ab716b167774dbf54a73c516bd10bc887a","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["path:id"],"requiredParameterKeys":["path:id"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1-0-0","fromSlug":"intouch-delete-geofence-id-delete-a-geofence-v1-0-0","toGeneration":"v2-0-0","toSlug":"intouch-delete-geofence-id-delete-a-geofence","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2-0-0; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"intouch-get-geofence-id-9d8bafa2d5","family":"intouch","familyName":"InTouch Telematics","product":"InTouch","stateModel":"stateful","method":"GET","path":"/geofence/{id}","title":"GET /geofence/{id}","preferredGeneration":"v2-0-0","preferredSlug":"intouch-get-geofence-id-get-a-single-or-multiple-geofence-s","variants":[{"generation":"v1-0-0","apiVersion":"1.0.0","slug":"intouch-get-geofence-id-get-a-single-or-multiple-geofence-s-v1-0-0","href":"/api-reference/intouch-get-geofence-id-get-a-single-or-multiple-geofence-s-v1-0-0","summary":"Get A Single Or Multiple Geofence(s).","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","sourceFingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["path:id","query:id","query:ignoreGeometry"],"requiredParameterKeys":["path:id"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","203","400","401","404"],"responseFields":["200:data","200:data[].buffer","200:data[].creationTime","200:data[].geometry","200:data[].geometry.coordinates","200:data[].geometry.type","200:data[].id","200:data[].name","200:data[].type","200:data[].updationTime","400:error","400:message","400:status"],"isPreferredGeneration":false},{"generation":"v2-0-0","apiVersion":"2.0.0","slug":"intouch-get-geofence-id-get-a-single-or-multiple-geofence-s","href":"/api-reference/intouch-get-geofence-id-get-a-single-or-multiple-geofence-s","summary":"Get A Single Or Multiple Geofence(s).","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.yaml","sourceFingerprint":"03d663d784a8ea9af1a3915cad4395ab716b167774dbf54a73c516bd10bc887a","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["path:id","query:id","query:ignoreGeometry"],"requiredParameterKeys":["path:id"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","203","400","401","404"],"responseFields":["200:data","200:data[].buffer","200:data[].creationTime","200:data[].geometry","200:data[].geometry.coordinates","200:data[].geometry.type","200:data[].id","200:data[].name","200:data[].type","200:data[].updationTime","400:error","400:message","400:status"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1-0-0","fromSlug":"intouch-get-geofence-id-get-a-single-or-multiple-geofence-s-v1-0-0","toGeneration":"v2-0-0","toSlug":"intouch-get-geofence-id-get-a-single-or-multiple-geofence-s","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2-0-0; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"intouch-post-geofence-id-83a7719be5","family":"intouch","familyName":"InTouch Telematics","product":"InTouch","stateModel":"stateful","method":"POST","path":"/geofence/{id}","title":"POST /geofence/{id}","preferredGeneration":"v2-0-0","preferredSlug":"intouch-post-geofence-id-update-a-geofence","variants":[{"generation":"v1-0-0","apiVersion":"1.0.0","slug":"intouch-post-geofence-id-update-a-geofence-v1-0-0","href":"/api-reference/intouch-post-geofence-id-update-a-geofence-v1-0-0","summary":"Update A Geofence.","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/Intouch-Telematics-Swagger-25052020.json","sourceFingerprint":"54637441ab0c8ea447e121ba33afbc464e714a3dbceec49d4b70dabe9778657f","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["path:id"],"requiredParameterKeys":["path:id"],"requestFields":["buffer","geometry","name"],"requiredRequestFields":[],"responseStatuses":["200","400","401","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":false},{"generation":"v2-0-0","apiVersion":"2.0.0","slug":"intouch-post-geofence-id-update-a-geofence","href":"/api-reference/intouch-post-geofence-id-update-a-geofence","summary":"Update A Geofence.","sourceFile":"contenthub/dochub/mapmyindia-intouch-rest-apis/custom/geofence.yaml","sourceFingerprint":"03d663d784a8ea9af1a3915cad4395ab716b167774dbf54a73c516bd10bc887a","baseUrl":"https://intouch.mapmyindia.com/iot/api","authMode":"bearer","parameterKeys":["path:id"],"requiredParameterKeys":["path:id"],"requestFields":["buffer","geometry","name"],"requiredRequestFields":[],"responseStatuses":["200","400","401","404"],"responseFields":["400:error","400:message","400:status"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1-0-0","fromSlug":"intouch-post-geofence-id-update-a-geofence-v1-0-0","toGeneration":"v2-0-0","toSlug":"intouch-post-geofence-id-update-a-geofence","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2-0-0; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"mgis-get-describedataset-855417da71","family":"mgis","familyName":"mGIS Analytics","product":"mGIS","stateModel":"stateful","method":"GET","path":"/describeDataset","title":"GET /describeDataset","preferredGeneration":"v2","preferredSlug":"mgis-get-describedataset-fetches-the-attribute-names","variants":[{"generation":"v1","apiVersion":"V1.0.0","slug":"mgis-get-describedataset-fetches-the-attribute-names-v1","href":"/api-reference/mgis-get-describedataset-fetches-the-attribute-names-v1","summary":"fetches the attribute names.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/describe-dataset-api.yml","sourceFingerprint":"c981431acc37f36caebfd2b0f9c66ad08ebedef3f93e0eba70375b935d27fadd","baseUrl":"https://mgis-api.mappls.com/","authMode":"bearer","parameterKeys":["query:datasetNme"],"requiredParameterKeys":["query:datasetNme"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","404","422","500"],"responseFields":["200:code","200:propertyList","200:propertyList[].ColumnName","200:propertyList[].ColumnType","400:auth","400:code","400:error","400:message","401:code","401:error","404:code","404:error","422:code","422:error","500:code","500:error"],"isPreferredGeneration":false},{"generation":"v2","apiVersion":"V2.0.0","slug":"mgis-get-describedataset-fetches-the-attribute-names","href":"/api-reference/mgis-get-describedataset-fetches-the-attribute-names","summary":"fetches the attribute names.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/describe-dataset-api.yml","sourceFingerprint":"ea4acadc9a13ed87bdc8f5b4a009cb6eebcc13efc93221a3103ac8f5ea70c9b6","baseUrl":"https://mgis-apiv2.mappls.com/","authMode":"bearer","parameterKeys":["query:dataStoreName","query:datasetNme"],"requiredParameterKeys":["query:datasetNme"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","500"],"responseFields":["200:code","200:data","200:data.propertyList","200:data.propertyList[].ColumnName","200:data.propertyList[].ColumnType","200:message","200:success","400:code","400:message","401:code","401:message","500:code","500:message"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1","fromSlug":"mgis-get-describedataset-fetches-the-attribute-names-v1","toGeneration":"v2","toSlug":"mgis-get-describedataset-fetches-the-attribute-names","addedParameters":["query:dataStoreName"],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":["404","422"],"addedResponseFields":["200:data","200:data.propertyList","200:data.propertyList[].ColumnName","200:data.propertyList[].ColumnType","200:message","200:success","401:message","500:message"],"removedResponseFields":["200:propertyList","200:propertyList[].ColumnName","200:propertyList[].ColumnType","400:auth","400:error","401:error","404:code","404:error","422:code","422:error","500:error"],"authChanged":false,"baseUrlChanged":true,"breakingSignals":["Response status no longer declared: 404","Response status no longer declared: 422","Declared server URL changed"],"migrationChecklist":["Confirm the Mappls account is entitled to v2; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"mgis-get-getgeometrytype-97af5b353e","family":"mgis","familyName":"mGIS Analytics","product":"mGIS","stateModel":"stateful","method":"GET","path":"/getGeometryType","title":"GET /getGeometryType","preferredGeneration":"v2","preferredSlug":"mgis-get-getgeometrytype-fetches-geometry-type-of-datasetnme","variants":[{"generation":"v1","apiVersion":"V1.0.0","slug":"mgis-get-getgeometrytype-fetches-geometry-type-of-datasetnme-v1","href":"/api-reference/mgis-get-getgeometrytype-fetches-geometry-type-of-datasetnme-v1","summary":"Fetches Geometry type of datasetNme","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/get-geometry-type-api.yml","sourceFingerprint":"baec95146c20c62ed13d99d44f62f336b8e09e2f2bd7bae23559048ffdbd4a3d","baseUrl":"https://mgis-api.mappls.com/","authMode":"bearer","parameterKeys":["query:datasetNme"],"requiredParameterKeys":["query:datasetNme"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","404","422","500"],"responseFields":["200:geometryType","400:auth","400:code","400:error","400:message","401:code","401:error","404:code","404:error","422:code","422:error","500:code","500:error"],"isPreferredGeneration":false},{"generation":"v2","apiVersion":"V2.0.0","slug":"mgis-get-getgeometrytype-fetches-geometry-type-of-datasetnme","href":"/api-reference/mgis-get-getgeometrytype-fetches-geometry-type-of-datasetnme","summary":"Fetches Geometry type of datasetNme","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/get-geometry-type-api.yml","sourceFingerprint":"4c85c54f75f91c3f3353aa5644b077a5c49aa91d6ed3a3d53cedf535fcfc7a54","baseUrl":"https://mgis-apiv2.mappls.com/","authMode":"bearer","parameterKeys":["query:datasetNme"],"requiredParameterKeys":["query:datasetNme"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","404","500"],"responseFields":["200:code","200:data","200:message","200:success","400:auth","400:code","400:error","400:message","401:code","401:message","404:code","404:message","500:code","500:message"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1","fromSlug":"mgis-get-getgeometrytype-fetches-geometry-type-of-datasetnme-v1","toGeneration":"v2","toSlug":"mgis-get-getgeometrytype-fetches-geometry-type-of-datasetnme","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":["422"],"addedResponseFields":["200:code","200:data","200:message","200:success","401:message","404:message","500:message"],"removedResponseFields":["200:geometryType","401:error","404:error","422:code","422:error","500:error"],"authChanged":false,"baseUrlChanged":true,"breakingSignals":["Response status no longer declared: 422","Declared server URL changed"],"migrationChecklist":["Confirm the Mappls account is entitled to v2; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"mgis-get-getlayerslist-7a2d5959c7","family":"mgis","familyName":"mGIS Analytics","product":"mGIS","stateModel":"stateful","method":"GET","path":"/getLayersList","title":"GET /getLayersList","preferredGeneration":"v2","preferredSlug":"mgis-get-getlayerslist-fetches-the-names-of-all-the-datasets-available-in-the-user-s-workspace-on-the-geoserver","variants":[{"generation":"v1","apiVersion":"V1.0.0","slug":"mgis-get-getlayerslist-fetches-the-names-of-all-the-datasets-available-in-the-user-s-workspace-on-the-geoserver-v1","href":"/api-reference/mgis-get-getlayerslist-fetches-the-names-of-all-the-datasets-available-in-the-user-s-workspace-on-the-geoserver-v1","summary":"Fetches the names of all the datasets available in the user's workspace on the geoserver.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/get-layer-list-legends-apis.yml","sourceFingerprint":"34013a0683256113b49f4f53bf081248614e58651009f244030f2ff29bceb0d3","baseUrl":"https://mgis-api.mappls.com/","authMode":"bearer","parameterKeys":[],"requiredParameterKeys":[],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","404","500"],"responseFields":["200:items[].geometrytype","200:items[].layername","400:code","400:error","404:code","404:error","500:code","500:error"],"isPreferredGeneration":false},{"generation":"v2","apiVersion":"V1.0.0","slug":"mgis-get-getlayerslist-fetches-the-names-of-all-the-datasets-available-in-the-user-s-workspace-on-the-geoserver","href":"/api-reference/mgis-get-getlayerslist-fetches-the-names-of-all-the-datasets-available-in-the-user-s-workspace-on-the-geoserver","summary":"Fetches the names of all the datasets available in the user's workspace on the geoserver.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/get-layer-list-legends-apis.yml","sourceFingerprint":"cc9f61d938cafd0f18558bd2ec18e73b5293bb526b53a74b2d6e6373f0d087bf","baseUrl":"https://mgis-apiv2.mappls.com/","authMode":"bearer","parameterKeys":[],"requiredParameterKeys":[],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","404","500"],"responseFields":["200:code","200:data","200:message","200:success","400:code","400:error","404:code","404:error","500:code","500:error"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1","fromSlug":"mgis-get-getlayerslist-fetches-the-names-of-all-the-datasets-available-in-the-user-s-workspace-on-the-geoserver-v1","toGeneration":"v2","toSlug":"mgis-get-getlayerslist-fetches-the-names-of-all-the-datasets-available-in-the-user-s-workspace-on-the-geoserver","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":["200:code","200:data","200:message","200:success"],"removedResponseFields":["200:items[].geometrytype","200:items[].layername"],"authChanged":false,"baseUrlChanged":true,"breakingSignals":["Declared server URL changed"],"migrationChecklist":["Confirm the Mappls account is entitled to v2; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"mgis-get-getlegendsimg-eed36ebbd0","family":"mgis","familyName":"mGIS Analytics","product":"mGIS","stateModel":"stateful","method":"GET","path":"/getLegendsImg","title":"GET /getLegendsImg","preferredGeneration":"v2","preferredSlug":"mgis-get-getlegendsimg-fetches-the-image-of-legends-for-the-given-dataset","variants":[{"generation":"v1","apiVersion":"V1.0.0","slug":"mgis-get-getlegendsimg-fetches-the-image-of-legends-for-the-given-dataset-v1","href":"/api-reference/mgis-get-getlegendsimg-fetches-the-image-of-legends-for-the-given-dataset-v1","summary":"Fetches the image of legends for the given dataset.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/get-layer-list-legends-apis.yml","sourceFingerprint":"34013a0683256113b49f4f53bf081248614e58651009f244030f2ff29bceb0d3","baseUrl":"https://mgis-api.mappls.com/","authMode":"bearer","parameterKeys":["query:datasetNme","query:linestrokecolor","query:linestrokeopacity","query:linestrokewidth","query:pointfillcolor","query:pointfillopacity","query:pointsize","query:polygonfillcolor","query:polygonfillopacity","query:stylename"],"requiredParameterKeys":["query:datasetNme"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","500"],"responseFields":["500:code","500:error"],"isPreferredGeneration":false},{"generation":"v2","apiVersion":"V1.0.0","slug":"mgis-get-getlegendsimg-fetches-the-image-of-legends-for-the-given-dataset","href":"/api-reference/mgis-get-getlegendsimg-fetches-the-image-of-legends-for-the-given-dataset","summary":"Fetches the image of legends for the given dataset.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/get-layer-list-legends-apis.yml","sourceFingerprint":"cc9f61d938cafd0f18558bd2ec18e73b5293bb526b53a74b2d6e6373f0d087bf","baseUrl":"https://mgis-apiv2.mappls.com/","authMode":"bearer","parameterKeys":["query:datasetNme","query:linestrokecolor","query:linestrokeopacity","query:linestrokewidth","query:pointfillcolor","query:pointfillopacity","query:pointsize","query:polygonfillcolor","query:polygonfillopacity","query:stylename"],"requiredParameterKeys":["query:datasetNme"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","500"],"responseFields":["500:code","500:error"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1","fromSlug":"mgis-get-getlegendsimg-fetches-the-image-of-legends-for-the-given-dataset-v1","toGeneration":"v2","toSlug":"mgis-get-getlegendsimg-fetches-the-image-of-legends-for-the-given-dataset","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":true,"breakingSignals":["Declared server URL changed"],"migrationChecklist":["Confirm the Mappls account is entitled to v2; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"mgis-get-map-getfeatureinfo-6dd132c52b","family":"mgis","familyName":"mGIS Analytics","product":"mGIS","stateModel":"stateful","method":"GET","path":"/map/getFeatureInfo","title":"GET /map/getFeatureInfo","preferredGeneration":"v2","preferredSlug":"mgis-get-map-getfeatureinfo-fetches-the-feature-information","variants":[{"generation":"v1","apiVersion":"V2.0.0","slug":"mgis-get-map-getfeatureinfo-fetches-the-feature-information-v1","href":"/api-reference/mgis-get-map-getfeatureinfo-fetches-the-feature-information-v1","summary":"Fetches the feature information.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/layer_visualization.yml","sourceFingerprint":"8cfb02a3fcaa29b0fbe05896bfa2b311de8b9f97e897dbfddf54a338d452d8f2","baseUrl":"https://mgis-apiv2.mappls.com/","authMode":"bearer","parameterKeys":["query:bbox","query:buffer","query:cql_filter","query:datasetNme","query:height","query:srs","query:style","query:transparent","query:width","query:x","query:y"],"requiredParameterKeys":["query:bbox","query:datasetNme","query:height","query:width","query:x","query:y"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","404","500"],"responseFields":["200:code","200:data","200:data.featureInfo","200:data.featureInfo.st_name","200:message","200:success","400:auth","400:code","400:error","400:message","401:code","401:message","404:code","404:message","500:code","500:message"],"isPreferredGeneration":false},{"generation":"v2","apiVersion":"V2.0.0","slug":"mgis-get-map-getfeatureinfo-fetches-the-feature-information","href":"/api-reference/mgis-get-map-getfeatureinfo-fetches-the-feature-information","summary":"Fetches the feature information.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/layer_visualization.yml","sourceFingerprint":"789212df7cef0c3c95f49b37b2ce29dd4e8cedfaa496a797b04008071fc8fa34","baseUrl":"https://mgis-apiv2.mappls.com/","authMode":"bearer","parameterKeys":["query:bbox","query:buffer","query:cql_filter","query:datasetNme","query:height","query:srs","query:style","query:transparent","query:width","query:x","query:y"],"requiredParameterKeys":["query:bbox","query:datasetNme","query:height","query:width","query:x","query:y"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","404","500"],"responseFields":["200:code","200:data","200:data.featureInfo","200:data.featureInfo.st_name","200:message","200:success","400:auth","400:code","400:error","400:message","401:code","401:message","404:code","404:message","500:code","500:message"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1","fromSlug":"mgis-get-map-getfeatureinfo-fetches-the-feature-information-v1","toGeneration":"v2","toSlug":"mgis-get-map-getfeatureinfo-fetches-the-feature-information","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"mgis-get-map-getlayerjoin-9a1aac1c53","family":"mgis","familyName":"mGIS Analytics","product":"mGIS","stateModel":"stateful","method":"GET","path":"/map/getLayerJoin","title":"GET /map/getLayerJoin","preferredGeneration":"v2","preferredSlug":"mgis-get-map-getlayerjoin-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-for-spatial-join-between-2-datasets-as-well-as-between-one-dataset-and-userdefined-geometry","variants":[{"generation":"v1","apiVersion":"V2.0.0","slug":"mgis-get-map-getlayerjoin-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-for-spatial-join-between-2-datasets-as-well-as-between-one-dataset-and-userdefined-geometry-v1","href":"/api-reference/mgis-get-map-getlayerjoin-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-for-spatial-join-between-2-datasets-as-well-as-between-one-dataset-and-userdefined-geometry-v1","summary":"Fetches the maptiles of the dataset name of a bounding box for Spatial Join between 2 datasets as well as between one dataset and userDefined geometry.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/layer_visualization.yml","sourceFingerprint":"8cfb02a3fcaa29b0fbe05896bfa2b311de8b9f97e897dbfddf54a338d452d8f2","baseUrl":"https://mgis-apiv2.mappls.com/","authMode":"bearer","parameterKeys":["query:access_token","query:bbox","query:datasetRef","query:datasetSource","query:distance","query:env","query:geom","query:height","query:operator","query:queryType","query:refProperty","query:sourceProperty","query:srs","query:style","query:transparent","query:userGeom","query:width"],"requiredParameterKeys":["query:access_token","query:bbox","query:datasetSource","query:height","query:operator","query:queryType","query:width"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","404","500"],"responseFields":["400:auth","400:code","400:error","400:message","401:code","401:message","404:code","404:message","500:code","500:message"],"isPreferredGeneration":false},{"generation":"v2","apiVersion":"V2.0.0","slug":"mgis-get-map-getlayerjoin-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-for-spatial-join-between-2-datasets-as-well-as-between-one-dataset-and-userdefined-geometry","href":"/api-reference/mgis-get-map-getlayerjoin-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-for-spatial-join-between-2-datasets-as-well-as-between-one-dataset-and-userdefined-geometry","summary":"Fetches the maptiles of the dataset name of a bounding box for Spatial Join between 2 datasets as well as between one dataset and userDefined geometry.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/layer_visualization.yml","sourceFingerprint":"789212df7cef0c3c95f49b37b2ce29dd4e8cedfaa496a797b04008071fc8fa34","baseUrl":"https://mgis-apiv2.mappls.com/","authMode":"bearer","parameterKeys":["query:access_token","query:bbox","query:datasetRef","query:datasetSource","query:distance","query:env","query:geom","query:height","query:operator","query:queryType","query:refProperty","query:sourceProperty","query:srs","query:style","query:transparent","query:userGeom","query:width"],"requiredParameterKeys":["query:access_token","query:bbox","query:datasetSource","query:height","query:operator","query:queryType","query:width"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","404","500"],"responseFields":["400:auth","400:code","400:error","400:message","401:code","401:message","404:code","404:message","500:code","500:message"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1","fromSlug":"mgis-get-map-getlayerjoin-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-for-spatial-join-between-2-datasets-as-well-as-between-one-dataset-and-userdefined-geometry-v1","toGeneration":"v2","toSlug":"mgis-get-map-getlayerjoin-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-for-spatial-join-between-2-datasets-as-well-as-between-one-dataset-and-userdefined-geometry","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."},{"slug":"mgis-get-map-getmap-ee5f026cd2","family":"mgis","familyName":"mGIS Analytics","product":"mGIS","stateModel":"stateful","method":"GET","path":"/map/getMap","title":"GET /map/getMap","preferredGeneration":"v2","preferredSlug":"mgis-get-map-getmap-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box","variants":[{"generation":"v1","apiVersion":"V2.0.0","slug":"mgis-get-map-getmap-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-v1","href":"/api-reference/mgis-get-map-getmap-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-v1","summary":"Fetches the maptiles of the dataset name of a bounding box.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v1/custom/layer_visualization.yml","sourceFingerprint":"8cfb02a3fcaa29b0fbe05896bfa2b311de8b9f97e897dbfddf54a338d452d8f2","baseUrl":"https://mgis-apiv2.mappls.com/","authMode":"bearer","parameterKeys":["query:access_token","query:bbox","query:comparisonFunction","query:comparisonOperator","query:comparisonValue","query:cql_filter","query:datasetNme","query:env","query:height","query:queryType","query:srs","query:style","query:transparent","query:width"],"requiredParameterKeys":["query:access_token","query:bbox","query:datasetNme","query:height","query:width"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","404","500"],"responseFields":["400:auth","400:code","400:error","400:message","401:code","401:message","404:code","404:message","500:code","500:message"],"isPreferredGeneration":false},{"generation":"v2","apiVersion":"V2.0.0","slug":"mgis-get-map-getmap-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box","href":"/api-reference/mgis-get-map-getmap-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box","summary":"Fetches the maptiles of the dataset name of a bounding box.","sourceFile":"mappls-developer-platform/data/corpus/public-api-contracts/mapmyindia-mgis-apis/docs/v2/custom/layer_visualization.yml","sourceFingerprint":"789212df7cef0c3c95f49b37b2ce29dd4e8cedfaa496a797b04008071fc8fa34","baseUrl":"https://mgis-apiv2.mappls.com/","authMode":"bearer","parameterKeys":["query:access_token","query:bbox","query:comparisonFunction","query:comparisonOperator","query:comparisonValue","query:cql_filter","query:datasetNme","query:env","query:height","query:queryType","query:srs","query:style","query:transparent","query:width"],"requiredParameterKeys":["query:access_token","query:bbox","query:datasetNme","query:height","query:width"],"requestFields":[],"requiredRequestFields":[],"responseStatuses":["200","400","401","404","500"],"responseFields":["400:auth","400:code","400:error","400:message","401:code","401:message","404:code","404:message","500:code","500:message"],"isPreferredGeneration":true}],"transitions":[{"fromGeneration":"v1","fromSlug":"mgis-get-map-getmap-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box-v1","toGeneration":"v2","toSlug":"mgis-get-map-getmap-fetches-the-maptiles-of-the-dataset-name-of-a-bounding-box","addedParameters":[],"removedParameters":[],"newlyRequiredParameters":[],"addedRequestFields":[],"removedRequestFields":[],"newlyRequiredRequestFields":[],"addedResponseStatuses":[],"removedResponseStatuses":[],"addedResponseFields":[],"removedResponseFields":[],"authChanged":false,"baseUrlChanged":false,"breakingSignals":[],"migrationChecklist":["Confirm the Mappls account is entitled to v2; source ordering is not availability proof.","Run both retained contract generations against sanitized fixtures and compare application parsing.","Update only declared parameters and request fields; do not infer undocumented aliases.","Exercise authentication rejection, validation, rate-limit, timeout, and unknown-outcome handling.","For state-changing operations, migrate behind an idempotent adapter and reconcile before retry.","Retain the source fingerprints, acceptance evidence, rollback trigger, and previous adapter until approval."]}],"evidenceBoundary":"Preferred means the highest version-labelled generation retained in this source snapshot. It does not establish current provider support, compatibility, entitlement, regional availability, or a safe production migration."}],"guide":"https://developer.mappls.com/api-generations","api":"https://developer.mappls.com/api/contract-generations","boundary":"The preferred declaration is the highest retained version-labelled source evidence only, not a provider support, entitlement, compatibility, host availability, or production-readiness promise."},"x-mappls-boundary":"Validate host, auth generation, entitlement, region, quota, and terms for the target account before production use."}