0ne Record Docs
  • GENERAL OVERVIEW
    • Introduction
    • Before getting started
    • Changelog
    • Status
  • About the API
    • Environments
    • Versionning
      • Breaking change
    • Conditions & Limit
    • Pagination
    • Date Handling
    • Identifier
    • Filtering and Sorting
    • Groups
    • Troubleshooting
  • Security
    • Authentication
    • Authorization
  • REST API
    • Container
      • Get all container
      • Get a container by id
      • Create a container
      • Update a container
      • Delete a container
    • Container Type
      • Get all container type
      • Get a container type by type
      • Create a container type
      • Update a container type
      • Delete a container type
    • Country
    • Place
    • Shipment
      • Get all shipment
      • Get shipment by id
      • Create a shipment
      • Update a shipment
      • Delete a shipment
    • Shipment Anomaly
      • Get all shipment anomaly
      • Get a shipment anomaly by id
      • Create a shipment anomaly
      • Update a shipment anomaly
      • Delete a shipment anomaly
    • Shipment Anomaly Category
      • Get all shipment anomaly category
      • Get a shipment anomaly category by name
      • Create a shipment anomaly category
      • Delete a shipment anomaly category
    • Shipment Anomaly Type
      • Get all shipment anomaly type
      • Get a shipment anomaly type by code
      • Create a shipment anomaly type
      • Update a shipment anomaly type
      • Delete a shipment anomaly type
    • Shipment Customs
      • Get all shipment customs
      • Get shipment customs by id
      • Create a shipment customs
      • Update a shipment customs
      • Delete a shipment customs
    • Shipment Customs Type
      • Get all shipment customs type
      • Get shipment customs type by name
    • Shipment Detail
      • Get all shipment detail
      • Get shipment detail by id
    • Shipment Document
      • Get all shipment document
      • Get shipment document by id
      • Create a shipment document
      • Delete a shipment document
    • Shipment Event
      • Get all shipment events
      • Get shipment event by id
      • Create a shipment event
      • Update a shipment event
      • Delete a shipment event
    • Shipment Event Type
      • Get all shipment event type
      • Get shipment event type by name
    • Shipment Operator
      • Get all shipment operator
      • Get shipment operator by id
      • Create a shipment operator
      • Update a shipment operator
      • Delete a shipment operator
    • Shipment Preparation
      • Get all shipment preparation
      • Get shipment preparation by id
      • Create a shipment preparation
      • Update a shipment preparation
      • Delete a shipment preparation
    • Shipment Security
      • Get all shipment security
      • Get shipment security
      • Create a shipment security
      • Update a shipment security
      • Delete a shipment security
    • Shipment Security Type
      • Get all shipment security type
      • Get shipment security type by code
    • Shipment Service
      • Get all shipment service
      • Get shipment service by id
      • Create a shipment service
      • Update a shipment service
      • Delete a shipment service
    • Shipment Service Type
      • Get all shipment service type
      • Get shipment service type by id
      • Create a shipment service type
      • Update shipment service type
      • Delete a shipment service type
    • Society Subscription
      • Get all society subscription
      • Get a society subscription by id
      • Create a society subscription
      • Update a society subscription
      • Delete a society subscription
  • Notification
    • Webhook
      • Request
      • Restriction & Limitation
      • Supported Authentication Methods
      • Payload signature
    • SocketIO
      • Environments
      • Authentication
      • Authorization
      • Namespaces
        • Shipment Notification Namespace
      • Handling Errors
    • Example payload
      • Shipment payload
      • Shipment event payload
      • Shipment operator
Powered by GitBook
On this page
  1. REST API

Place

PreviousCountryNextShipment

Last updated 8 months ago

About

The Place Code system employs a standardized three-letter abbreviation to ensure consistent and accurate identification of specific locations, including cities, towns, and significant landmarks across the globe.

Each code, consisting of three alphabetical letters (e.g., "NYC" for New York City), facilitates uniformity in international data exchanges, geographic information systems, and various applications that necessitate precise location identification.

This system aids in streamlining communication and data processing by providing a concise, universally recognized format for referencing a wide range of geographic entities, thereby enhancing efficiency in global logistics, travel planning, and international commerce.

One Record API uses the IATA three-letter location identifier to identify airports. E.g. Tokyo-Narita International Airport will be identified by NRT.

To avoid confusion, a will be identified by a two-letter code.

Groups

To understand the groups parameter and the customization of API responses, please refer to the .

List of groups

  • country - to retrieve information about the country.

Endpoints

Everyone can view these resources

country
groups page

Get all places

get

Get all places

Authorizations
Query parameters
page[cursor]stringOptional
page[limit]any · min: 2 · max: 200Optional
order[column]stringOptionalExample: column_name
order[direction]stringOptionalExample: asc|desc
Responses
get
GET /place HTTP/1.1
Host: api.one-record.fr
Authorization: Bearer JWT
Accept: */*

{
  "data": [
    {
      "code": "text",
      "country": "AD",
      "name": "text",
      "icao": "text",
      "state": "text",
      "latitude": 1,
      "longitude": 1,
      "timezone": "text",
      "type": "airport",
      "createdAt": null,
      "updatedAt": null
    }
  ],
  "metadata": {
    "count": 1,
    "current": "text",
    "next": "text"
  }
}

Get a place

get

Get a place

Authorizations
Path parameters
codestringRequired
Responses
get
GET /place/{code} HTTP/1.1
Host: api.one-record.fr
Authorization: Bearer JWT
Accept: */*

{
  "code": "text",
  "country": "AD",
  "name": "text",
  "icao": "text",
  "state": "text",
  "latitude": 1,
  "longitude": 1,
  "timezone": "text",
  "type": "airport",
  "createdAt": null,
  "updatedAt": null
}
  • About
  • Groups
  • Endpoints
  • GETGet all places
  • GETGet a place