Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Overview


This structure is used to uniquely identify a department. Departments can be identified by DepartmentName or DepartmentUid. When specifying a PwsDepartmentRef as an input to a web service, you may specify one or both fields, DepartmentName and/or DepartmentUid. However, if you do specify more than one field, both values must refer to the same department or the department reference will not be considered valid. When a PwsDepartmentRef is returned in the response to a web service, the DepartmentName and DepartmentUid will be populated, and guaranteed to refer to a single department.

Format


PwsDepartmentRef
  • PwsDepartmentRef
    • DepartmentId: Int32
    • DepartmentName: String (50)
    • DepartmentUid: Int64

Elements


Element

Data Type

Required?

Default

Description

Sample Data

DepartmentId

Int32

No


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


DepartmentName

String (50)

One of DepartmentName or DepartmentUid is required


The department name is a unique identifier for a department


DepartmentUid

Int64

See DepartmentName


The department Uid is a unique and immutable identifier for a department


Usage Example(s)

Example 01
                       <com:DepartmentIdentity>
                           <com:DepartmentName>Executive Team</com:DepartmentName>
                           <com:DepartmentUid>1152921504606854181</com:DepartmentUid>
                        </com:DepartmentIdentity>
  • No labels