Overview
This structure includes basic information about a location. The information represented in this structure is not comprehensive and only includes certain key attributes of a location to be useful in a listing of locations.
Format
- PwsLocationSummary
- LocationId: Int32
- LocationName: String (50)
- LocationUid: Int64
- CurrencyIdentity: PwsCurrencyRef
- InactiveFlag: Boolean
- MileageUom: String
- OpsCurrencyIdentity: PwsOpsCurrencyRef
- EnabledForCostcardsFlag: Boolean
- EnabledForProjectsFlag: Boolean
- EnabledForResourcesFlag: Boolean
- EnabledForTimecardsFlag: Boolean
Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
LocationId | Int32 | No |
| The location Id is a unique identifier for a locatioin. For internal use only |
|
LocationName | String (50) | One of LocationName or LocationUid is required |
| The location name is a unique identifier for a location | USA
|
LocationUid | Int64 | See LocationName |
| The location Uid is a unique and immutable identifier for a location | 1152921504606855985 |
CurrencyIdentity | On Insert: Yes On Update: No |
| The currency associated with the location |
| |
InactiveFlag | Boolean | No | false | If set to 'true', the location is marked as inactive | false |
MileageUom | String | On Insert: Yes On Update: No |
| The mileage unit of measure is associated with the location | M |
OpsCurrencyIdentity | On Insert: Yes On Update: No |
| The currency associated with the location |
| |
EnabledForCostcardsFlag | Boolean | No | true | If set to 'true', the location is enabled for cost cards | true |
EnabledForProjectsFlag | Boolean | No | true | If set to 'true', the location is enabled for projects | true |
EnabledForResourcesFlag | Boolean | No | true | If set to 'true', the location is enabled for resources | true |
EnabledForTimecardsFlag | Boolean | No | true | If set to 'true', the location is enabled for time cards | true |