Get location by location id

1min

GET
API for getting location details by location id:
Header/PathDescriptionType
X-COREOS-REQUEST-ID* (header)Unique RequestIdstring
locationId* (path)Unique LocationId.string
*This is required.
HTTP Status Code Summary
CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
403 - ForbiddenUser is not allowed to perform operation.
404 - Not FoundThe requested resource doesn't exist.
503 - Service unavailableSome unexpected error occurred.
Path Parameters
locationId
UniqueId
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-USERINFO
string
X-COREOS-ACCESS
string
*
Responses
200
OK
LocationGetResponse
data
LocationResponse
request
Request
400
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
401
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
403
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
404
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
503
Error Occurred
GetErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/locations/{locationId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/locations/{locationId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
403
404
503
// OK 
{
  "data": {
    "tags": {},
    "tenantId": "712783336774",
    "locationId": "",
    "similarLocationInfo": {
      "similarLocationId": "",
      "description": ""
    },
    "isValidated": false,
    "address": {
      "buildingNumber": "",
      "addressLine1": "",
      "addressLine2": "",
      "addressLine3": "",
      "apartmentNumber": "",
      "floor": "",
      "county": "",
      "city": "",
      "state": "",
      "zipCode": "",
      "country": {
        "code": "IN",
        "name": "india"
      }
    },
    "geolocation": {
      "long": "",
      "lat": ""
    },
    "createdAt": "",
    "createdBy": {
      "id": "",
      "name": "",
      "appId": ""
    },
    "updatedAt": "",
    "updatedBy": {
      "id": "",
      "name": "",
      "appId": ""
    }
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// OK 
{
  "data": {
    "tags": {},
    "tenantId": "712783336774",
    "locationId": "",
    "similarLocationInfo": {
      "similarLocationId": "",
      "description": ""
    },
    "isValidated": false,
    "address": {
      "buildingNumber": "",
      "addressLine1": "",
      "addressLine2": "",
      "addressLine3": "",
      "apartmentNumber": "",
      "floor": "",
      "county": "",
      "city": "",
      "state": "",
      "zipCode": "",
      "country": {
        "code": "IN",
        "name": "india"
      }
    },
    "geolocation": {
      "long": "",
      "lat": ""
    },
    "createdAt": "",
    "createdBy": {
      "id": "",
      "name": "",
      "appId": ""
    },
    "updatedAt": "",
    "updatedBy": {
      "id": "",
      "name": "",
      "appId": ""
    }
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿

Header/Path	Description	Type
`X-COREOS-REQUEST-ID`* (header)	Unique RequestId	string
`locationId`* (path)	Unique LocationId.	string
*This is required.

HTTP Status Code Summary

Code	Description
200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
403 - Forbidden	User is not allowed to perform operation.
404 - Not Found	The requested resource doesn't exist.
503 - Service unavailable	Some unexpected error occurred.

Updated 27 Sep 2023

Did this page help you?

update an existing location

Get All countries.