class FlickRaw::Flickr::People

Public Instance Methods

findByEmail(:find_email => 'find_email') click to toggle source

flickr.people.findByEmail request.

Return a user's NSID, given their email address

Arguments

find_email (required)

The email address of the user to find (may be primary or secondary).

Error codes

  • 1: User not found

    No user with the supplied email address was found.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

Stewart
# Generated automatically from flickr api
  def findByEmail(*args)
    @flickr.call 'flickr.people.findByEmail', *args
  end
findByUsername(:username => 'username') click to toggle source

flickr.people.findByUsername request.

Return a user's NSID, given their username.

Arguments

username (required)

The username of the user to lookup.

Error codes

  • 1: User not found

    No user with the supplied username was found.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

Stewart
# Generated automatically from flickr api
  def findByUsername(*args)
    @flickr.call 'flickr.people.findByUsername', *args
  end
getGroups(:user_id => 'user_id',:extras => 'extras',:page => 'page',:per_page => 'per_page') click to toggle source

flickr.people.getGroups request.

Returns the list of groups a user is a member of.

Arguments

user_id (required)

The NSID of the user to fetch groups for.

extras

A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: privacy, throttle, restrictions

page

Page number for the groups

per_page

Number of groups per page

Error codes

  • 1: User not found

    The user id passed did not match a Flickr user.

  • 96: Invalid signature

    The passed signature was invalid.

  • 97: Missing signature

    The call required signing but no signature was sent.

  • 98: Login failed / Invalid auth token

    The login details or auth token passed were invalid.

  • 99: User not logged in / Insufficient permissions

    The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

# Generated automatically from flickr api
  def getGroups(*args)
    @flickr.call 'flickr.people.getGroups', *args
  end
getInfo(:user_id => 'user_id',:url => 'url',:fb_connected => 'fb_connected',:storage => 'storage',:datecreate => 'datecreate') click to toggle source

flickr.people.getInfo request.

Get information about a user.

Arguments

user_id (required)

The NSID of the user to fetch information about.

url (required)

As an alternative to user_id, load a member based on URL, either photos or people URL.

fb_connected

If set to 1, it checks if the user is connected to Facebook and returns that information back.

storage

If set to 1, it returns the storage information about the user, like the storage used and storage available.

datecreate

If set to 1, it returns the timestamp of the user's account creation, in MySQL DATETIME format.

Error codes

  • 1: User not found

    The user id passed did not match a Flickr user.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

beesCal Hendersoneea6cd28e3d0003ab51b0058a684d94980b727acVancouver, Canadahttp://www.flickr.com/photos/bees/http://www.flickr.com/people/bees/10715103911900-09-02 09:11:24449
# Generated automatically from flickr api
  def getInfo(*args)
    @flickr.call 'flickr.people.getInfo', *args
  end
getLimits() click to toggle source

flickr.people.getLimits request.

Returns the photo and video limits that apply to the calling user account.

Arguments

Error codes

  • 96: Invalid signature

    The passed signature was invalid.

  • 97: Missing signature

    The call required signing but no signature was sent.

  • 98: Login failed / Invalid auth token

    The login details or auth token passed were invalid.

  • 99: User not logged in / Insufficient permissions

    The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

# Generated automatically from flickr api
  def getLimits(*args)
    @flickr.call 'flickr.people.getLimits', *args
  end
