Location Service
Location

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
*
Header Parameters
X-COREOS-REQUEST-ID
*
X-COREOS-TID
*
X-COREOS-USERINFO
X-COREOS-ACCESS
*
Body Parameters
body
*
Description
Update a location
tags
address
geolocation
Responses
200
OK
All Of
object +
request
data
400
Error Occurred
All Of
ErrorResponse +
error
*
request
*
401
Error Occurred
All Of
ErrorResponse +
error
*
request
*
403
Error Occurred
All Of
ErrorResponse +
error
*
request
*
503
Error Occurred
All Of
ErrorResponse +
error
*
request
*
Curl
JS
Ruby
Python
Responses
200
400
401
403
503