Fetch profile

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
Line 9: Line 9:
|responsecode=200 OK
|responsecode=200 OK
|response=<?xml version="1.0" encoding="UTF-8" ?>
|response=<?xml version="1.0" encoding="UTF-8" ?>
-
<result ver="ePrize Web Services 1.0">
+
<result ver="1.0">
-
<result>
+
<profile>
-
<profile>
+
<id>{uid}</id>
-
<id>{uid}</id>
+
<email>some.email@address.com</email>
-
<email>some.email@address.com</email>
+
<safekey1>safekey1-value</safekey1>
-
<safekey1>safekey1-value</safekey1>
+
<safekey2>safekey2-value</safekey2>
-
<safekey2>safekey2-value</safekey2>
+
...
-
...
+
<safekeyN>safekeyN-value</safekeyN>
-
<safekeyN>safekeyN-value</safekeyN>
+
</profile>
-
</profile>
+
-
</result>
+
-
<status>1</status>
+
</result>
</result>
}}
}}
Line 29: Line 26:
|responsecode=404 Not Found
|responsecode=404 Not Found
|response=<?xml version="1.0" encoding="UTF-8" ?>
|response=<?xml version="1.0" encoding="UTF-8" ?>
-
<result ver="ePrize Web Services 1.0">
+
<result ver="1.0">
-
<result></result>
+
<status>0</status>
-
<status>1</status>
+
</result>
</result>
}}
}}
- 
<pre>
<pre>

Revision as of 19:32, 14 May 2009

API Home Page :: Profiles

Summary

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.





Example: Found Profile

Summary

This demonstrates a successful fetch profile request where a profile was found.


Response

HTTP Status Code: 200 OK 


<?xml version="1.0" encoding="UTF-8" ?>
<result ver="1.0">
  <profile>
    <id>{uid}</id>
    <email>some.email@address.com</email>
    <safekey1>safekey1-value</safekey1>
    <safekey2>safekey2-value</safekey2>
    ...
    <safekeyN>safekeyN-value</safekeyN>
  </profile>
</result>


Example: Profile with UID Not Found

Summary

This demonstrates a fetch profile request where no profile could be found for the given UID.


Response

HTTP Status Code: 404 Not Found 


<?xml version="1.0" encoding="UTF-8" ?>
<result ver="1.0">
  <status>0</status>
</result>


Response:
awards: /v1/{apikey}/profile/{uid}/awards,
tokens: /v1/{apikey}/profile/{uid}/tokens,
Retrieved from "https://code.helloworld.com/wiki/index.php/Fetch_profile"
Personal tools