Usercard Profile

Description

The Usercard is the core data in the user's profile containing slightly more information than the Tinyusercard.

URI

GET returns the usercard profile of the profile owner with the specified {guid}.

https://social.yahooapis.com/v1/user/{guid}/profile/usercard

Filters

Filtering by GUID

Calling GET on the following URI returns the usercard profiles of the users identified by GUIDs {guid1}, {guid2}, and {guid3}.

https://social.yahooapis.com/v1/users.guid({guid1},{guid2},{guid3})/profile/usercard

Last Name Search

Calling GET on the following URI returns the usercard profiles of users whose last name starts with {familyName_prefix_string}.

https://social.yahooapis.com/v1/users.starts(familyName,{family_prefix_string})/profile/usercard

Nickname Search

Calling GET on the following URI returns the usercard profiles of users whose nickname starts with {nickname_prefix_string}.

https://social.yahooapis.com/v1/users.starts(nickname,{nickname_prefix_string})/profile/usercard

Calling GET on the following URI returns the usercard profiles of users whose email contains the string {email_string}.

https://social.yahooapis.com/v1/users.email({email_string})/profile/usercard

HTTP Operations Supported

  • GET

Query Parameters Supported

  • callback
  • format

Matrix Parameters Supported

  • start
  • count

Scopes Required

  • GET: Read Yahoo Profiles

Elements of the Usercard Profile Object

Element JSON Data Type XML Schema Data Type Description
count number nonNegativeInteger Total number of usercards.
created string dateTime Date resource was created.
displayAge number positiveInteger The proclaimed age chosen by the user, assumed to be public information. There is no check or verification. User can claim any age.
gender string enum The proclaimed gender chosen by the user, and assumed to be public information. There is no check or verification on this. Allowed values are "M", "F", or "Unspecified".
guid string string GUID of the profile owner.
height number positiveInteger Image height.
image Image Object Image Object Image of the profile owner.
imageURL string anyURI Display image of the profile owner. Returns a 48x48 pixeled image.
lastStatusModified string dateTime Time of the last status update.
location string string The proclaimed location of the profile owner. There is no check or verification on this.
memberSince string dateTime Date of ID registration.
message string string Status text of the profile owner.
nickname string string Display name of the profile owner.
profileURL string anyURI URL of the profile.
size string string Image size (WxH).
start number nonNegativeInteger Index of first usercard returned.
status Status Object Status Object Object containing the profile owner's status.
total number nonNegativeInteger Number of usercards returned.
updated string dateTime Date resource was last modified.
uri string anyURI Reference to the actual resource.
width number positiveInteger Image width.

JSON Syntax for Single Usercard Profile Object

JSON Syntax for Multiple Usercard Profile Objects

Example JSON Response Body for GET Usercard

Example XML Response Body for GET Usercard

Table of Contents