Overview
This structure represents the unique key fields associated with identifying a user type. User Types can be identified by UserTypeName or UserTypeUid. When specifying a PwsUserTypeRef as an input to a web service, you may specify any combination of the two fields. However, if you do specify more than one, they must all refer to the same user type or the resource reference will not be considered valid. When a PwsUserTypeRef is returned in the response to a web service, the UserTypeName and UserTypeUid will be populated, and guaranteed to refer to a single user type.
Format
- PwsUserTypeRef
- UserTypeId: Int32
- UserTypeName: String
- UserTypeUid: Int64
Elements
Element | Data Type | Required? | Description | Sample Data |
|---|---|---|---|---|
UserTypeId | Int32 | No | The user type Id is a unique identifier for a user type. For internal use only. | |
UserTypeName | String | One of UserTypeName or UserTypeUID id is required | The user type name is a unique identifier for a user type | |
UserTypeUid | Int64 | See UserTypeName | A unique and immutable identifier for a user type |