GET /api/v1/stops/{id}/notes - Locate2u Developers

GET /api/v1/stops/{id}/notes

Retrieve Stop Notes.

This endpoint retrieves the notes associated with a specific stop.

Request Endpoint:

GET https://api.locate2u.com/api/v1/stops/{id}/notes

Input Parameters:

id

id * required integer($int32)(path)

This id here is the unique stop id for stop in your Locate2u account. This is required in order to get the details of notes of a particular stop in the system. Notes are primarily job descriptions, delivery instructions and documents (e.g. photo or docs) for Proof of delivery or normal stop documents.

Sample code

Java

NodeJS

PHP

Python

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.locate2u.com/api/v1/stops/5176243/notes");
request.Headers.Add("Authorization", "Bearer yourBearerToken");
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/stops/5176243/notes")
  .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/stops/5176243/notes',
  '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/stops/5176243/notes',
  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/stops/5176243/notes"


payload = {}
headers = {
  'Authorization': 'Bearer yourBearerTokenHere'
}
response = requests.request("GET", url, headers=headers, data=payload)


print(response.text)

Response

Status: 200
Content-Type: application/json

The response will contain an array of note objects, each including details such as the note ID, creator, note content, creation date, photo URLs, document URLs, type, and rating. Some fields may be null if not applicable.
Example response text will look like:

[
   {
       "stopId": 0,
       "createdBy": "",
       "noteId": 0,
       "note": "",
       "createdDate": "",
       "createdByUserFullName": "",
       "photoFileName": null,
       "createdByPhotoUrl": null,
       "photoUrls": [
           {
               "photoUrl": "",
               "thumbnailUrl": "",
               "photoName": ""
           }
       ],
       "documentUrls": [
           {
               "photoUrl": "",
               "thumbnailUrl": "",
               "photoName": ""
           }
       ],
       "hasPhotos": null,
       "photoList": "",
       "type": "",
       "rating": null,
       "stopContactName": null,
       "stopAddress": null,
       "metadata": null
   }
]

API

Input Parameters:

Sample code

Response

Response