GET /api/v1/team-members/{publicUserId}/reports/suburb-location-history

Retrieve Suburb Location History Report:
This endpoint retrieves the suburb location history report for a specific team member’s trip on a given date.
Request Method: GET
URL: https://api.locate2u.com/api/v1/team-members/{publicUserId}/reports/suburb-location-history?tripDate=yyyy-MM-dd

Input parameters:

publicUserId

Required* publicUserId (string) in the path which is the Public identifier for the user.

tripDate

Optional query parameter, Type : string ($date) with format “yyyy-MM-dd”
Specifies the trip date for the suburb location history.

Sample code

Java

NodeJS

PHP

Python

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.locate2u.com/api/v1/team-members/{publicUserId}/reports/suburb-location-history?tripDate=yyyy-MM-dd");
request.Headers.Add("Authorization", "Bearer yourBearerTokenHere");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://api.locate2u.com/api/v1/team-members/{publicUserId}/reports/suburb-location-history?tripDate=yyyy-MM-dd")
  .method("GET", body)
  .addHeader("Authorization", "Bearer yourBearerTokenHere")
  .build();
Response response = client.newCall(request).execute();

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': 'api.locate2u.com',
  'path': '/api/v1/team-members/{publicUserId}/reports/suburb-location-history?tripDate=yyyy-MM-dd',
  'headers': {
    'Authorization': 'Bearer yourBearerTokenHere'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

req.end();

 'https://api.locate2u.com/api/v1/team-members/{publicUserId}/reports/suburb-location-history?tripDate=yyyy-MM-dd',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer yourBearerTokenHere'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://api.locate2u.com/api/v1/team-members/{publicUserId}/reports/suburb-location-history?tripDate=yyyy-MM-dd"

payload = {}
headers = {
  'Authorization': 'Bearer yourBearerTokenHere'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Response

Response
The response is in JSON format and follows the schema below:
JSON[
{
“entered”: “null”,
“exited”: “string”,
“location”: {
“latitude”: 0,
“longitude”: 0
},
“address”: “string”
}
]
entered (string, nullable): Indicates the entry time at a location.
exited (string): Indicates the exit time from a location.
location (object): Contains the geographical coordinates of the location.
latitude (number): The latitude of the location.
longitude (number): The longitude of the location.
address (string): Provides the address of the location.

Sample response:

[
    {
        "entered": null,
        "exited": "2024-06-06T08:26:32.0000000+10:00",
        "location": {
            "latitude": -33.8741892,
            "longitude": 151.1875748
        },
        "address": "Glebe, New South Wales"
    },
    {
        "entered": "2024-06-06T08:26:32.0000000+10:00",
        "exited": "2024-06-06T08:36:22.0000000+10:00",
        "location": {
            "latitude": -33.8808066,
            "longitude": 151.1954724
        },
        "address": "Ultimo, New South Wales"
    },
    {
        "entered": "2024-06-06T08:36:22.0000000+10:00",
        "exited": null,
        "location": {
            "latitude": -33.8793651,
            "longitude": 151.1949952
        },
        "address": "Glebe, New South Wales"
    }
]

API

Input parameters:

Sample code

Response