/* Options: Date: 2026-04-03 23:30:14 Version: 8.52 Tip: To override a DTO option, remove "//" prefix before updating BaseUrl: https://pfapi.pstpf.com.au/api //Package: //GlobalNamespace: dtos //AddPropertyAccessors: True //SettersReturnThis: True //AddServiceStackTypes: True //AddResponseStatus: False //AddDescriptionAsComments: True //AddImplicitVersion: IncludeTypes: GetUserProfiles.* //ExcludeTypes: //TreatTypesAsStrings: //DefaultImports: java.math.*,java.util.*,java.io.InputStream,net.servicestack.client.* */ import java.math.*; import java.util.*; import java.io.InputStream; import net.servicestack.client.*; public class dtos { /** * Returns a Users profile information. */ @Route(Path="/profiles") @Api(Description="Returns a Users profile information.") public static class GetUserProfiles implements IReturn { /** * The user's Guid. If the value passed is empty, UserName must be entered. */ @ApiMember(DataType="Guid?", Description="The user's Guid. If the value passed is empty, UserName must be entered.", Name="UserId", ParameterType="query") public UUID UserId = null; /** * Unique Email address of the user. If the value passed is empty, UserId must be entered. */ @ApiMember(DataType="string", Description="Unique Email address of the user. If the value passed is empty, UserId must be entered.", Name="UserName", ParameterType="query") public String UserName = null; /** * Flag to exclude contact details from organisation profiles. */ @ApiMember(DataType="bool", Description="Flag to exclude contact details from organisation profiles.", Name="ExcludeContactDetails", ParameterType="query") public Boolean ExcludeContactDetails = null; public UUID getUserId() { return UserId; } public GetUserProfiles setUserId(UUID value) { this.UserId = value; return this; } public String getUserName() { return UserName; } public GetUserProfiles setUserName(String value) { this.UserName = value; return this; } public Boolean isExcludeContactDetails() { return ExcludeContactDetails; } public GetUserProfiles setExcludeContactDetails(Boolean value) { this.ExcludeContactDetails = value; return this; } private static Object responseType = UserProfilesWithRolesModel.class; public Object getResponseType() { return responseType; } } public static class UserProfilesWithRolesModel { /** * A list of profiles for the user. */ @ApiMember(DataType="List", Description="A list of profiles for the user.", Name="Profiles") public ArrayList Profiles = null; public ArrayList getProfiles() { return Profiles; } public UserProfilesWithRolesModel setProfiles(ArrayList value) { this.Profiles = value; return this; } } public static class UserRoleModel { /** * The Contact Role Id, that links the Contact to their role. */ @ApiMember(DataType="Guid", Description="The Contact Role Id, that links the Contact to their role.", Name="ContactRoleId", ParameterType="query") public UUID ContactRoleId = null; /** * The Role Id. */ @ApiMember(DataType="Guid", Description="The Role Id.", Name="RoleId", ParameterType="query") public UUID RoleId = null; /** * The role name. */ @ApiMember(DataType="string", Description="The role name.", Name="RoleName", ParameterType="query") public String RoleName = null; /** * The URL of the role's image icon. */ @ApiMember(DataType="string", Description="The URL of the role's image icon.", Name="RolePrimaryImageURL", ParameterType="query") public String RolePrimaryImageURL = null; /** * The URL of the role's thumbnail image icon. */ @ApiMember(DataType="string", Description="The URL of the role's thumbnail image icon.", Name="RolePrimaryImageThumbnailURL", ParameterType="query") public String RolePrimaryImageThumbnailURL = null; /** * The Guid of the role's media file containing the image icon details. */ @ApiMember(DataType="string", Description="The Guid of the role's media file containing the image icon details.", Name="RolePrimaryImageId", ParameterType="query") public UUID RolePrimaryImageId = null; /** * The date the contact started having this role. */ @ApiMember(DataType="DateTime", Description="The date the contact started having this role.", Name="StartDate", ParameterType="query") public Date StartDate = null; /** * The date the contact will end having this role. */ @ApiMember(DataType="DateTime?", Description="The date the contact will end having this role.", Name="EndDate", ParameterType="query") public Date EndDate = null; public UUID getContactRoleId() { return ContactRoleId; } public UserRoleModel setContactRoleId(UUID value) { this.ContactRoleId = value; return this; } public UUID getRoleId() { return RoleId; } public UserRoleModel setRoleId(UUID value) { this.RoleId = value; return this; } public String getRoleName() { return RoleName; } public UserRoleModel setRoleName(String value) { this.RoleName = value; return this; } public String getRolePrimaryImageURL() { return RolePrimaryImageURL; } public UserRoleModel setRolePrimaryImageURL(String value) { this.RolePrimaryImageURL = value; return this; } public String getRolePrimaryImageThumbnailURL() { return RolePrimaryImageThumbnailURL; } public UserRoleModel setRolePrimaryImageThumbnailURL(String value) { this.RolePrimaryImageThumbnailURL = value; return this; } public UUID getRolePrimaryImageId() { return RolePrimaryImageId; } public UserRoleModel setRolePrimaryImageId(UUID value) { this.RolePrimaryImageId = value; return this; } public Date getStartDate() { return StartDate; } public UserRoleModel setStartDate(Date value) { this.StartDate = value; return this; } public Date getEndDate() { return EndDate; } public UserRoleModel setEndDate(Date value) { this.EndDate = value; return this; } } public static class UserContactConnectionModel { /** * The Contact Role Id, that links the Contact to their role. */ @ApiMember(DataType="Guid", Description="The Contact Role Id, that links the Contact to their role.", Name="ContactRoleId", ParameterType="query") public UUID ContactRoleId = null; /** * The role name. */ @ApiMember(DataType="string", Description="The role name.", Name="ContactRoleName", ParameterType="query") public String ContactRoleName = null; /** * The list item role Id. */ @ApiMember(DataType="Guid", Description="The list item role Id.", Name="ContactListItemRoleId", ParameterType="query") public UUID ContactListItemRoleId = null; /** * The URL of the contact role's image icon. */ @ApiMember(DataType="string", Description="The URL of the contact role's image icon.", Name="ContactRolePrimaryImageURL", ParameterType="query") public String ContactRolePrimaryImageURL = null; /** * The URL of the contact role's thumbnail image icon. */ @ApiMember(DataType="string", Description="The URL of the contact role's thumbnail image icon.", Name="ContactRolePrimaryImageThumbnailURL", ParameterType="query") public String ContactRolePrimaryImageThumbnailURL = null; /** * The Guid of the contact role's media file containing the image icon details. */ @ApiMember(DataType="string", Description="The Guid of the contact role's media file containing the image icon details.", Name="ContactRolePrimaryImageId", ParameterType="query") public UUID ContactRolePrimaryImageId = null; /** * The connected contacts Id. (licensee) */ @ApiMember(DataType="string", Description="The connected contacts Id. (licensee)", Name="ConnectionContactId", ParameterType="query") public UUID ConnectionContactId = null; /** * The connected contacts Full Name. */ @ApiMember(DataType="string", Description="The connected contacts Full Name.", Name="ConnectionContactName", ParameterType="query") public String ConnectionContactName = null; /** * The connected contacts role. */ @ApiMember(DataType="string", Description="The connected contacts role.", Name="ConnectionContactRoleName", ParameterType="query") public String ConnectionContactRoleName = null; /** * The connected contacts role Id. */ @ApiMember(DataType="Guid", Description="The connected contacts role Id.", Name="ConnectionContactRoleId", ParameterType="query") public UUID ConnectionContactRoleId = null; /** * The connected contacts list item role Id. */ @ApiMember(DataType="Guid", Description="The connected contacts list item role Id.", Name="ConnectionContactListItemRoleId", ParameterType="query") public UUID ConnectionContactListItemRoleId = null; /** * The Contacts Type. */ @ApiMember(DataType="string", Description="The Contacts Type.", Name="ContactTypeName", ParameterType="query") public String ContactTypeName = null; /** * The URL to the Connected Contacts Photo. */ @ApiMember(DataType="string", Description="The URL to the Connected Contacts Photo.", Name="ConnectionContactPhotoURL", ParameterType="query") public String ConnectionContactPhotoURL = null; /** * . */ @ApiMember(DataType="bool", Description=".", Name="IsContactLicenseeRole", ParameterType="query") public Boolean IsContactLicenseeRole = null; /** * If the connection is as a licensee this is true. */ @ApiMember(DataType="bool", Description="If the connection is as a licensee this is true.", Name="IsConnectionLicenseeRole", ParameterType="query") public Boolean IsConnectionLicenseeRole = null; /** * The status of the connection with the contact. */ @ApiMember(DataType="string", Description="The status of the connection with the contact.", Name="ConnectionStatusName", ParameterType="query") public String ConnectionStatusName = null; /** * The status Id of the connection with the contact. */ @ApiMember(DataType="Guid", Description="The status Id of the connection with the contact.", Name="ConnectionStatusId", ParameterType="query") public UUID ConnectionStatusId = null; /** * The ContactRoleConnectionId of an active connection with the contact. */ @ApiMember(DataType="Guid", Description="The ContactRoleConnectionId of an active connection with the contact.", Name="ConnectionId", ParameterType="query") public UUID ConnectionId = null; /** * The ContactRoleConnectionRequest of a pending connection with the contact. */ @ApiMember(DataType="Guid", Description="The ContactRoleConnectionRequest of a pending connection with the contact.", Name="ConnectionRequestId", ParameterType="query") public UUID ConnectionRequestId = null; public UUID getContactRoleId() { return ContactRoleId; } public UserContactConnectionModel setContactRoleId(UUID value) { this.ContactRoleId = value; return this; } public String getContactRoleName() { return ContactRoleName; } public UserContactConnectionModel setContactRoleName(String value) { this.ContactRoleName = value; return this; } public UUID getContactListItemRoleId() { return ContactListItemRoleId; } public UserContactConnectionModel setContactListItemRoleId(UUID value) { this.ContactListItemRoleId = value; return this; } public String getContactRolePrimaryImageURL() { return ContactRolePrimaryImageURL; } public UserContactConnectionModel setContactRolePrimaryImageURL(String value) { this.ContactRolePrimaryImageURL = value; return this; } public String getContactRolePrimaryImageThumbnailURL() { return ContactRolePrimaryImageThumbnailURL; } public UserContactConnectionModel setContactRolePrimaryImageThumbnailURL(String value) { this.ContactRolePrimaryImageThumbnailURL = value; return this; } public UUID getContactRolePrimaryImageId() { return ContactRolePrimaryImageId; } public UserContactConnectionModel setContactRolePrimaryImageId(UUID value) { this.ContactRolePrimaryImageId = value; return this; } public UUID getConnectionContactId() { return ConnectionContactId; } public UserContactConnectionModel setConnectionContactId(UUID value) { this.ConnectionContactId = value; return this; } public String getConnectionContactName() { return ConnectionContactName; } public UserContactConnectionModel setConnectionContactName(String value) { this.ConnectionContactName = value; return this; } public String getConnectionContactRoleName() { return ConnectionContactRoleName; } public UserContactConnectionModel setConnectionContactRoleName(String value) { this.ConnectionContactRoleName = value; return this; } public UUID getConnectionContactRoleId() { return ConnectionContactRoleId; } public UserContactConnectionModel setConnectionContactRoleId(UUID value) { this.ConnectionContactRoleId = value; return this; } public UUID getConnectionContactListItemRoleId() { return ConnectionContactListItemRoleId; } public UserContactConnectionModel setConnectionContactListItemRoleId(UUID value) { this.ConnectionContactListItemRoleId = value; return this; } public String getContactTypeName() { return ContactTypeName; } public UserContactConnectionModel setContactTypeName(String value) { this.ContactTypeName = value; return this; } public String getConnectionContactPhotoURL() { return ConnectionContactPhotoURL; } public UserContactConnectionModel setConnectionContactPhotoURL(String value) { this.ConnectionContactPhotoURL = value; return this; } public Boolean getIsContactLicenseeRole() { return IsContactLicenseeRole; } public UserContactConnectionModel setIsContactLicenseeRole(Boolean value) { this.IsContactLicenseeRole = value; return this; } public Boolean getIsConnectionLicenseeRole() { return IsConnectionLicenseeRole; } public UserContactConnectionModel setIsConnectionLicenseeRole(Boolean value) { this.IsConnectionLicenseeRole = value; return this; } public String getConnectionStatusName() { return ConnectionStatusName; } public UserContactConnectionModel setConnectionStatusName(String value) { this.ConnectionStatusName = value; return this; } public UUID getConnectionStatusId() { return ConnectionStatusId; } public UserContactConnectionModel setConnectionStatusId(UUID value) { this.ConnectionStatusId = value; return this; } public UUID getConnectionId() { return ConnectionId; } public UserContactConnectionModel setConnectionId(UUID value) { this.ConnectionId = value; return this; } public UUID getConnectionRequestId() { return ConnectionRequestId; } public UserContactConnectionModel setConnectionRequestId(UUID value) { this.ConnectionRequestId = value; return this; } } public static class ContactEmailAddress { /** * The Contact Id of the contact. */ @ApiMember(DataType="Guid", Description="The Contact Id of the contact.", Name="ContactId", ParameterType="query") public UUID ContactId = null; /** * The Contact Full Name */ @ApiMember(DataType="string", Description="The Contact Full Name", Name="ContactName", ParameterType="query") public String ContactName = null; /** * The Contact Email Address. */ @ApiMember(DataType="string", Description="The Contact Email Address.", Name="EmailAddress", ParameterType="query") public String EmailAddress = null; /** * The Contact Photo URL */ @ApiMember(DataType="string", Description="The Contact Photo URL", Name="ContactPhotoURL", ParameterType="query") public String ContactPhotoURL = null; public UUID getContactId() { return ContactId; } public ContactEmailAddress setContactId(UUID value) { this.ContactId = value; return this; } public String getContactName() { return ContactName; } public ContactEmailAddress setContactName(String value) { this.ContactName = value; return this; } public String getEmailAddress() { return EmailAddress; } public ContactEmailAddress setEmailAddress(String value) { this.EmailAddress = value; return this; } public String getContactPhotoURL() { return ContactPhotoURL; } public ContactEmailAddress setContactPhotoURL(String value) { this.ContactPhotoURL = value; return this; } } public static class UserProfileWithRolesModel extends UserProfileModel { /** * A list of roles assigned to the user. */ @ApiMember(DataType="List", Description="A list of roles assigned to the user.", Name="Roles", ParameterType="query") public ArrayList Roles = null; /** * A list of contact connections assigned to the user. */ @ApiMember(DataType="List", Description="A list of contact connections assigned to the user.", Name="ContactConnections", ParameterType="query") public ArrayList ContactConnections = null; /** * A list of connected contacts and their email addresses. */ @ApiMember(DataType="List", Description="A list of connected contacts and their email addresses.", Name="EmailAddressBook", ParameterType="query") public ArrayList EmailAddressBook = null; public ArrayList getRoles() { return Roles; } public UserProfileWithRolesModel setRoles(ArrayList value) { this.Roles = value; return this; } public ArrayList getContactConnections() { return ContactConnections; } public UserProfileWithRolesModel setContactConnections(ArrayList value) { this.ContactConnections = value; return this; } public ArrayList getEmailAddressBook() { return EmailAddressBook; } public UserProfileWithRolesModel setEmailAddressBook(ArrayList value) { this.EmailAddressBook = value; return this; } } public static class UserProfileModel extends UserProfileSummaryModel { /** * Contact Date of Birth (when person type) */ @ApiMember(DataType="DateTime?", Description="Contact Date of Birth (when person type)", Name="BirthDate", ParameterType="query") public Date BirthDate = null; /** * Contact marital status (when person type) */ @ApiMember(DataType="string", Description="Contact marital status (when person type)", Name="MaritalStatusName", ParameterType="query") public String MaritalStatusName = null; /** * Contact gender (when person type) */ @ApiMember(DataType="string", Description="Contact gender (when person type)", Name="GenderName", ParameterType="query") public String GenderName = null; /** * The Gender Guid of the contact. */ @ApiMember(DataType="Guid", Description="The Gender Guid of the contact.", Name="GenderId", ParameterType="query") public UUID GenderId = null; /** * All contact details of the contact */ @ApiMember(DataType="List", Description="All contact details of the contact", Name="ContactDetails", ParameterType="query") public ArrayList ContactDetails = null; /** * Primary Street Address */ @ApiMember(DataType="ContactDetail", Description="Primary Street Address", Name="PrimaryStreetAddress ") public ContactDetailModel PrimaryStreetAddress = null; /** * Primary Postal Address */ @ApiMember(DataType="ContactDetail", Description="Primary Postal Address", Name="PrimaryPostalAddress ") public ContactDetailModel PrimaryPostalAddress = null; /** * Primary Registered Address */ @ApiMember(DataType="ContactDetail", Description="Primary Registered Address", Name="PrimaryRegisteredAddress ") public ContactDetailModel PrimaryRegisteredAddress = null; /** * Primary Email Address */ @ApiMember(DataType="ContactDetail", Description="Primary Email Address", Name="PrimaryEmail ") public ContactDetailModel PrimaryEmail = null; /** * Primary Mobile Number */ @ApiMember(DataType="ContactDetail", Description="Primary Mobile Number", Name="PrimaryMobile") public ContactDetailModel PrimaryMobile = null; /** * Primary Non-Mobile Number */ @ApiMember(DataType="ContactDetail", Description="Primary Non-Mobile Number", Name="PrimaryPhone") public ContactDetailModel PrimaryPhone = null; /** * Primary Fax Number */ @ApiMember(DataType="ContactDetail", Description="Primary Fax Number", Name="PrimaryFax") public ContactDetailModel PrimaryFax = null; /** * Primary Web Address */ @ApiMember(DataType="ContactDetail", Description="Primary Web Address", Name="PrimaryWeb") public ContactDetailModel PrimaryWeb = null; /** * Social Media Twitter */ @ApiMember(DataType="ContactDetail", Description="Social Media Twitter", Name="SocialMediaTwitter") public ContactDetailModel SocialMediaTwitter = null; /** * Social Media Facebook */ @ApiMember(DataType="ContactDetail", Description="Social Media Facebook", Name="SocialMediaFacebook") public ContactDetailModel SocialMediaFacebook = null; /** * Social Media Instagram */ @ApiMember(DataType="ContactDetail", Description="Social Media Instagram", Name="SocialMediaInstagram") public ContactDetailModel SocialMediaInstagram = null; /** * Have all connections to the contact been removed? */ @ApiMember(DataType="bool", Description="Have all connections to the contact been removed?", Name="IsRemovedContact") public Boolean IsRemovedContact = null; /** * True if this is the users default profile. */ @ApiMember(DataType="bool", Description="True if this is the users default profile.", Name="IsDefault", ParameterType="query") public Boolean IsDefault = null; /** * True if the users email on this profile can be edited. */ @ApiMember(DataType="bool", Description="True if the users email on this profile can be edited.", Name="IsEmailEditable", ParameterType="query") public Boolean IsEmailEditable = null; /** * Primary image Content sent as a file stream contents (if not attached to the request) */ @ApiMember(DataType="string", Description="Primary image Content sent as a file stream contents (if not attached to the request)", Name="PrimaryImageContent") public String PrimaryImageContent = null; /** * Primary image Content type sent as a file stream contents (if not attached to the request) */ @ApiMember(DataType="string", Description="Primary image Content type sent as a file stream contents (if not attached to the request)", Name="PrimaryImageContentType") public String PrimaryImageContentType = null; /** * Primary image file name */ @ApiMember(DataType="string", Description="Primary image file name", Name="PrimaryImageFileName") public String PrimaryImageFileName = null; public Date getBirthDate() { return BirthDate; } public UserProfileModel setBirthDate(Date value) { this.BirthDate = value; return this; } public String getMaritalStatusName() { return MaritalStatusName; } public UserProfileModel setMaritalStatusName(String value) { this.MaritalStatusName = value; return this; } public String getGenderName() { return GenderName; } public UserProfileModel setGenderName(String value) { this.GenderName = value; return this; } public UUID getGenderId() { return GenderId; } public UserProfileModel setGenderId(UUID value) { this.GenderId = value; return this; } public ArrayList getContactDetails() { return ContactDetails; } public UserProfileModel setContactDetails(ArrayList value) { this.ContactDetails = value; return this; } public ContactDetailModel getPrimaryStreetAddress() { return PrimaryStreetAddress; } public UserProfileModel setPrimaryStreetAddress(ContactDetailModel value) { this.PrimaryStreetAddress = value; return this; } public ContactDetailModel getPrimaryPostalAddress() { return PrimaryPostalAddress; } public UserProfileModel setPrimaryPostalAddress(ContactDetailModel value) { this.PrimaryPostalAddress = value; return this; } public ContactDetailModel getPrimaryRegisteredAddress() { return PrimaryRegisteredAddress; } public UserProfileModel setPrimaryRegisteredAddress(ContactDetailModel value) { this.PrimaryRegisteredAddress = value; return this; } public ContactDetailModel getPrimaryEmail() { return PrimaryEmail; } public UserProfileModel setPrimaryEmail(ContactDetailModel value) { this.PrimaryEmail = value; return this; } public ContactDetailModel getPrimaryMobile() { return PrimaryMobile; } public UserProfileModel setPrimaryMobile(ContactDetailModel value) { this.PrimaryMobile = value; return this; } public ContactDetailModel getPrimaryPhone() { return PrimaryPhone; } public UserProfileModel setPrimaryPhone(ContactDetailModel value) { this.PrimaryPhone = value; return this; } public ContactDetailModel getPrimaryFax() { return PrimaryFax; } public UserProfileModel setPrimaryFax(ContactDetailModel value) { this.PrimaryFax = value; return this; } public ContactDetailModel getPrimaryWeb() { return PrimaryWeb; } public UserProfileModel setPrimaryWeb(ContactDetailModel value) { this.PrimaryWeb = value; return this; } public ContactDetailModel getSocialMediaTwitter() { return SocialMediaTwitter; } public UserProfileModel setSocialMediaTwitter(ContactDetailModel value) { this.SocialMediaTwitter = value; return this; } public ContactDetailModel getSocialMediaFacebook() { return SocialMediaFacebook; } public UserProfileModel setSocialMediaFacebook(ContactDetailModel value) { this.SocialMediaFacebook = value; return this; } public ContactDetailModel getSocialMediaInstagram() { return SocialMediaInstagram; } public UserProfileModel setSocialMediaInstagram(ContactDetailModel value) { this.SocialMediaInstagram = value; return this; } public Boolean getIsRemovedContact() { return IsRemovedContact; } public UserProfileModel setIsRemovedContact(Boolean value) { this.IsRemovedContact = value; return this; } public Boolean getIsDefault() { return IsDefault; } public UserProfileModel setIsDefault(Boolean value) { this.IsDefault = value; return this; } public Boolean getIsEmailEditable() { return IsEmailEditable; } public UserProfileModel setIsEmailEditable(Boolean value) { this.IsEmailEditable = value; return this; } public String getPrimaryImageContent() { return PrimaryImageContent; } public UserProfileModel setPrimaryImageContent(String value) { this.PrimaryImageContent = value; return this; } public String getPrimaryImageContentType() { return PrimaryImageContentType; } public UserProfileModel setPrimaryImageContentType(String value) { this.PrimaryImageContentType = value; return this; } public String getPrimaryImageFileName() { return PrimaryImageFileName; } public UserProfileModel setPrimaryImageFileName(String value) { this.PrimaryImageFileName = value; return this; } } }