Time Zone

Retrieves the local time for a given address

This endpoint retrieves the local time of any location in the world for a given address. The input and retrieved time format is in milliseconds.

post/v1/timezone/address

Request

Base URL: https://api.cloud.precisely.com
URL: https://api.cloud.precisely.com/v1/timezone/address
Auth: one of:
- HTTP bearer
- API key in header Authorization

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.

Request body

Example request

{
  "addresses": [
    {
      "timestamp": 1691138974843,
      "address": {
        "addressLines": [
          "123 Main St",
          "HASTINGS MN, United States"
        ],
        "admin1": "Minnesota",
        "admin2": "Dakota County",
        "city": "HASTINGS",
        "borough": "Ward 5",
        "suburb": "Downtown",
        "postalCode": "55033",
        "postalCodeExt": "8012",
        "placeName": "Central Plaza",
        "country": "USA",
        "id": "1"
      }
    }
  ],
  "preferences": {
    "maxResults": 1,
    "returnAllInfo": true,
    "factoryDescription": {
      "label": "asd",
      "featureSpecific": {
        "LOOKUP": "ggs"
      }
    },
    "customPreferences": {
      "DATA_OPTION": "PREMIUM"
    },
    "clientLocale": {
      "language": "en",
      "script": "Latn",
      "country": "US",
      "variant": "POSIX",
      "unicodeLocaleAttributes": [
        "attribute1",
        "attribute2"
      ],
      "unicodeLocaleKeys": {
        "nu": "thai"
      },
      "extensionKeys": {
        "x": "private-use"
      }
    },
    "clientCoordSysName": "EPSG:4326",
    "distance": {
      "value": 5,
      "distanceUnit": "METER"
    },
    "streetOffset": {
      "value": 5,
      "distanceUnit": "METER"
    },
    "cornerOffset": {
      "value": 5,
      "distanceUnit": "METER"
    },
    "matchMode": "EXACT",
    "originXY": [
      0,
      0
    ],
    "returnOfAdditionalFields": [
      "RESULT_CODE",
      "PRECISION_CODE"
    ]
  }
}

Response

Timezone Retrieved Successfully For An Address

Example response

{
  "responses": [
    {
      "id": "16",
      "status": "OK",
      "code": "DIS-1003",
      "detail": "Issue with internal services",
      "timezone": {
        "timezoneName": "Mountain Time (MST/MDT)",
        "zoneType": "America/Denve",
        "utcOffset": -25200000,
        "dstOffset": 3600000,
        "timestamp": 1691138974831
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.