Fetch profile by key

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
(New page: <pre> Response: 303 See Other Location: /v1/{apikey}/profile/{uid} Response if request contains invalid UTF-8: 400 Bad Request Response if a profile with {key}={value} doesn't exist: 404...)
Current revision (15:48, 6 April 2011) (edit) (undo)
 
(11 intermediate revisions not shown.)
Line 1: Line 1:
-
<pre>
+
{{RESTfulAPI
-
Response:
+
|crumbs=[[API Home Page]] :: [[Profiles]]
-
303 See Other
+
|summary=Find a profile by a specific profile field and value. If a profile is found, the canonical location will be returned in the "Location:" response header.
-
Location: /v1/{apikey}/profile/{uid}
+
-
 
+
-
Response if request contains invalid UTF-8:
+
-
400 Bad Request
+
-
 
+
-
Response if a profile with {key}={value} doesn't exist:
+
-
404 Not Found
+
-
</pre>
+
Example of getting a profile by mobile number:
Example of getting a profile by mobile number:
-
GET /v1/{apikey}/profile(mobile)/1-888-555-1212
+
 +
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.
+
And email address:
-
''important to refer back to basic request/response section on URL value restrictions''
+
GET /v1/{apikey}/profile(email)/person@example.com
 +
 
 +
It is important to not assume the format of the [[API_Request/Response#Canonical_URLs|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. For more information on using URLs, please see the [[API_Request/Response#Follow_the_URLs|API Request/Response Overview]].
This URL is an entry point. It may be easily attacked because valid URLs are easy to guess.
This URL is an entry point. It may be easily attacked because valid URLs are easy to guess.
 +
|resource=/v1/{apikey}/profile({key})/{value}
 +
|resourceargs='''apikey''': Your [[API Key]]
 +
 +
'''key''': Profile field to search for value
 +
 +
'''value''': Value to find in the profile field
 +
|methods=GET
 +
|paramsrequired=None required
 +
}}
 +
 +
{{RESTfulExample
 +
|title=Bad Request
 +
|summary=This demonstrates a bad request, such as, the request contains invalid UTF-8 characters.
 +
|responsecode=400 Bad Request
 +
|response=<?xml version="1.0" encoding="UTF-8" ?>
 +
<result ver="ePrize Web Services 1.0">
 +
<result></result>
 +
<status>1</status>
 +
</result>
 +
}}
 +
 +
{{RESTfulExample
 +
|title=Found Profile
 +
|responsecode=303 See Other
 +
|responseloc=/v1/{apikey}/profile/{uid}.{webkey}
 +
|response=<?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>
 +
<public1>public-value1</public1>
 +
<public2>public-value2</public2>
 +
...
 +
<publicN>public-valueN</publicN>
 +
</profile>
 +
</result>
 +
}}
 +
 +
{{RESTfulExample
 +
|title=Unable to find Profile
 +
|responsecode=404 Not Found
 +
|response=<?xml version="1.0" encoding="UTF-8" ?>
 +
<result ver="ePrize Web Services 1.0">
 +
<status>0</status>
 +
</result>
 +
}}

Current revision

API Home Page :: Profiles

Summary

Find a profile by a specific profile field and value. If a profile is found, the canonical location will be returned in the "Location:" response header.

Example of getting a profile by mobile number: 

 GET /v1/{apikey}/profile(mobile)/1-888-555-1212

And email address: 

 GET /v1/{apikey}/profile(email)/person@example.com

It is important to 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. For more information on using URLs, please see the API Request/Response Overview.

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

Resource

/v1/{apikey}/profile({key})/{value}

Valid Methods

GET

Resource Arguments

Note: resource arguments are always required.

apikey: Your API Key

key: Profile field to search for value

value: Value to find in the profile field

Parameters Required

None required



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}.{webkey} 

<?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>
    <public1>public-value1</public1>
    <public2>public-value2</public2>
    ...
    <publicN>public-valueN</publicN>
  </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>


Retrieved from "https://code.helloworld.com/wiki/index.php/Fetch_profile_by_key"
Personal tools