update an existing location

1min

PUT
API for updating an exisitng Location. Partial update of address is not allowed. User needs to replace existing address.
ParameterDescriptionTypeValidation
tags
addressAddress data type which consists below fields.
ㅤ↳buildingNumberUpdated house number of the address.stringmaxLength: 16
ㅤ↳addressLine1Updated street information of the address.stringminLength: 1 maxLength: 128
ㅤ↳addressLine2An optional additional field for the updated street address.stringmaxLength: 128
ㅤ↳addressLine3Another optional additional field for the updated street address of the billing address.stringmaxLength: 128
ㅤ↳apartmentNumberThe Apartment Number of the address.string
ㅤ↳floorThe Floor Number of the addressstring
ㅤ↳cityUpdated city, town, or village of the address.stringpattern: It should match a through z or A through Z, inclusive (range)Also, it length must be between 2 to 64.
ㅤ↳stateUpdated state of the address.stringpattern: It should match a through z or A through Z, inclusive (range)Also, length should not be more than 64 characters.
ㅤ↳countydistrict or county of the address.stringpattern: It should match a through z or A through Z, inclusive (range)Also, max length allowed is 64 characters.
ㅤ↳zipCodeUpdated postal/zip code of the address.stringmaxLength: 10pattern: It should be alphanumeric.
ㅤ↳countryUpdated country consists code and name.
ㅤㅤㅤ↳code*The two-letter code for the country of the address.stringpattern: It should match A through Z, inclusive (range)Also, it must be at least 2 but not more than 3 times.
ㅤㅤㅤ↳name*The name of the country of the address.stringpattern: It should match a through z or A through Z, inclusive (range)Also, it must be at least 2 but not more than 64 times.
geolocationExample: OrderedMap { "latitude": "30.3752° N","longitude": "76.7821° E" }
ㅤ↳long*Updated range of longitude is -180 to 180.stringExample: 76.7821° E
ㅤ↳lat*Updated range of latitude is -90 to 90.stringExample: 30.3752° N
*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.
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
*
Body Parameters
body
LocationUpdateRequest
*
Description
Update a location
tags
object
address
Address
geolocation
GeoCode
Responses
200
OK
SuccessResponse
All Of
object  +
request
Request
data
object
400
Error Occurred
PutErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
401
Error Occurred
PutErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
403
Error Occurred
PutErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
503
Error Occurred
PutErrorResponse
All Of
ErrorResponse  +
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/locations/{locationId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "address": {
    "addressLine1": "",
    "city": "",
    "country": {
      "code": "",
      "name": ""
    }
  },
  "geolocation": {
    "long": "",
    "lat": ""
  }
}'
curl --location --globoff --request PUT 'https://{tenantSubDomain}.fxtrt.io/core/api/v1/locations/{locationId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "address": {
    "addressLine1": "",
    "city": "",
    "country": {
      "code": "",
      "name": ""
    }
  },
  "geolocation": {
    "long": "",
    "lat": ""
  }
}'
Responses
200
400
401
403
503
// OK 
{
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK 
{
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿

Parameter	Description	Type	Validation
`tags`
`address`	Address data type which consists below fields.
ㅤ↳`buildingNumber`	Updated house number of the address.	string	maxLength: 16
ㅤ↳`addressLine1`	Updated street information of the address.	string	minLength: 1 maxLength: 128
ㅤ↳`addressLine2`	An optional additional field for the updated street address.	string	maxLength: 128
ㅤ↳`addressLine3`	Another optional additional field for the updated street address of the billing address.	string	maxLength: 128
ㅤ↳`apartmentNumber`	The Apartment Number of the address.	string
ㅤ↳`floor`	The Floor Number of the address	string
ㅤ↳`city`	Updated city, town, or village of the address.	string	pattern: It should match a through z or A through Z, inclusive (range)Also, it length must be between 2 to 64.
ㅤ↳`state`	Updated state of the address.	string	pattern: It should match a through z or A through Z, inclusive (range)Also, length should not be more than 64 characters.
ㅤ↳`county`	district or county of the address.	string	pattern: It should match a through z or A through Z, inclusive (range)Also, max length allowed is 64 characters.
ㅤ↳`zipCode`	Updated postal/zip code of the address.	string	maxLength: 10pattern: It should be alphanumeric.
ㅤ↳`country`	Updated country consists code and name.
ㅤㅤㅤ↳`code`*	The two-letter code for the country of the address.	string	pattern: It should match A through Z, inclusive (range)Also, it must be at least 2 but not more than 3 times.
ㅤㅤㅤ↳`name`*	The name of the country of the address.	string	pattern: It should match a through z or A through Z, inclusive (range)Also, it must be at least 2 but not more than 64 times.
`geolocation`			Example: OrderedMap { "latitude": "30.3752° N","longitude": "76.7821° E" }
ㅤ↳`long`*	Updated range of longitude is -180 to 180.	string	Example: 76.7821° E
ㅤ↳`lat`*	Updated range of latitude is -90 to 90.	string	Example: 30.3752° N
*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.
503 - Service unavailable	Some unexpected error occurred.

Updated 27 Sep 2023

Did this page help you?

Create a new location

Get location by location id