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
  • Overview
  • Date and Time Format
  • Timezone Handling
  1. About the API

Date Handling

Overview

One Record API handles date and time information, including the format used and how timezones are managed. For correctly formatting date and time data in requests and interpreting responses, the API follows ISO 8601 format.

Date and Time Format

One Record API uses the ISO 8601 format for all date and time information. This format is internationally recognized and ensures clear, unambiguous communication of date and time data. 

YYYY-MM-DDThh:mm:ssZ

  • YYYY is the four-digit year.

  • MM is the two-digit month.

  • DD is the two-digit day.

  • T is a literal character separating the date and time components.

  • hh is the two-digit hour (24-hour clock).

  • mm is the two-digit minute.

  • ss is the two-digit second.

  • Z indicates that the time is in Coordinated Universal Time (UTC). If the time is not in UTC, a timezone offset replaces Z, formatted as +hh:mm or -hh:mm.

A date without time can use the short YYYY-MM-DD format.

Timezone Handling

Default Timezone

In the absence of a timezone offset, One Record API treats the date and time as being in Greenwich Mean Time (GMT). This convention is adopted for simplicity and to provide a consistent baseline across different timezones.

Specifying Timezone Offsets

Specifying a timezone, include the offset from UTC in the date and time string, can be done using the format +hh:mm or -hh:mm. Here are examples to illustrate both cases:

  • With Timezone Offset: 2024-03-16T12:00:00+01:00 — This indicates that the time is one hour ahead of UTC.

  • Without Timezone Offset (Assumed GMT): 2024-03-16T11:00:00 — Without an offset, the time is assumed to be GMT.

UTC and GMT

For One Record API, GMT and UTC are considered equivalent. However, to eliminate any ambiguity, it is recommend to use Z to explicitly denote UTC for times that are in Coordinated Universal Time, e.g. 2024-03-16T11:00:00Z.

PreviousPaginationNextIdentifier

Last updated 1 year ago