person_contact

This class provides RESTful services to get contact details, register a person as a member, and update a member.

Note: This REST API does not support pagination.

Handler Class:

com.ibm.commerce.rest.member.handler.PersonContactHandler

Method Summary

HTTP Method	Path	Description
GET	/store/{storeId}/person/@self/contact	Gets the contacts in a person's address book. If the addressType optional query parameter is passed in, the returned contacts are filtered by addressType.
GET	/store/{storeId}/person/@self/contact/{nickName}	Gets a person contact by nick name.
GET	/store/{storeId}/person/@self/contact/byAddressId/{addressId}	Gets a person contact by address ID.
POST	/store/{storeId}/person/@self/contact	Creates a new contact in a person's address book.
PUT	/store/{storeId}/person/@self/contact/{nickName}	Updates the contact in the address book identified by nickName.
DELETE	/store/{storeId}/person/@self/contact/{nickName}	Deletes the contact in the address book identified by nickName.

Method Details

GET /store/{storeId}/person/@self/contact

Gets the contacts in a person's address book. If the addressType optional query parameter is passed in, the returned contacts are filtered by addressType.

Handler Method:

getAllPersonContact

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
addressType	The address type.	query	string	false	false

HTTP Status Codes:

HTTP Status Code	Description
200	The requested completed successfully.
400	Bad request. Some of the inputs provided to the request aren't valid.
401	Not authenticated. The user session isn't valid.
403	The user isn't authorized to perform the specified request.
500	Internal server error. Additional details will be contained on the server logs.

Response Data Type:

person-contact

GET /store/{storeId}/person/@self/contact/{nickName}

Gets a person contact by nick name.

Handler Method:

findPersonContactByNickName

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
nickName	The contact name saved in addressBook by registered shopper.	path	string	true	N/A

HTTP Status Codes:

HTTP Status Code	Description
200	The requested completed successfully.
400	Bad request. Some of the inputs provided to the request aren't valid.
401	Not authenticated. The user session isn't valid.
403	The user isn't authorized to perform the specified request.
404	The specified resource couldn't be found.
500	Internal server error. Additional details will be contained on the server logs.

Response Data Type:

person-singleContact

GET /store/{storeId}/person/@self/contact/byAddressId/{addressId}

Gets a person contact by address ID.

Handler Method:

findPersonContactById

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
addressId	The address identifier.	path	string	true	N/A

HTTP Status Codes:

HTTP Status Code	Description
200	The requested completed successfully.
400	Bad request. Some of the inputs provided to the request aren't valid.
401	Not authenticated. The user session isn't valid.
403	The user isn't authorized to perform the specified request.
404	The specified resource couldn't be found.
500	Internal server error. Additional details will be contained on the server logs.

Response Data Type:

person-singleContact

POST /store/{storeId}/person/@self/contact

Creates a new contact in a person's address book.

Handler Method:

addPersonContact

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
body	Request body.	body	person-contact	false	N/A

HTTP Status Codes:

HTTP Status Code	Description
201	The requested resource has been created.
400	Bad request. Some of the inputs provided to the request aren't valid.
401	Not authenticated. The user session isn't valid.
403	The user isn't authorized to perform the specified request.
500	Internal server error. Additional details will be contained on the server logs.

Response Data Type:

com.ibm.commerce.rest.member.handler.PersonContactHandler$UserIdentifier

PUT /store/{storeId}/person/@self/contact/{nickName}

Updates the contact in the address book identified by nickName.

Handler Method:

updatePersonContact

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
nickName	The contact name saved in addressBook by registered shopper.	path	string	true	N/A
body	Request body.	body	person-contact	false	N/A

HTTP Status Codes:

HTTP Status Code	Description
200	The requested completed successfully.
400	Bad request. Some of the inputs provided to the request aren't valid.
401	Not authenticated. The user session isn't valid.
403	The user isn't authorized to perform the specified request.
404	The specified resource couldn't be found.
500	Internal server error. Additional details will be contained on the server logs.

