This class provides RESTful services to get person details, register a member, and update a member. This class also provides RESTful services used by an administrator to find person information, register new and update existing user information.
com.ibm.commerce.rest.member.handler.PersonHandler
| Path | Operation | Description |
|---|---|---|
| /store/{storeId}/person | GET |
This allows an administrator to find users based on a query name. See each query for details on input and output. |
| POST |
Registers a new user. When mode is set to admin, the register is done by an administrator. |
|
| /store/{storeId}/person/@self | GET |
Gets the account data for a registered user. |
| PUT |
Updates account data for a registered user. This also supports resetting password for unauthenticated and authenticated users. When action is set to 'updateUserRegistration', user account data is updated using UserRegistrationUpdateCmd |
|
| /store/{storeId}/person/@self/contextattributes/{jobNames}/{values} | DELETE |
Deletes one or more values of a context attribute for a registered user. |
| /store/{storeId}/person/@self/optOut | GET |
Find personal opt-out. When the store level personal opt-out does not exist, the site level personal opt-out is returned. |
| /store/{storeId}/person/updateMemberUser/{userId} | POST |
Updates user to be included/excluded from a member group or to be unassgined. |
| /store/{storeId}/person/{userId} | GET |
This allows an administrator to find user information by user identifier. |
| POST |
Performs an action on a person by an administrator. See each action for details on input and output. |
|
| PUT |
This allows an administrator to update account data for a registered user. |
| storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
| q | The query name. |
query | string , x ∈ { usersICanAdmin } |
application/json application/xml application/xhtml+xml application/atom+xml
The requested completed successfully.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
Internal server error. Additional details will be contained on the server logs.
application/json application/xml
| storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
| responseFormat | The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json. |
query | string , x ∈ { xml , json } | |
| mode | The mode of the rest service. |
query | string , x ∈ { self , admin } |
application/json application/xml application/xhtml+xml application/atom+xml
The requested completed successfully.
The requested resource has been created.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
Internal server error. Additional details will be contained on the server logs.
| storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
| responseFormat | The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json. |
query | string , x ∈ { xml , json } |
application/json application/xml application/xhtml+xml application/atom+xml
The requested completed successfully.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
Internal server error. Additional details will be contained on the server logs.
application/json application/xml
| storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
| responseFormat | The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json. |
query | string , x ∈ { xml , json } | |
| action | The action of the rest service. |
query | string , x ∈ { updateUserRegistration } |
application/json application/xml application/xhtml+xml application/atom+xml
The requested completed successfully.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
Internal server error. Additional details will be contained on the server logs.
| jobNames | Name of the person's job function to use for the request. |
path | string | |
| values | Value of the person's job function. |
path | string | |
| storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
| responseFormat | The response format. If the request has an input body, that body must also use the format specified in "responseFormat". Valid values include "json" and "xml" without the quotes. If the responseFormat isn't specified, the "accept" HTTP header shall be used to determine the format of the response. If the "accept" HTTP header isn't specified as well, the default response format shall be in json. |
query | string , x ∈ { xml , json } |
application/json application/xml application/xhtml+xml application/atom+xml
The requested completed successfully.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
Internal server error. Additional details will be contained on the server logs.
| storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
| profileName | Profile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_optOut_email |
query | string , x ∈ { IBM_optOut_email , IBM_optOut_sms , IBM_optOut_all } |
application/json application/xml application/xhtml+xml application/atom+xml
The requested completed successfully.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
Internal server error. Additional details will be contained on the server logs.
| storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
| userId | The user identifier. |
path | string |
application/json application/xml application/xhtml+xml application/atom+xml
The requested completed successfully.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
Internal server error. Additional details will be contained on the server logs.
| storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
| userId | The user identifier. |
path | string | |
| profileName | Profile name. Profiles determine the subset of data to be returned by a query. Default profile name = IBM_User_Display_Details |
query | string , x ∈ { IBM_User_Display_Details , IBM_User_Registration_Details , IBM_User_Top_Level_Org_Administered , IBM_Assigned_Roles_Details , IBM_Roles_Of_User_All , IBM_Roles_Of_User_In_Orgs_I_Can_Admin } |
application/json application/xml application/xhtml+xml application/atom+xml
The requested completed successfully.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
Internal server error. Additional details will be contained on the server logs.
application/json application/xml
| storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
| userId | The user identifier. |
path | string | |
| action | The action of the rest service. |
query | string , x ∈ { assignRole , unassignRole } |
application/json application/xml application/xhtml+xml application/atom+xml
The requested completed successfully.
The requested resource has been created.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
Internal server error. Additional details will be contained on the server logs.
application/json application/xml
| storeId | The store identifier. |
path | string , x ∈ { 715839284 , 0 , 715839134 , 715839184 , 715839234 , 715837884 , 715838634 , 715839334 , 715837934 , 715837984 , 715838034 , 715838534 , 715838584 , 715838035 , 715838036 } | |
| userId | The user identifier. |
path | string |
application/json application/xml application/xhtml+xml application/atom+xml
The requested completed successfully.
Bad request. Some of the inputs provided to the request aren't valid.
Not authenticated. The user session isn't valid.
The user isn't authorized to perform the specified request.
Internal server error. Additional details will be contained on the server logs.
Delete context attribute response.
The address identifier list.
The user identifier list.
Request of MemberRoleAssignCmd.
The URL to be called when the command completes successfully.
The organization entity identifier.
The role identifier. The roleId parameter takes the forms like roleId, roleId1, roleId2..., the corresponding orgEntityId should be orgEntityId, orgEntiyId1, orgEntityId2...
Request of MemberRoleUnassignCmd.
The URL to be called when the command completes successfully.
The organization entity identifier.
The role identifier. The roleId parameter takes the forms like roleId, roleId1, roleId2..., the corresponding orgEntityId should be orgEntityId, orgEntiyId1, orgEntityId2...
Body of MemberGroupMemberUpdateCmd.
MemberGroup Identifiers to explicitly exclude the user from
MemberGroup Identifiers to explicitly add the user too .
MemberGroup Identifiers to remove the user from
response of MemberGroupMemberUpdateCmd.
The URL to be called when the command completes successfully.
MemberGroup Identifiers to explicitly exclude the user from
MemberGroup Identifiers to explicitly add the user too .
The catalog identifier
MemberGroup Identifiers to remove the user from
The request type ie (ajax)
The current store identifier
The user identifier
User identitifier.
The user identifier.
Information about a guest user identity.
The token used for authentication.
The trusted token used for authentication. This token should only be used on encrypted channels.
The personalization identifier for the current session.
The user unique identifier.
Request of UserRegistrationAdminAdd.
The URL to be called when the command completes successfully.
The registrant's street address, to a maximum of three lines of information.
The registrant's street address, to a maximum of three lines of information.
The registrant's street address, to a maximum of three lines of information.
Customizable field.
Customizable field.
Customizable field.
The purpose of the address. Valid values are: S - shipto, B - billto, SB - shipto and billto (The default value.).
The registrant's age.
A special ID assigned by the registrant's business organization or organizational unit to this particular registrant..
D - An indicator that daytime is the best time to call the registrant; E - An indicator that evening is the best time to call the registrant.
The registrant's organization's code to identify the shipping or billing addresses and cost center.
Code designating the method of code structure used for the billing code. The default value is D, assigned by buyer.
Answer to the challenge question.
Challenge question for verbal confirmation of the customer's identity.
The number of children the registrant has.
The name of the city where the registrant resides.
The company name of the organization that the registrant represents, obtained when filling in demographic information.
The name of the country or region where the registrant resides.
You can manage custom member attributes (MBRATTRVAL table) for this user using the following syntax: &attributeName_storeId_action_number=value.
Date of birth. The format is yyyy-mm-dd, for example: 1980-01-01.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; a field of 254 characters.
Customizable field for demographic information; an integer field.
Customizable field for demographic information; a field varchar, length 6.
The department identifier for the registrant.
A description of the registrant.
The registrant's primary e-mail or Web address.
The registrant's secondary e-mail or Web address.
The registrant's ID with his or her employer.
The registrant's status as an employee (for example, regular, permanent, contractor, or part time).
The registrant's primary facsimile number.
The registrant's secondary facsimile number.
The first name of the registrant.
The registrant's gender.
The registrant's hobbies.
The number of people in the registrant's household; the default is 1.
The registrant's annual incom.
The currency in which the registrant's income is paid.
Required if the authentication mode is LDAP: The last name of the registrant. If the authentication mode is LDAP, this parameter is mandatory.
The registrant's logon ID. If you are using LDAP, changing a user's logonID is not supported because it would require deleting and recreating the user in LDAP. This process would cause all non-WebSphere Commerce user attributes, such as the password, to be lost. If you are not using LDAP, changing the user's logon ID is not recommended, because the promotion subsystem stores the logon ID of the creator of the promotion in the XMLPARAM column of the PX_PROMOTION table. Note: When the UserRegistrationUpdate command is used to change the logonID, the command will automatically update the USERS.DN database column. Do not assume that ADDRESS.NICKNAME will also change. Instead, the following finder should be used to get the single self address of a user: AddressAccessBean.findSelfAddressByMember(Long memberID).
The registrant's password. In database mode, the password is encrypted before it is saved in the database. In LDAP mode, the password is only stored on the LDAP server.
Required if the logonPassword is used: The registrant's password, entered a second time.
The name of the registrant's manager.
The registrant's marital statu.
The marketing tracking consent. 0 means opt-out, 1 means opt-in.
The middle name of the registrant.
The registrant's mobile phone number used for SMS, for example, 4161235555.
The country code used for the registrant's mobile phone number, for example, CA for Canada.
The internal address (for example, mail stop).
Whether the registrant has previously placed an order. This value is supplied by the registrant.
The identifier of the registrant's company.
The name of the organization that the registrant represents.
The identifier of the registrant's organizational unit.
The name of the unit within the organization that the registrant represents.
1 - An indicator to include package inserts when the order is shipped; 0 - An indicator to not include package inserts when the order is shipped. There is no default for this field. If the field is left unused, it remains null in the database
The parent member identifier of the user.
The title of the user whose address is being entered (for example, Dr., Rev., Mr. or Ms.).
The registrant's primary phone number.
The type of phone used for the registrant's primary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
The registrant's secondary phone number.
The type of phone used for the registrant's secondary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
URL or path to a photo of the registrant.
The preferred phone for the registrant (stored in the ADDRESS table), for example: P1=phone 1 P2=phone 2.
The registrant's preferred currency for transactions.
The registrant's preferred mode of delivery.
The registrant's preferred language.
The registrant's preferred unit of measure.
The version of the privacy notice. For example '1.0'.
The profile type of the user.
1 - An indicator that the registrant's primary phone number is listed; 0 - An indicator that the registrant's primary phone number is unlisted. There is no default for these publishPhone fields. If the field is left unused, it remains null in the database.
1 - An indicator that the registrant's secondary phone number is listed; 0 - An indicator that the registrant's secondary phone number is unlisted.
Determines whether the registrant wants to receive marketing e-mail activities for the current store (or all stores if no stores have been visited during the session): true - The user wants to receive marketing e-mail activities; false - The user does not want to receive e-mail activities (the default).
Specifies whether the registrant wants to receive marketing SMS messages for the current store (or all stores if no stores have been visited during the session). Valid values are true or false (default).
Indicates whether the user wants to receive order notification SMS text messages. Valid values are true or false (default).
The name of the registrant's secretary.
A shipping code based on geographical region, especially useful with tax software.
The name of the state, province, or equivalent where the registrant resides.
A tax code based on geographical region, especially useful with tax software.
A string used to identify the user for taxation, especially useful with tax software.
The time zone in which the registrant does business (report as GMT +/- hours).
Customizable field.
Customizable field.
Customizable field.
Customizable field.
Customizable field.
The ZIP or postal code of the registrant's address.
Response of UserRegistrationAdminAddCmd.
The address identifier of the user.
The logon ID of the user.
The user unique identifier.
Request of UserRegistrationAdminUpdateCmd.
The URL to be called when the command completes successfully.
The registrant's street address, to a maximum of three lines of information.
The registrant's street address, to a maximum of three lines of information.
The registrant's street address, to a maximum of three lines of information.
Customizable field.
Customizable field.
Customizable field.
The purpose of the address. Valid values are: S - shipto, B - billto, SB - shipto and billto (The default value.).
The registrant's age.
A special ID assigned by the registrant's business organization or organizational unit to this particular registrant..
D - An indicator that daytime is the best time to call the registrant; E - An indicator that evening is the best time to call the registrant.
The registrant's organization's code to identify the shipping or billing addresses and cost center.
Code designating the method of code structure used for the billing code. The default value is D, assigned by buyer.
Answer to the challenge question.
Challenge question for verbal confirmation of the customer's identity.
The number of children the registrant has.
The name of the city where the registrant resides.
The company name of the organization that the registrant represents, obtained when filling in demographic information.
The name of the country or region where the registrant resides.
You can manage custom member attributes (MBRATTRVAL table) for this user using the following syntax: &attributeName_storeId_action_number=value.
Date of birth. The format is yyyy-mm-dd, for example: 1980-01-01.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; a field of 254 characters.
Customizable field for demographic information; an integer field.
Customizable field for demographic information; a field varchar, length 6.
The department identifier for the registrant.
A description of the registrant.
The registrant's primary e-mail or Web address.
The registrant's secondary e-mail or Web address.
The registrant's ID with his or her employer.
The registrant's status as an employee (for example, regular, permanent, contractor, or part time).
The registrant's primary facsimile number.
The registrant's secondary facsimile number.
The first name of the registrant.
The registrant's gender.
The registrant's hobbies.
The number of people in the registrant's household; the default is 1.
The registrant's annual incom.
The currency in which the registrant's income is paid.
Required if the authentication mode is LDAP: The last name of the registrant. If the authentication mode is LDAP, this parameter is mandatory.
The registrant's logon ID. If you are using LDAP, changing a user's logonID is not supported because it would require deleting and recreating the user in LDAP. This process would cause all non-WebSphere Commerce user attributes, such as the password, to be lost. If you are not using LDAP, changing the user's logon ID is not recommended, because the promotion subsystem stores the logon ID of the creator of the promotion in the XMLPARAM column of the PX_PROMOTION table. Note: When the UserRegistrationUpdate command is used to change the logonID, the command will automatically update the USERS.DN database column. Do not assume that ADDRESS.NICKNAME will also change. Instead, the following finder should be used to get the single self address of a user: AddressAccessBean.findSelfAddressByMember(Long memberID).
The registrant's password. In database mode, the password is encrypted before it is saved in the database. In LDAP mode, the password is only stored on the LDAP server.
Required if the logonPassword is used: The registrant's password, entered a second time.
The name of the registrant's manager.
The registrant's marital statu.
The marketing tracking consent. 0 means opt-out, 1 means opt-in.
The middle name of the registrant.
The registrant's mobile phone number used for SMS, for example, 4161235555.
The country code used for the registrant's mobile phone number, for example, CA for Canada.
The internal address (for example, mail stop).
Whether the registrant has previously placed an order. This value is supplied by the registrant.
The identifier of the registrant's company.
The name of the organization that the registrant represents.
The identifier of the registrant's organizational unit.
The name of the unit within the organization that the registrant represents.
1 - An indicator to include package inserts when the order is shipped; 0 - An indicator to not include package inserts when the order is shipped. There is no default for this field. If the field is left unused, it remains null in the database
The title of the user whose address is being entered (for example, Dr., Rev., Mr. or Ms.).
The registrant's primary phone number.
The type of phone used for the registrant's primary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
The registrant's secondary phone number.
The type of phone used for the registrant's secondary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
URL or path to a photo of the registrant.
The preferred phone for the registrant (stored in the ADDRESS table), for example: P1=phone 1 P2=phone 2.
The registrant's preferred currency for transactions.
The registrant's preferred mode of delivery.
The registrant's preferred language.
The registrant's preferred unit of measure.
The version of the privacy notice. For example '1.0'.
1 - An indicator that the registrant's primary phone number is listed; 0 - An indicator that the registrant's primary phone number is unlisted. There is no default for these publishPhone fields. If the field is left unused, it remains null in the database.
1 - An indicator that the registrant's secondary phone number is listed; 0 - An indicator that the registrant's secondary phone number is unlisted.
Determines whether the registrant wants to receive marketing e-mail activities for the current store (or all stores if no stores have been visited during the session): true - The user wants to receive marketing e-mail activities; false - The user does not want to receive e-mail activities (the default).
Specifies whether the registrant wants to receive marketing SMS messages for the current store (or all stores if no stores have been visited during the session). Valid values are true or false (default).
Indicates whether the user wants to receive order notification SMS text messages. Valid values are true or false (default).
The name of the registrant's secretary.
A shipping code based on geographical region, especially useful with tax software.
The name of the state, province, or equivalent where the registrant resides.
A tax code based on geographical region, especially useful with tax software.
A string used to identify the user for taxation, especially useful with tax software.
The time zone in which the registrant does business (report as GMT +/- hours).
Customizable field.
Customizable field.
Customizable field.
The user the administrator will update.
Customizable field.
Customizable field.
The ZIP or postal code of the registrant's address.
Request of UserRegistrationUpdateCmd.
The URL to be called when the command completes successfully.
The registrant's street address, to a maximum of three lines of information.
The registrant's street address, to a maximum of three lines of information.
The registrant's street address, to a maximum of three lines of information.
Customizable field.
Customizable field.
Customizable field.
The purpose of the address. Valid values are: S - shipto, B - billto, SB - shipto and billto (The default value.).
The registrant's age.
A special ID assigned by the registrant's business organization or organizational unit to this particular registrant..
D - An indicator that daytime is the best time to call the registrant; E - An indicator that evening is the best time to call the registrant.
The registrant's organization's code to identify the shipping or billing addresses and cost center.
Code designating the method of code structure used for the billing code. The default value is D, assigned by buyer.
Answer to the challenge question.
Challenge question for verbal confirmation of the customer's identity.
The number of children the registrant has.
The name of the city where the registrant resides.
The company name of the organization that the registrant represents, obtained when filling in demographic information.
The name of the country or region where the registrant resides.
You can manage custom member attributes (MBRATTRVAL table) for this user using the following syntax: &attributeName_storeId_action_number=value.
Date of birth. The format is yyyy-mm-dd, for example: 1980-01-01.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; this is single-character field.
Customizable field for demographic information; a field of 254 characters.
Customizable field for demographic information; an integer field.
Customizable field for demographic information; a field varchar, length 6.
The department identifier for the registrant.
A description of the registrant.
The registrant's primary e-mail or Web address.
The registrant's secondary e-mail or Web address.
The registrant's ID with his or her employer.
The registrant's status as an employee (for example, regular, permanent, contractor, or part time).
The registrant's primary facsimile number.
The registrant's secondary facsimile number.
The first name of the registrant.
The registrant's gender.
The registrant's hobbies.
The number of people in the registrant's household; the default is 1.
The registrant's annual incom.
The currency in which the registrant's income is paid.
Required if the authentication mode is LDAP: The last name of the registrant. If the authentication mode is LDAP, this parameter is mandatory.
The registrant's logon ID. If you are using LDAP, changing a user's logonID is not supported because it would require deleting and recreating the user in LDAP. This process would cause all non-WebSphere Commerce user attributes, such as the password, to be lost. If you are not using LDAP, changing the user's logon ID is not recommended, because the promotion subsystem stores the logon ID of the creator of the promotion in the XMLPARAM column of the PX_PROMOTION table. Note: When the UserRegistrationUpdate command is used to change the logonID, the command will automatically update the USERS.DN database column. Do not assume that ADDRESS.NICKNAME will also change. Instead, the following finder should be used to get the single self address of a user: AddressAccessBean.findSelfAddressByMember(Long memberID).
The registrant's password. In database mode, the password is encrypted before it is saved in the database. In LDAP mode, the password is only stored on the LDAP server.
Required if the logonPassword is used: The registrant's password, entered a second time.
The name of the registrant's manager.
The registrant's marital statu.
The marketing tracking consent. 0 means opt-out, 1 means opt-in.
The middle name of the registrant.
The registrant's mobile phone number used for SMS, for example, 4161235555.
The country code used for the registrant's mobile phone number, for example, CA for Canada.
The internal address (for example, mail stop).
Whether the registrant has previously placed an order. This value is supplied by the registrant.
The identifier of the registrant's company.
The name of the organization that the registrant represents.
The identifier of the registrant's organizational unit.
The name of the unit within the organization that the registrant represents.
1 - An indicator to include package inserts when the order is shipped; 0 - An indicator to not include package inserts when the order is shipped. There is no default for this field. If the field is left unused, it remains null in the database
The title of the user whose address is being entered (for example, Dr., Rev., Mr. or Ms.).
The registrant's primary phone number.
The type of phone used for the registrant's primary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
The registrant's secondary phone number.
The type of phone used for the registrant's secondary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.
URL or path to a photo of the registrant.
The preferred phone for the registrant (stored in the ADDRESS table), for example: P1=phone 1 P2=phone 2.
The registrant's preferred currency for transactions.
The registrant's preferred mode of delivery.
The registrant's preferred language.
The registrant's preferred unit of measure.
The version of the privacy notice. For example '1.0'.
1 - An indicator that the registrant's primary phone number is listed; 0 - An indicator that the registrant's primary phone number is unlisted. There is no default for these publishPhone fields. If the field is left unused, it remains null in the database.
1 - An indicator that the registrant's secondary phone number is listed; 0 - An indicator that the registrant's secondary phone number is unlisted.
Determines whether the registrant wants to receive marketing e-mail activities for the current store (or all stores if no stores have been visited during the session): true - The user wants to receive marketing e-mail activities; false - The user does not want to receive e-mail activities (the default).
Specifies whether the registrant wants to receive marketing SMS messages for the current store (or all stores if no stores have been visited during the session). Valid values are true or false (default).
Indicates whether the user wants to receive order notification SMS text messages. Valid values are true or false (default).
The name of the registrant's secretary.
A shipping code based on geographical region, especially useful with tax software.
The name of the state, province, or equivalent where the registrant resides.
A tax code based on geographical region, especially useful with tax software.
A string used to identify the user for taxation, especially useful with tax software.
The time zone in which the registrant does business (report as GMT +/- hours).
Customizable field.
Customizable field.
Customizable field.
Customizable field.
Customizable field.
The ZIP or postal code of the registrant's address.