Fetch profile by key

From ePrize Developers Wiki

Revision as of 16:25, 17 March 2009 (edit) Brian-quail (Talk | contribs) ← Previous diff		Revision as of 19:30, 17 March 2009 (edit) (undo) Brian-quail (Talk | contribs) Next diff →
Line 1:		Line 1:
		+	[[API Home Page]] :: [[Profiles]]
	<pre>		<pre>
	Response if request contains invalid UTF-8:		Response if request contains invalid UTF-8:

---

Revision as of 19:30, 17 March 2009

API Home Page :: Profiles

Response if request contains invalid UTF-8:
400 Bad Request

Success - Found Profile

HTTP Status: 303 See Other
Location: /v1/{apikey}/profile/{uid}
<?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>

Failure - Unable to find Profile

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>

Example of getting a profile by mobile number: GET /v1/{apikey}/profile(mobile)/1-888-555-1212

The client must not assume the format of the canonical profile URL returned in the Location. Other API calls take the entire URL as a profile identifier, so deconstructing the URL is not necessary. A GET on the URL will fetch the full (safe) representation of the profile.

important to refer back to basic request/response section on URL value restrictions

This URL is an entry point. It may be easily attacked because valid URLs are easy to guess.