Fetch profile
From ePrize Developers Wiki
(Difference between revisions)
| Line 1: | Line 1: | ||
<pre> | <pre> | ||
Response: | Response: | ||
| - | 200 OK | ||
| - | uid: {uid}, | ||
| - | {profilekey}: {profilevalue}, | ||
awards: /v1/{apikey}/profile/{uid}/awards, | awards: /v1/{apikey}/profile/{uid}/awards, | ||
tokens: /v1/{apikey}/profile/{uid}/tokens, | tokens: /v1/{apikey}/profile/{uid}/tokens, | ||
| - | {safekey1}:{value1}, | ||
| - | {safekey2}:{value2}, | ||
| - | ... | ||
| - | {safekeyN}:{valueN} | ||
| - | |||
| - | Response if profile with UID doesn't exist: | ||
| - | 404 Not Found | ||
</pre> | </pre> | ||
Revision as of 16:20, 17 March 2009
Response:
awards: /v1/{apikey}/profile/{uid}/awards,
tokens: /v1/{apikey}/profile/{uid}/tokens,
Response (Success)
HTTP Status: 200 OK
<?xml version="1.0" encoding="UTF-8" ?>
<result ver="ePrize Web Services 1.0">
<result>
<profile>
<id>{uid}</id>
<email>some.email@address.com</email>
<safekey1>safekey1-value</safekey1>
<safekey2>safekey2-value</safekey2>
...
<safekeyN>safekeyN-value</safekeyN>
</profile>
</result>
<status>1</status>
</result>
Response (Failure - Profile with UID doesn't exist)
HTTP Status: 404 Not Found <?xml version="1.0" encoding="UTF-8" ?> <result ver="ePrize Web Services 1.0"> <result></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.
