1. Locations
  • Introduction
  • Getting Started
  • Authentication
  • Error Handling
  • Contact Support
  • Modaltrans API
    • Get Auth Token
      • Get Bearer Token
    • Accounting
      • Invoices
        • Retrieve an Invoice
        • List all Invoices
    • Customs
      • NCTS Declarations
        • List all NCTS Declarations
        • Retrieve an NCTS Declaration
        • Create an NCTS Declaration with XML Data
        • Create an Ens Declaration from JSON
        • Update an NCTS Declaration
        • Download an NCTS Declaration
        • List Timelines of NCTS Declaration
        • List Messages of NCTS Decalaration
      • Customs Declarations
        • List all Customs Declarations
        • Retrieve a Custom Declaration
        • Create a Customs Declaration
        • Update a Custom Declaration
        • Delete a Custom Declaration
        • Retrieve a Declaration History
        • Retrieve an MRN Status of Declaration
      • Declaration Requests
        • List all Declaration Orders
        • Retrieve a Declaration Request
        • Create a Declaration Request
        • Update a Declaration Request
        • Delete a Declaration Request
    • Logistics
      • Bookings
        • Retrieve a Booking
        • List all Bookings
        • Create a Booking
        • Update a Booking
      • Locations
        • List all Locations
          GET
        • Retrieve a Location
          GET
      • Positions
        • Update a Transport
      • Tracking
        • Available Shipping Lines
        • Retrieve a Tracking Data
        • Subscribe to Tracking
      • Shipments
        • Retrieve a Shipment
        • List All Shipments
        • Retrieve Financials of Shipment
        • List Contacts of the Shipment
        • Create a Shipment
        • Update a Shipment
    • Depot
      • Orders
        • Retrieve an Order
        • List all Orders
        • Create an Order
        • Update an Order
      • Products
        • Retrieve a Product
        • List all Products
        • Create a Product
        • Update a Product
        • List Product Stocks
      • Inventories
        • List all Inventories
    • Fleet Management
      • Drivers
        • Retrieve a Driver
        • Retrieve a Driver's Vehicle
        • List Driver Positions
        • Update a Driver
      • Vehicles
        • Retrieve a Vehicle
        • Update a Vehicle
      • Gps Service Controller
        • Create Gps Responses
      • Service Logs
        • List all Service Logs
        • Retrieve a Service Log
        • Create a Service Log
        • Delete a Service Log
        • Update a Service Log
      • Periodic Documents
        • Retrieve a Periodic Document
        • Update a Periodic Document
        • Create a Periodic Document
    • CRM
      • Companies
        • List all Companies
        • Retrieve a Company
        • Create a Company
        • Update a Company
        • Delete a Company
    • Timelines
      • Retrieve a Timeline
      • List Timelines
      • Create a Timeline
    • S3 Files
      • List all S3Files
      • Create an S3File
      • Delete an S3File
    • Notifications
      • List all Notifications
      • Update a Notification Status
    • User Details
      • List User Details
      • Update User Details
  1. Locations

Retrieve a Location

Developing
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
GET
/api/v1/places/{place_id}
Retrieves Location Details by its place ID.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
place_id
integer 
required
Place ID of the location

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.modaltrans.com/api/v1/places/'

Responses

🟢200OK
application/json
Body
array of:
id
integer 
required
ID of the location.
code
string 
required
Code of the location.
name
string 
required
Name of the location.
place_type
string 
required
Type of the place
address
string 
required
Address of the location.
city_name
string  | null 
required
City name of the location
country_id
string 
required
Country ID of the location
patron_id
integer 
required
Patron ID associated with the location.
lat
number 
required
Latitude coordinate of the location.
lng
number 
required
Longitude coordinate of the location.
created_at
string <date-time>
required
Timestamp when the location record was created.
updated_at
string <date-time>
required
Timestamp when the location record was last updated.
gmaps_id
string 
required
Google Maps ID of the location.
gmaps_title
string 
required
Title of the location on Google Maps.
website
string  | null 
required
Website URL of the location.
email
string 
required
Email address associated with the location.
notes
string 
required
Additional notes about the location.
local_name
string 
required
Local name of the location.
w3w
string 
required
What3words address of the location.
company_id
integer 
required
ID of the company associated with the location.
city_id
integer 
required
ID of the city where the location is situated.
tel
string 
required
Telephone number of the location.
opening_info
string 
required
Working hours of the location.
office_roles
string 
required
Address roles of the location.
border_countries
string 
required
Bordering countries of the location.
status
string 
required
Operational status of the location.
post_code
string 
required
Postal code of the location.
district
string 
required
District where the location is situated.
geom
string 
required
Geometrical data of the location.
contact_id
integer 
required
Contact ID of the location.
contact_name
string 
required
Name of the contact person at the location.
tenant_id
integer 
required
Tenant ID associated with the location.
maersk_service_id
string 
required
Maersk service ID associated with the location.
s3files_count
integer 
required
Count of S3 files related to the location.
state_name
string 
required
State name where the location is situated.
main_place_id
integer 
required
Main place ID associated with the location.
color
string 
required
Bootstrap's colour code associated with the location.
score
integer 
required
Score or rating of the location.
Example
[
    {
        "id": 0,
        "code": "string",
        "name": "string",
        "place_type": "string",
        "address": "string",
        "city_name": "string",
        "country_id": "string",
        "patron_id": 0,
        "lat": 0,
        "lng": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "gmaps_id": "string",
        "gmaps_title": "string",
        "website": "string",
        "email": "string",
        "notes": "string",
        "local_name": "string",
        "w3w": "string",
        "company_id": 0,
        "city_id": 0,
        "tel": "string",
        "opening_info": "string",
        "office_roles": "string",
        "border_countries": "string",
        "status": "string",
        "post_code": "string",
        "district": "string",
        "geom": "string",
        "contact_id": 0,
        "contact_name": "string",
        "tenant_id": 0,
        "maersk_service_id": "string",
        "s3files_count": 0,
        "state_name": "string",
        "main_place_id": 0,
        "color": "string",
        "score": 0
    }
]
🟠400Bad Request
🟠403Forbidden
🟠404Record Not Found
Modified at 2024-08-23 13:31:25
Previous
List all Locations
Next
Update a Transport
Built with