Profiles
From ePrize Developers Wiki
(Difference between revisions)
| Line 1: | Line 1: | ||
A profile holds a single consumer's information. It consists of a collection of key:value pairs (fields) where each key is unique within the profile. Much of the information within the profile is considered private or [[PII]] and will not be shared with an untrusted client. | A profile holds a single consumer's information. It consists of a collection of key:value pairs (fields) where each key is unique within the profile. Much of the information within the profile is considered private or [[PII]] and will not be shared with an untrusted client. | ||
| + | <div class="api_table"> | ||
| + | [[Profiles]] | ||
| + | {| | ||
| + | |- | ||
| + | | [[Create profile]] | ||
| + | | POST /v1/{apikey}/profiles | ||
| + | | | ||
| + | |- | ||
| + | | [[Fetch profile by key]] | ||
| + | | GET /v1/{apikey}/profile({key})/{value} | ||
| + | | | ||
| + | |- | ||
| + | | [[Fetch profile]] | ||
| + | | GET /v1/{apikey}/profile/{uid} | ||
| + | | | ||
| + | |- | ||
| + | | [[Fetch unredeemed tokens]] | ||
| + | | GET /v1/{apikey}/profile/{uid}/tokens | ||
| + | | | ||
| + | |- | ||
| + | | [[Fetch awards]] | ||
| + | | GET /v1/{apikey}/profile/{uid}/awards | ||
| + | | | ||
| + | |- | ||
| + | |} | ||
| + | </div> | ||
== Required Fields == | == Required Fields == | ||
Revision as of 19:26, 17 March 2009
A profile holds a single consumer's information. It consists of a collection of key:value pairs (fields) where each key is unique within the profile. Much of the information within the profile is considered private or PII and will not be shared with an untrusted client.
Profiles
| Create profile | POST /v1/{apikey}/profiles | |
| Fetch profile by key | GET /v1/{apikey}/profile({key})/{value} | |
| Fetch profile | GET /v1/{apikey}/profile/{uid} | |
| Fetch unredeemed tokens | GET /v1/{apikey}/profile/{uid}/tokens | |
| Fetch awards | GET /v1/{apikey}/profile/{uid}/awards |
Required Fields
- One primary key field to identify a consumer. This key is called {promokey} in the API documentation.
Standard Fields
- first_name
- last_name
- age
- address1
- address2
- address3
- city
- state
- zip
- country
- locale
