Fetch profile
From ePrize Developers Wiki
(Difference between revisions)
(New page: <pre> Response: 200 OK uid: {uid}, {profilekey}: {profilevalue}, awards: /v1/{apikey}/profile/{uid}/awards, tokens: /v1/{apikey}/profile/{uid}/tokens, {safekey1}:{value1}, {safekey2}:{valu...) |
|||
| Line 13: | Line 13: | ||
Response if profile with UID doesn't exist: | Response if profile with UID doesn't exist: | ||
404 Not Found | 404 Not Found | ||
| + | </pre> | ||
| + | |||
| + | XML | ||
| + | <pre> | ||
| + | <?xml version="1.0" encoding="UTF-8" ?> | ||
| + | <result ver="ePrize Web Services 1.0"> | ||
| + | <result> | ||
| + | <profile> | ||
| + | <id>1</id> | ||
| + | <email>some.email@address.com</email> | ||
| + | <safekey1>safekey1-value</safekey1> | ||
| + | <safekey2>safekey2-value</safekey2> | ||
| + | </profile> | ||
| + | </result> | ||
| + | <status>1</status> | ||
| + | </result> | ||
</pre> | </pre> | ||
Only key:value pairs marked as safe for display will be returned. The {apikey} defines which keys are safe and the client may not change them except by requesting a new {apikey}. This allows clients to easily handle personalization, but minimizes the risk of exposing PII with a programming error. Full profiles are available through the Analytics "profile download" service. | Only key:value pairs marked as safe for display will be returned. The {apikey} defines which keys are safe and the client may not change them except by requesting a new {apikey}. This allows clients to easily handle personalization, but minimizes the risk of exposing PII with a programming error. Full profiles are available through the Analytics "profile download" service. | ||
Revision as of 21:59, 16 March 2009
Response:
200 OK
uid: {uid},
{profilekey}: {profilevalue},
awards: /v1/{apikey}/profile/{uid}/awards,
tokens: /v1/{apikey}/profile/{uid}/tokens,
{safekey1}:{value1},
{safekey2}:{value2},
...
{safekeyN}:{valueN}
Response if profile with UID doesn't exist:
404 Not Found
XML
<?xml version="1.0" encoding="UTF-8" ?>
<result ver="ePrize Web Services 1.0">
<result>
<profile>
<id>1</id>
<email>some.email@address.com</email>
<safekey1>safekey1-value</safekey1>
<safekey2>safekey2-value</safekey2>
</profile>
</result>
<status>1</status>
</result>
Only key:value pairs marked as safe for display will be returned. The {apikey} defines which keys are safe and the client may not change them except by requesting a new {apikey}. This allows clients to easily handle personalization, but minimizes the risk of exposing PII with a programming error. Full profiles are available through the Analytics "profile download" service.
