Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Overview
API Reference Overview
How to use the API 'Try It' feature
Authentication And Authorization (AAA) Service
Role Management
User Management
Authentication
Connection Management
Group Management
Participant Service
Tenant
Participant Type
Participant Type - Custom Code Config
Participant Type - Attributes Config
Participant Type - State Machine
Participant
Templates
Participant State
Participant - Batch Processing
Container Service
Container Type
Container Type - Custom Code Config
Container Type - Attributes Config
Container Type - State Machine Config
Container
Container State
Container Group
Container - Batch Processing
Dispatch Service
Job Type
Job Workflow
Job
Job - Config
Dispatch Type
Dispatch
Mobile APIs
Dispatch - Config
Ledger
Ledger in batch
Custom Code Config
Workflow Service
Execution Task
Changelog
Execution Macro
Execution Workflow
Execution Workflow Instance
Health Check
SDS Service
App
Vault
Data
File Management Service
Folders
Files
State Machine Service
State Machine Config
Entity
Events
Reasons
Instance State
Movement Tracking Service
Trace Data
Missing Sequence Numbers
Snapped Distance
IOT Device
Geofence
MTS Subscription
Entity Service
Entity Type
State Machine Config
Entity Instance
Entity Type - Custom Code Config
Entity Instance State
Templates
Entity - Batch Processing
Notification Service
App Notification
Filter
Event
Change Log
Location Service
Location
Country
State
City
Search
Order Service
Order Config
Order State Machine Configuration
Order State Machine Transition
Work Order State Machine Configuration
Work Order State Transition
Order
Batch Order
Custom Code Config
Plugin Callback
External Reference APIs
Work Order Config
Work Order Status
Plugins
PluginWorkflow
Address Service
Address Config
Address
User FPA
Users
Facility FPA
Facilities
Vehicle FPA
Vehicles
LogisticsOrder API
Order
Batch Order
AAA - External Authorizer
Authorization
Orchestrator
Plugins
PluginWorkflow
Rules
Get Entity Status
DLQ Service
Query & Listing
Default Plugins
Job Manager
Work Order Manager
Container Manager
Workflow Manager
Cancellation Manager
Scheduler Service
Scheduler Service
Docs powered by Archbee
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
UniqueId
*
Unique LocationId
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*
Unique RequestId
X-COREOS-TID
string
*
Tenant id
X-COREOS-USERINFO
string

core-os user info token

X-COREOS-ACCESS
string
*

core-os access token

BODY PARAMETERS
body
LocationUpdateRequest
*
Update a location
tags
object
address
Address
address type data type, which consists below fields.
geolocation
GeoCode
Example: {"lat":30.3752,"long":76.7821}
RESPONSES
200
OK
SuccessResponse
[All Of:object]
request
Request
data
object
400
Error Occurred
PutErrorResponse
[All Of:ErrorResponse]
error
Error
*
Error Information
request
Request
*
401
Error Occurred
PutErrorResponse
[All Of:ErrorResponse]
error
Error
*
Error Information
request
Request
*
403
Error Occurred
PutErrorResponse
[All Of:ErrorResponse]
error
Error
*
Error Information
request
Request
*
503
Error Occurred
PutErrorResponse
[All Of:ErrorResponse]
error
Error
*
Error Information
request
Request
*




Updated 27 Sep 2023
Did this page help you?
PREVIOUS
Create a new location
NEXT
Get location by location id
Docs powered by Archbee