Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This structure represents the unique key fields associated with identifying a resource title. Titles are used when requesting and booking resources during the resource scheduling workflow, in the determination of default billing. A title can be identified either by a unique identifier (UID), or the combination of department identity and name. The department identity or title name alone do not sufficiently identify a single title. When passing a title identity as input to a web service, you need only specify the unique identifier or the department identity and title name. You may specify all three values if you wish, but if you do so, they must all refer to the same title, or the reference will not be considered valid. When this structure is returned as part of the response from a web service, all fields will be specified, and will be guaranteed to refer to a single title.

Warning

In a slight variation from the typical ref structure format, if the title is identified in the instance of PwsTitleRef only by TitleName and not be by TitleId  or TitleUid, the DepartmentIdentity  must also be present and non-empty, because title names may not be unique across departments.  If DepartmentIdentity is not present or is empty when the title is otherwise identified only by TitleName , it will be as if the title is not found.


Format


Panel
titlePwsTitleRef
  • PwsTitleRef
    • DepartmentIdentity: PwsDepartmentRef
    • TitleId: Int32
    • TitleName: String
    • TitleUid: Int64

...

Element

Data Type

Required?

Description

Sample Data

DepartmentIdentity

PwsDepartmentRef

Yes The department associated with the resource titlewhen only TitleName  is used to identify the title.  No in all other circumstances.

The department identity and title name together are a unique identifier for a title.  Note also that DepartmentIdentity on its own may not identify a title, it can only identify a title in conjunction with TitleName .


TitleId

Int32

No

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


TitleName

String

One of TitleName or TitleUid is requiredNo

The department identity and title name is together are a unique identifier for a resource title (may be null, but once set can only be updated to a different, non-null value)title.

Level 3


TitleUid

Int64

See TitleNameNo

A unique and immutable identifier for a resource title title.

1152921504606885671


Usage Example(s)

...