User Hint Answer V2

Description

This document covers the API information to retreive the answer to the security question associated with the users profile.

back to top

HTTP Method and Request URL

PUT

https://api.macys.com/v2/user/hintanswer/

back to top

HTTP, Path and Query Parameters

HTTP Header Parameters

Parameter

Description

Mandatory

Sample Value

x-macys-webservice-client-id Pass the apikey as a header value which is called x-macys-webservice-client-id. The api key is the 24 character alphanumeric string assigned to your application when you registered it. Click here for a list of your API keys. Yes xmj9js4jkdpe1983fmwu98gh

Accept

Specifies the output format. Can be application/json or application/xml.

Yes

application/json

application/xml

Content-Type Specifies the format of body sent. Can be application/json or application/xml. Yes

application/json

application/xml


Query Parameters

Parameter

Description

Mandatory

Sample Value

emailaddress

the email address of the customer used to login to the website

Yes test123@macys.com
callback If sent, the format is JSONP (JSON with Padding) with the callback returned with the JSON response. You can put anything in the callback parameter and whatever you send is returned.  No
magicofmacysapi

Payload Parameters

Hint ID correlates to one of 10 security questions found in the Macy's user profile. When calling the API with the hint answer, the hint ID must also be provided. Use the table below for a list of the security questions and their associated hint id.

Security Question hintId
What was the first concert you attended? 0
What was the name of your favorite cartoon series as a child? 1
What is the name of a college you applied to but didn't attend? 2
What is the name of the place your wedding reception was held? 3
What was your oldest sibling's nickname as a child? 4
What street did you live on in third grade? 5
What was the name of your first pet? 6
In what city or town did your mother and father meet? 7
What is your maternal grandmother's nickname? 8
What was the name of your first supervisor? 9

back to top

Sample Requests and Responses

 Sample Request

Request URL:

PUT

https://api.macys.com/v2/user/hintanswer/

HTTP Header:

x-macys-webservice-client-id: xmj9js4jkdpe1983fmwu98gh
Accept: application/json
Content-Type: application/json

Sample Payload

{ "validateUserHint":{ "userId":215692156946872, "hintId": 6, "hintAnswer": "Fido", "userName": "email@macys.com"} }

Sample Response

{
validateUserHint: {
userId: 2156946872
success: true
}-
}

Error Codes

Call Specific Error Codes:

ERROR CODE DESCRIPTION

UserProfileServiceProfileUserNameInputInvalidErrorCode

If emailaddress is Empty/null

UserProfileServiceUserNotFoundErrorCode

If emailaddress is not in database

USERNOTLOCKED

If user is not Locked

General Error Handling Documentation:

Click Here

back to top

Docs Navigation