GetMember
From ePrize Developers Wiki
(Difference between revisions)
(New page: getMember ==Summary== Retrieve the members profile information, including their points balance. '''Resource''' GET api/v1/getMember '''Parameters''' emailAddress memberId '''Example...) |
m (→Summary) |
||
| (One intermediate revision not shown.) | |||
| Line 7: | Line 7: | ||
'''Resource''' | '''Resource''' | ||
| - | GET | + | GET api/v1/getMember |
| - | api/v1/getMember | + | |
'''Parameters''' | '''Parameters''' | ||
| - | emailAddress | + | * emailAddress |
| - | memberId | + | * memberId |
| - | + | ||
| - | + | ||
| - | + | ||
'''Example Response: Success''' | '''Example Response: Success''' | ||
| - | { | + | { |
| - | + | "firstName": "Jon", | |
| - | + | "lastName": "Doe", | |
| - | + | "emailAddress": "jondoe@helloworld.com", | |
| - | + | "address1": "3000 Town Center", | |
| - | + | "address2": "Ste 2100", | |
| - | + | "city": "Southfield", | |
| - | + | "zipCode": "48069", | |
| - | + | "state": "MI", | |
| - | + | "currentBalance": 540 //always default currency | |
| - | } | + | } |
'''Example Response: Member Id not provided''' | '''Example Response: Member Id not provided''' | ||
| - | { | + | { |
| - | + | "Error": { | |
| - | + | "Code": "error.business.Validation", | |
| - | + | "Message": "Error for attribute: Member Id\nThis information is required.\n" | |
| + | } | ||
} | } | ||
| - | } | ||
'''Example Response: Email Address not provided''' | '''Example Response: Email Address not provided''' | ||
| - | { | + | { |
| - | + | "Error": { | |
| - | + | "Code": "error.business.Validation", | |
| - | + | "Message": "Error for attribute: Email Address\nThis information is required.\n" | |
| + | } | ||
} | } | ||
| - | } | ||
'''Example Response: Email Address and Member Id do no match''' | '''Example Response: Email Address and Member Id do no match''' | ||
| - | { | + | { |
| - | + | "Error": { | |
| - | + | "Code": "error.business.RuleProcessingException.F", | |
| - | + | "Message": "F" | |
| + | } | ||
} | } | ||
| - | } | ||
Current revision
getMember
Summary
Retrieve the members profile information, including their points balance.
Resource
GET api/v1/getMember
Parameters
- emailAddress
- memberId
Example Response: Success
{
"firstName": "Jon",
"lastName": "Doe",
"emailAddress": "jondoe@helloworld.com",
"address1": "3000 Town Center",
"address2": "Ste 2100",
"city": "Southfield",
"zipCode": "48069",
"state": "MI",
"currentBalance": 540 //always default currency
}
Example Response: Member Id not provided
{
"Error": {
"Code": "error.business.Validation",
"Message": "Error for attribute: Member Id\nThis information is required.\n"
}
}
Example Response: Email Address not provided
{
"Error": {
"Code": "error.business.Validation",
"Message": "Error for attribute: Email Address\nThis information is required.\n"
}
}
Example Response: Email Address and Member Id do no match
{
"Error": {
"Code": "error.business.RuleProcessingException.F",
"Message": "F"
}
}
