PwsLocationSummary

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 deemed to be useful in a listing of locations.

Format


PwsLocationSummary
  • 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

PwsCurrencyRef

On Insert: Yes

On Update: No


The currency associated with the location. Projector can deal with many worldwide currencies, however a single account is typically configured to deal in one or a small number of currencies. CurrencyIdentity identifies the account specific currency, Each account-specific currency is linked to a Projector-wide currency.


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 associated with the location.

OpsCurrencyIdentity

PwsOpsCurrencyRef

On Insert: Yes

On Update: No


The ops currency associated with the location. Projector can deal with many worldwide currencies, however a single account is typically configured to deal in one or a small number of currencies. OpsCurrencyIdentity identifies the Projector-wide currency,


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 

Usage Example(s)


Example 01
                 <b:PwsLocationSummary>
                     <b:LocationId i:nil="true"/>
                     <b:LocationName>USA</b:LocationName>
                     <b:LocationUid>1152921504606855985</b:LocationUid>
                     <b:CurrencyIdentity>
                        <b:CurrencyCode>USD</b:CurrencyCode>
                        <b:CurrencyId i:nil="true"/>
                        <b:CurrencyUid>1152921504606851838</b:CurrencyUid>
                     </b:CurrencyIdentity>
                     <b:InactiveFlag>false</b:InactiveFlag>
                     <b:MileageUom>M</b:MileageUom>
                     <b:OpsCurrencyIdentity>
                        <b:OpsCurrencyCode>USD</b:OpsCurrencyCode>
                        <b:OpsCurrencyId i:nil="true"/>
                     </b:OpsCurrencyIdentity>
                     <b:EnabledForCostcardsFlag>true</b:EnabledForCostcardsFlag>
                     <b:EnabledForProjectsFlag>true</b:EnabledForProjectsFlag>
                     <b:EnabledForResourcesFlag>true</b:EnabledForResourcesFlag>
                     <b:EnabledForTimecardsFlag>true</b:EnabledForTimecardsFlag>
                  </b:PwsLocationSummary>