Response Data Type:

com.ibm.commerce.rest.member.handler.PersonContactHandler$AddressIdentifier

DELETE /store/{storeId}/person/@self/contact/{nickName}

Deletes the contact in the address book identified by nickName.

Handler Method:

deletePersonContact

Secure Call Mandatory:

true

Partial Authentication Allowed:

false

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
nickName	The contact name saved in addressBook by registered shopper.	path	string	true	N/A

HTTP Status Codes:

HTTP Status Code	Description
200	The requested completed successfully.
400	Bad request. Some of the inputs provided to the request aren't valid.
401	Not authenticated. The user session isn't valid.
403	The user isn't authorized to perform the specified request.
404	The specified resource couldn't be found.
500	Internal server error. Additional details will be contained on the server logs.

Data Type Details

com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType

Properties:

Name	Data Type	Required
uniqueID	string	false
distinguishedName	string	false

com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType

Properties:

Name	Data Type	Required
externalIdentifier	com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier	false
uniqueID	string	false
distinguishedName	string	false

com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType.externalIdentifier

Properties:

Name	Data Type	Required
identifier	string	false

com.ibm.commerce.rest.member.handler.PersonContactHandler$AddressIdentifier

Address identitifier.

Properties:

Name	Data Type	Required
addressId	string	true

com.ibm.commerce.rest.member.handler.PersonContactHandler$UserIdentifier

User identitifier.

Properties:

Name	Data Type	Required
userId	string	true

java.util.Map$Entry

Properties:

Name	Data Type	Required
value	string	false
key	string	true

person-contact

Properties:

Name	Data Type	Required
contact	person-contact.contact array	true
userId	string	false
addressId	string	false

person-contact.contact

Properties:

Name	Data Type	Required
middleName	string	false
lastName	string	false
organizationUnitName	string	false
primary	string	false
personTitle	string	false
phone1	string	true
phone2	string	true
mobilePhone1	string	true
addressLine	string array	false
phone1Publish	string	false
nickName	string	true
addressType	string	false
mobilePhone1Country	string	true
state	string	false
email1	string	true
email2	string	true
country	string	false
attributes	java.util.Map$Entry array	false
language	string	false
internalOfficeAddress	string	false
firstName	string	false
phone1Type	string	false
organizationName	string	false
phone2Type	string	false
personIdentifier	com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType	false
userDataField	person-contact.contact.userDataField array	false
city	string	false
phone2Publish	string	false
bestCallingTime	string	false
zipCode	string	false
addressId	string	false
fax1	string	true
fax2	string	true
geographicalTaxCode	string	false
businessTitle	string	false
organizationIdentifier	com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType	false
geographicalShippingCode	string	false

person-contact.contact.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

person-singleContact

Properties:

Name	Data Type	Required
middleName	string	false
lastName	string	false
organizationUnitName	string	false
primary	string	false
personTitle	string	false
phone1	string	true
phone2	string	true
mobilePhone1	string	true
addressLine	string array	false
phone1Publish	string	false
nickName	string	true
addressType	string	false
mobilePhone1Country	string	true
state	string	false
email1	string	true
email2	string	true
country	string	false
attributes	java.util.Map$Entry array	false
language	string	false
internalOfficeAddress	string	false
firstName	string	false
phone1Type	string	false
phone2Type	string	false
organizationName	string	false
personIdentifier	com.ibm.commerce.foundation.common.datatypes.PersonIdentifierType	false
userDataField	person-singleContact.userDataField array	false
phone2Publish	string	false
city	string	false
bestCallingTime	string	false
zipCode	string	false
addressId	string	false
fax1	string	true
fax2	string	true
geographicalTaxCode	string	false
businessTitle	string	false
organizationIdentifier	com.ibm.commerce.foundation.common.datatypes.OrganizationIdentifierType	false
geographicalShippingCode	string	false

person-singleContact.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true