Item Logo
Yms apiData modelsLocation

Location View

LocationView

Properties

Name

Type

Required

Constraints

Chinese Name

Description

locationId

string

false

none


Location ID

locationName

string

false

none


Location name

locationType

string

false

none


Location type (DOCK/SPOT/STAGING)

locationStatus

string

false

none


Location status (AVAILABLE/OCCUPIED/ASSIGNED)

assignedScore

integer

false

none


Assigned score, 0-100

enabled

boolean

false

none


Whether the location is enabled

yardActivity

string

false

none


none

dockActivity

string

false

none


none

locationActivities

[string]

false

none


Location activities list: LIVEDELIVERY/LIVELOAD/PRELOAD/SHARED/DROPOFFDELIVERY/DROPOFFEMPTY/PICKUPPRELOAD/PICKUPEMPTY/PARKING/DROPOFF_FULL

loadTaskType

string

false

none


Load task type: LIVELOAD/PRELOAD/ALL

carrierIds

[string]

false

none


Carrier IDs list

carrierNames

[string]

false

none


Carrier names list

customerIds

[string]

false

none


Customer IDs list

customerNames

[string]

false

none


Customer names list

stagingLocationIds

[string]

false

none


Staging Location IDs list<br />Used to store IDs of staging locations associated with dock-type locations

stagingLocationNames

[string]

false

none


Staging Location names list<br />Used to store names of staging locations associated with dock-type locations

allowedTypes

[string]

false

none


Allowed equipment types list<br />List of allowed equipment types, used for type filtering during location suggestions<br />If empty or null, no equipment type restrictions apply

companyCode

string

false

none


Company code: UT,UF,CUBEWORK

activeTimeFrom

string

false

none


Active time from

activeTimeTo

string

false

none


Active time to

notes

string

false

none


Notes

locationPhoto

string

false

none


Location photo

currentCarrierId

string

false

none


Current carrier ID

currentTaskType

string

false

none


Current task type

currentDriverId

string

false

none


Current driver ID

currentEntryId

string

false

none


Current Entry Ticket ID

arrivalTime

string

false

none


Arrival time

zoneTag

string

false

none


Zone tag

groupName

string

false

none


Location Group Name

createdTime

string

false

none


Created time

updatedTime

string

false

none


Updated time

currentDriveName

string

false

none


Current driver Name

currentCarrierName

string

false

none


Current carrier Name

dynamicFieldValues

[DynamicFieldValueView]

false

none


Dynamic field values

|displayName|string|false|none||Display name (limited to 4 characters) |

iotResult

DockIotResult

false

none


none

linkedLocations

[LinkedLocationView]

false

none


Linked locations list

sequenceNo

integer

false

none


none

deleted

boolean

false

none


none

windowConfigs

[LocationExtendConfigView]

false

none


Window configs list

currentWindowLocationActivities

[string]

false

none


Current window location activities<br />Location activities for the current time window (if any)<br />This is distinguished from the default locationActivities field

currentWindowCustomerIds

[string]

false

none


Current window customer IDs<br />Customer IDs for the current time window (if any)

currentWindowCustomerNames

[string]

false

none


Current window customer names<br />Customer names for the current time window (if any)

currentWindowCarrierIds

[string]

false

none


Current window carrier IDs<br />Carrier IDs for the current time window (if any)

currentWindowCarrierNames

[string]

false

none


Current window carrier names<br />Carrier names for the current time window (if any)

Enum Values

Property

Value

locationType

DOCK

locationType

SPOT

locationType

STAGING

locationType

LOCATION

locationStatus

AVAILABLE

locationStatus

OCCUPIED

locationStatus

DELETED

locationStatus

ASSIGNED

yardActivity

DROPOFFEMPTY

yardActivity

DROPOFFDELIVERY

yardActivity

PICKUPPRELOAD

yardActivity

PICKUPEMPTY

yardActivity

PARKING

yardActivity

SHARED

dockActivity

LIVE_DELIVERY

dockActivity

LIVE_LOAD

dockActivity

PRE_LOAD

dockActivity

SHARED

dockActivity

DROPOFFDELIVERY

loadTaskType

LIVE_LOAD

loadTaskType

PRE_LOAD

loadTaskType

ALL