EntityPhoneContract

Name EntityPhoneContract
Usage IdentityService
EntityTypeContactInfo
Type Complex

Description

This is a contract for EntityPhone and represents the
phone information of an Entity.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
entityId Entity Id String Gets this id of the parent identity object.     One No  
entityTypeCode Entity Type Code String Gets this entityTypeCode of the {@link EntityPhoneContract}'s object.     One No  
phoneType Phone Type CodedAttributeContract Gets this {@link EntityPhone}'s type code.     One No  
phoneNumber Phone Number String Gets this {@link EntityPhone}'s phone number.     One No  
extensionNumber Extension Number String Gets this {@link EntityPhone}'s extension number.     One No  
countryCode Country Code String Gets this {@link EntityPhone}'s country code.     One No  
phoneNumberUnmasked Phone Number Unmasked String Gets this {@link EntityPhone}'s unmasked phone number.     One No  
extensionNumberUnmasked Extension Number Unmasked String Gets this {@link EntityPhone}'s unmasked extension number.     One No  
countryCodeUnmasked Country Code Unmasked String Gets this {@link EntityPhone}'s unmasked country code.     One No  
formattedPhoneNumber Formatted Phone Number String Gets this {@link EntityPhone}'s formatted phone number.     One No  
formattedPhoneNumberUnmasked Formatted Phone Number Unmasked String Gets this {@link EntityPhone}'s unmasked formatted phone number.     One No  
suppressPhone Suppress Phone boolean Returns a boolean value that determines if phone fields should be suppressed.     One No  
objectId Object Id String Return the globally unique object id of this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.		     One No  
id Id String The unique identifier for an object. This can be null.     One No  
active Active boolean The active indicator for an object.     One No  
versionNumber Version Number Long Returns the version number for this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.
This version number is generally used for the purposes of optimistic locking.		     One No  
defaultValue Default Value boolean The default value for this object.     One No