POST /index/kmz

Returns a compressed Keyhole Markup Language file detailing the Google Earth location of one or more SIMs. You will need to install Google Earth or Google My Maps in order to import the file and view the mapped locations.

kmz – Keyhole Markup Language Zipped

Authentication

  • User required to login

Headers

For information about headers, see Configuring headers.

Request Body application/json

Schema

Use null without quotes as the input if you do not wish to use these objects. The value will remain as previously set. If you want to change the object value to a new value, replace null with "<value>" within quotes, where <value> is the required value. To remove an existing value, type an empty string. For example: "friendlyName" : "" ,

JSON key Description Required?
request_id

A request identifier for tracking responses.

 

username

The Eseye-assigned Location API username
password The Eseye-assigned Location API password
group The group name for the SIMs. If left blank, the request is not limited to group.  
ICCID

The array, containing the list of one or more SIMs that you want to locate using their Integrated Circuit Card IDs (ICCIDs).

 
ICCID1 The first ICCID  
ICCID2 The second ICCID  
ICCID3 The third ICCID  
... The range of ICCIDs. We recommend you search for a maximum of 10 ICCIDs in one request to reduce the load on the server.  

Example

Copy
Body raw JSON
{
    "request_id" : "1" ,
    "username" : "ExampleUsername" ,
    "password" : "ExamplePassword" ,
    "group" : "ExampleGroup",
    "iccid" : [
        "8944538523000000000",
        "8944538523000000001",
        "8944538523000000002"
        ]
}

Using Postman or similar, we recommend you test the request using Send before you Send and Download the file.

Responses application/json

Test request using Send

If you test the request using Send, then a successful response is similar to the following:

For information about errors, see Troubleshooting errors: Location API.

Download file using Send and Download

If you download the location map file using Send and Download, then a successful response immediately opens a dialog box to save the file to your default Downloads folder:

  1. Add a .kml extension to the File name.
  2. Browse to where you want to save the file, then select Save.
  3. Import the file into Google Earth or Google My Maps to view the SIM locations.

For more information, see the Google Earth or Google My Maps documentation.