Fetch profile by key

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search

Ken-fox (Talk | contribs)
(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...)
Next diff →

Revision as of 12:58, 2 March 2009

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 Not Found

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.

Personal tools