getPhotos(:user_id => 'user_id',:safe_search => 'safe_search',:min_upload_date => 'min_upload_date',:max_upload_date => 'max_upload_date',:min_taken_date => 'min_taken_date',:max_taken_date => 'max_taken_date',:content_type => 'content_type',:privacy_filter => 'privacy_filter',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.people.getPhotos request.

Return photos from the given user's photostream. Only photos visible to the calling user will be returned. This method must be authenticated; to return public photos for a user, use flickr.people.getPublicPhotos.

Arguments

user_id (required)

The NSID of the user who's photos to return. A value of “me” will return the calling user's photos.

safe_search

Safe search setting:

1 for safe. 2 for moderate. 3 for restricted.

(Please note: Un-authed calls can only see Safe content.)

min_upload_date

Minimum upload date. Photos with an upload date greater than or equal to this value will be returned. The date should be in the form of a unix timestamp.

max_upload_date

Maximum upload date. Photos with an upload date less than or equal to this value will be returned. The date should be in the form of a unix timestamp.

min_taken_date

Minimum taken date. Photos with an taken date greater than or equal to this value will be returned. The date should be in the form of a mysql datetime.

max_taken_date

Maximum taken date. Photos with an taken date less than or equal to this value will be returned. The date should be in the form of a mysql datetime.

content_type

Content Type setting:

1 for photos only. 2 for screenshots only. 3 for 'other' only. 4 for photos and screenshots. 5 for screenshots and 'other'. 6 for photos and 'other'. 7 for photos, screenshots, and 'other' (all).

privacy_filter

Return photos only matching a certain privacy level. This only applies when making an authenticated call to view photos you own. Valid values are:

1 public photos 2 private photos visible to friends 3 private photos visible to family 4 private photos visible to friends & family 5 completely private photos

extras

A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_q, url_m, url_n, url_z, url_c, url_l, url_o

per_page

Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.

page

The page of results to return. If this argument is omitted, it defaults to 1.

Error codes

  • 1: Required arguments missing

  • 2: Unknown user

    A user_id was passed which did not match a valid flickr user.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def getPhotos(*args)
    @flickr.call 'flickr.people.getPhotos', *args
  end
getPhotosOf(:user_id => 'user_id',:owner_id => 'owner_id',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.people.getPhotosOf request.

Returns a list of photos containing a particular Flickr member.

Arguments

user_id (required)

The NSID of the user you want to find photos of. A value of “me” will search against photos of the calling user, for authenticated calls.

owner_id

An NSID of a Flickr member. This will restrict the list of photos to those taken by that member.

extras

A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, date_person_added, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_q, url_m, url_n, url_z, url_c, url_l, url_o

per_page

Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.

page

The page of results to return. If this argument is omitted, it defaults to 1.

Error codes

  • 1: User not found.

    A user_id was passed which did not match a valid flickr user.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

# Generated automatically from flickr api
  def getPhotosOf(*args)
    @flickr.call 'flickr.people.getPhotosOf', *args
  end
getPublicGroups(:user_id => 'user_id',:invitation_only => 'invitation_only') click to toggle source

flickr.people.getPublicGroups request.

Returns the list of public groups a user is a member of.

Arguments

user_id (required)

The NSID of the user to fetch groups for.

invitation_only

Include public groups that require an invitation or administrator approval to join.

Error codes

  • 1: User not found

    The user id passed did not match a Flickr user.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

# Generated automatically from flickr api
  def getPublicGroups(*args)
    @flickr.call 'flickr.people.getPublicGroups', *args
  end
getPublicPhotos(:user_id => 'user_id',:safe_search => 'safe_search',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.people.getPublicPhotos request.

Get a list of public photos for the given user.

Arguments

user_id (required)

The NSID of the user who's photos to return.

safe_search

Safe search setting:

1 for safe. 2 for moderate. 3 for restricted.

(Please note: Un-authed calls can only see Safe content.)

extras

A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: description, license, date_upload, date_taken, owner_name, icon_server, original_format, last_update, geo, tags, machine_tags, o_dims, views, media, path_alias, url_sq, url_t, url_s, url_q, url_m, url_n, url_z, url_c, url_l, url_o

per_page

Number of photos to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.

page

The page of results to return. If this argument is omitted, it defaults to 1.

Error codes

  • 1: User not found

    The user NSID passed was not a valid user NSID.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

# Generated automatically from flickr api
  def getPublicPhotos(*args)
    @flickr.call 'flickr.people.getPublicPhotos', *args
  end
getUploadStatus() click to toggle source

flickr.people.getUploadStatus request.

Returns information for the calling user related to photo uploads.

Arguments

Error codes

  • 96: Invalid signature

    The passed signature was invalid.

  • 97: Missing signature

    The call required signing but no signature was sent.

  • 98: Login failed / Invalid auth token

    The login details or auth token passed were invalid.

  • 99: User not logged in / Insufficient permissions

    The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.

  • 100: Invalid API Key

    The API key passed was not valid or has expired.

  • 105: Service currently unavailable

    The requested service is temporarily unavailable.

  • 106: Write operation failed

    The requested operation failed due to a temporary issue.

  • 111: Format “xxx” not found

    The requested response format was not found.

  • 112: Method “xxx” not found

    The requested method was not found.

  • 114: Invalid SOAP envelope

    The SOAP envelope send in the request could not be parsed.

  • 115: Invalid XML-RPC Method Call

    The XML-RPC request document could not be parsed.

  • 116: Bad URL found

    One or more arguments contained a URL that has been used for abuse on Flickr.

Returns

Bees
# Generated automatically from flickr api
  def getUploadStatus(*args)
    @flickr.call 'flickr.people.getUploadStatus', *args
  end