PwsLocationRef

Overview

This structure contains the unique key fields associated with a location. Locations can be identified by LocationName or LocationUid. When specifying a PwsLocationRef as an input to a web service, you may specify one or both of LocationName and LocationUid. However, if you do specify both, they must both refer to the same location or the location reference will not be considered valid. When a PwsLocationRef is returned in the response to a web service, both the LocationName or LocationUid will be populated, and guaranteed to refer to a single location.


Format

PwsLocationRef
  • PwsLocationRef
    • LocationId: Int32
    • LocationName: String (50)
    • LocationUid: Int64

Elements

Element

Data Type

Required?

Description

Sample Data

LocationId

Int32

No

The location Id is a unique identifier for a location. For internal use only.


LocationName

String (50)

One of LocationName or LocationUid is required

The name of the location is a unique identifier for a location.

 Springfield

LocationUid

Int64

See LocationName

A unique and immutable identifier for a location.

 1152921504606850978

Usage Example(s)


Example 01
   <b:LocationIdentity>
       <b:LocationId i:nil="true"/>
       <b:LocationName>Springfield</b:LocationName>
       <b:LocationUid>1152921504606850978</b:LocationUid>
   </b:LocationIdentity>