The Person noun defines types related to a person. A person is a human that can be a guest, a registered user or an administrator. The service data object (SDO) is com.ibm.commerce.member.facade.datatypes.PersonType.
| BOD | Action Code / Access Profile | Action Expression | Service Provided | Sample XML Message | Client Library / Expression Builder |
|---|---|---|---|---|---|
| ProcessPerson | Register | Self registration of a person. |
Request
Response |
MemberFacadeClient.registerPerson(java.util.Map) | |
| AuthenticatePassword | Authenticates a person based on the following criteria: logon ID and password. The identity of the previous person prior to authenticating is determined based on the IdentityToken that is in the header. If the previous person is a guest, then any resources owned by the guest are migrated to the authenticated person. |
Request
Response |
MemberFacadeClient.authenticatePassword(java.util.Map) | ||
| AuthenticateLTPA | Authenticates a person using an LTPA token value. The identity of the previous person prior to authenticating is deterimined based on the IdentityToken that is in the header. If the previous person was a guest, then any resources that were owned by the guest would be migrated to the authenticated person. |
Request
Response |
MemberFacadeClient.authenticateLTPA(java.util.Map) | ||
| Logout | Ends the session of the person based on the current identity token that is in the header. |
Request
Response |
MemberFacadeClient.logout(java.util.Map) | ||
| ResetPassword | Reset password while authenticated. |
Request
Response |
MemberFacadeClient.resetPassword(java.util.Map) | ||
| ResetPassword | Reset password while unauthenticated. |
Request
Response |
MemberFacadeClient.resetPassword(java.util.Map) | ||
| CreateGuest | Will create a new guest user and a guest session that can be used in subsequent service requests. The purpose of this action is for applications to create a temporary person so it can call services that will associate information with the user. This service does not require any information about the person to be populated and will return the UniqueID of the guest user along with the session identity ID and signature. The session information will be populated in the UserData section of the Person's credentials. |
Request
Response |
MemberFacadeClient.createGuest(java.util.Map) | ||
| ChangePerson | Update | /Person | Update the person's profile information, including the contact information. |
Request
Response |
MemberFacadeClient.updatePerson(java.util.Map) |
| Create | /Person/AddressBook/Contact | Add an address into the address book. |
Request
Response |
MemberFacadeClient.addAddressForPerson(java.util.Map) | |
| Update | /Person/AddressBook/Contact | Update an address in the address book. |
Request
Response |
MemberFacadeClient.updateAddressForPerson(java.util.Map) | |
| Delete | /Person/AddressBook/Contact | Delete an address from the address book. |
Request
Response |
MemberFacadeClient.deleteAddressForPerson(java.util.Map) | |
| Update | /Person/CheckoutProfile | Update the checkout profile. |
Request
Response |
MemberFacadeClient.updateCheckoutProfile(java.util.Map) | |
| GetPerson | IBM_Summary IBM_Details IBM_CheckoutProfile IBM_All | {self=true}/Person | Find current person. |
Request
Response |
findCurrentPerson |
| IBM_Summary IBM_Details IBM_CheckoutProfile IBM_All | /Person[PersonIdentifier[(UniqueID='$personId$')]] | Find by unique ID. |
Request
Response |
findByUniqueID | |
| IBM_Summary IBM_Details IBM_CheckoutProfile IBM_All | /Person[Credential[LogonID='$logonID$']] | Find by logon ID. |
Request
Response |
findByLogonID | |
| IBM_Summary IBM_Details IBM_CheckoutProfile IBM_All | /Person[PersonIdentifier[(DistinguishedName='$distinguishedName$')]] | Find by distinguished name. |
Request
Response |
findByDistinguishedName | |
| IBM_Summary, IBM_Details, IBM_CheckoutProfile, IBM_All | /Person[search($searchCriteria$)] |
Person basic search. Use one field, or a combination of fields using the same search operator. i.e starts-with, as specified in the request expression. The search is not case sensitive. Search results return the persons matching the given search criteria. The following fields can be used to specify person search criteria:
<_config:extendedconfiguration> |
Request
Response |
MemberFacadeClient.getPerson(GetType) |
Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.
| Access Profile | Data Returned |
|---|---|
| IBM_Summary |
|
| IBM_Details |
|
| IBM_CheckoutProfile |
|
| IBM_All |
|