GET /api/v1/team-members/{publicUserId}/reports/stops
Retrieve Team Member Stops Reports
This endpoint retrieves the stops reports for a specific team member for a given trip date.
Request Method: GET
URL: https://api.locate2u.com/api/v1/team-members/{publicUserId}/reports/stops
Input parameters:
publicUserId
Required* publicUserId (string) in the path which is the Public identifier for the team-member/user.
tripDate
Optional query parameter, Type : string ($date) with format “yyyy-MM-dd”
Specifies the trip date of the Stops report.
Sample code
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.locate2u.com/api/v1/team-members/{publicUserId}/reports/stops?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/stops?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/stops?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/stops?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/stops?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 an array of JSON objects with the following properties:
dateTime (string): The date and time of the stop.
location (object):
latitude (number): The latitude of the stop location.
longitude (number): The longitude of the stop location.
address (string): The address of the stop location.
stopTimeMinutes (number): The duration of the stop in minutes.
Example Response:
JSON
[
{
“dateTime”: “”,
“location”: {
“latitude”: 0,
“longitude”: 0
},
“address”: “”,
“stopTimeMinutes”: 0
}
]
Sample response:
[
{
"dateTime": "2024-06-06T08:27:32.0000000+10:00",
"location": {
"latitude": -33.8816646,
"longitude": 151.1961871
},
"address": "Kelly Street, Ultimo",
"stopTimeMinutes": 3.8333333333333335
},
{
"dateTime": "2024-06-06T08:39:22.0000000+10:00",
"location": {
"latitude": -33.8743593,
"longitude": 151.1874427
},
"address": "Ferry Road, Glebe",
"stopTimeMinutes": null
}
]