Fetch profile by key
From ePrize Developers Wiki
| Line 29: | Line 29: | ||
<result ver="ePrize Web Services 1.0"> | <result ver="ePrize Web Services 1.0"> | ||
<profile> | <profile> | ||
| - | <id>{ | + | <id>{profile-number}</id> |
<email>some.email@address.com</email> | <email>some.email@address.com</email> | ||
<safekey1>safekey1-value</safekey1> | <safekey1>safekey1-value</safekey1> | ||
Revision as of 12:29, 3 May 2010
Summary
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.
Example: Bad Request
Summary
This demonstrates a bad request, such as, the request contains invalid UTF-8 characters.
Response
HTTP Status Code: 400 Bad Request
<?xml version="1.0" encoding="UTF-8" ?> <result ver="ePrize Web Services 1.0"> <result></result> <status>1</status> </result>
Example: Found Profile
Response
HTTP Status Code: 303 See Other
HTTP Redirect Location: /v1/{apikey}/profile/{uid}
<?xml version="1.0" encoding="UTF-8" ?>
<result ver="ePrize Web Services 1.0">
<profile>
<id>{profile-number}</id>
<email>some.email@address.com</email>
<safekey1>safekey1-value</safekey1>
<safekey2>safekey2-value</safekey2>
...
<safekeyN>safekeyN-value</safekeyN>
</profile>
</result>
Example: Unable to find Profile
Response
HTTP Status Code: 404 Not Found
<?xml version="1.0" encoding="UTF-8" ?> <result ver="ePrize Web Services 1.0"> <status>0</status> </result>
