class FlickRaw::Flickr::Photos

Public Instance Methods

addTags(:photo_id => 'photo_id',:tags => 'tags') click to toggle source

flickr.photos.addTags request.

Add tags to a photo.

Arguments

photo_id (required)

The id of the photo to add tags to.

tags (required)

The tags to add to the photo.

Error codes

  • 1: Photo not found

    The photo id passed was not the id of a photo that the calling user can add tags to. It could be an invalid id, or the user may not have permission to add tags to it.

  • 2: Maximum number of tags reached

    The maximum number of tags for the photo has been reached - no more tags can be added. If the current count is less than the maximum, but adding all of the tags for this request would go over the limit, the whole request is ignored. I.E. when you get this message, none of the requested tags have been added.

  • 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.

# Generated automatically from flickr api
  def addTags(*args)
    @flickr.call 'flickr.photos.addTags', *args
  end
comments()

Returns a Comments object.

delete(:photo_id => 'photo_id') click to toggle source

flickr.photos.delete request.

Delete a photo from flickr.

Arguments

photo_id (required)

The id of the photo to delete.

Error codes

  • 1: Photo not found

    The photo id was not the id of a photo belonging to the calling 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.

# Generated automatically from flickr api
  def delete(*args)
    @flickr.call 'flickr.photos.delete', *args
  end
geo()

Returns a Geo object.

getAllContexts(:photo_id => 'photo_id') click to toggle source

flickr.photos.getAllContexts request.

Returns all visible sets and pools the photo belongs to.

Arguments

photo_id (required)

The photo to return information for.

Error codes

  • 1: Photo not found

    The photo id passed was not the id of a valid photo.

  • 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 getAllContexts(*args)
    @flickr.call 'flickr.photos.getAllContexts', *args
  end
getContactsPhotos(:count => 'count',:just_friends => 'just_friends',:single_photo => 'single_photo',:include_self => 'include_self',:extras => 'extras') click to toggle source

flickr.photos.getContactsPhotos request.

Fetch a list of recent photos from the calling users' contacts.

Arguments

count

Number of photos to return. Defaults to 10, maximum 50. This is only used if single_photo is not passed.

just_friends

set as 1 to only show photos from friends and family (excluding regular contacts).

single_photo

Only fetch one photo (the latest) per contact, instead of all photos in chronological order.

include_self

Set to 1 to include photos from the calling user.

extras

A comma-delimited list of extra information to fetch for each returned record. Currently supported fields include: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update. For more information see extras under flickr.photos.search.

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 getContactsPhotos(*args)
    @flickr.call 'flickr.photos.getContactsPhotos', *args
  end
getContactsPublicPhotos(:user_id => 'user_id',:count => 'count',:just_friends => 'just_friends',:single_photo => 'single_photo',:include_self => 'include_self',:extras => 'extras') click to toggle source

flickr.photos.getContactsPublicPhotos request.

Fetch a list of recent public photos from a users' contacts.

Arguments

user_id (required)

The NSID of the user to fetch photos for.

count

Number of photos to return. Defaults to 10, maximum 50. This is only used if single_photo is not passed.

just_friends

set as 1 to only show photos from friends and family (excluding regular contacts).

single_photo

Only fetch one photo (the latest) per contact, instead of all photos in chronological order.

include_self

Set to 1 to include photos from the user specified by user_id.

extras

A comma-delimited list of extra information to fetch for each returned record. Currently supported fields are: license, date_upload, date_taken, owner_name, icon_server, original_format, last_update.

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.

Returns

# Generated automatically from flickr api
  def getContactsPublicPhotos(*args)
    @flickr.call 'flickr.photos.getContactsPublicPhotos', *args
  end
getContext(:photo_id => 'photo_id',:num_prev => 'num_prev',:num_next => 'num_next',:extras => 'extras',:order_by => 'order_by',:view_as => 'view_as') click to toggle source

flickr.photos.getContext request.

Returns next and previous photos for a photo in a photostream.

Arguments

photo_id (required)

The id of the photo to fetch the context for.

num_prev
num_next
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_m, url_z, url_l, url_o

order_by

Accepts datetaken or dateposted and returns results in the proper order.

view_as

Can take values public to indicate that the profile has to be viewed as public and returns context only in public setting

Error codes

  • 1: Photo not found

    The photo id passed was not a valid photo id, or was the id of a photo that the calling user does not have permission to view.

  • 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 getContext(*args)
    @flickr.call 'flickr.photos.getContext', *args
  end
getCounts(:dates => 'dates',:taken_dates => 'taken_dates') click to toggle source

flickr.photos.getCounts request.

Gets a list of photo counts for the given date ranges for the calling user.

Arguments

dates

A comma delimited list of unix timestamps, denoting the periods to return counts for. They should be specified smallest first.

taken_dates

A comma delimited list of mysql datetimes, denoting the periods to return counts for. They should be specified smallest first.

Error codes

  • 1: No dates specified

    Neither dates nor taken_dates were specified.

  • 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 getCounts(*args)
    @flickr.call 'flickr.photos.getCounts', *args
  end
getExif(:photo_id => 'photo_id',:secret => 'secret',:extras => 'extras') click to toggle source

flickr.photos.getExif request.

Retrieves a list of EXIF/TIFF/GPS tags for a given photo. The calling user must have permission to view the photo.

Arguments

photo_id (required)

The id of the photo to fetch information for.

secret

The secret for the photo. If the correct secret is passed then permissions checking is skipped. This enables the 'sharing' of individual photos by passing around the id and secret.

extras

Error codes

  • 1: Photo not found

    The photo id was either invalid or was for a photo not viewable by the calling user.

  • 2: Permission denied

    The owner of the photo does not want to share EXIF data.

  • 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

Canon90/10f/964/1, 42/1, 4414/10064° 42' 44.14"
# Generated automatically from flickr api
  def getExif(*args)
    @flickr.call 'flickr.photos.getExif', *args
  end
getFavorites(:photo_id => 'photo_id',:page => 'page',:per_page => 'per_page') click to toggle source

flickr.photos.getFavorites request.

Returns the list of people who have favorited a given photo.

Arguments

photo_id (required)

The ID of the photo to fetch the favoriters list for.

page

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

per_page

Number of usres to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.

Error codes

  • 1: Photo not found

    The specified photo does not exist, or the calling user does not have permission to view it.

  • 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 getFavorites(*args)
    @flickr.call 'flickr.photos.getFavorites', *args
  end
getInfo(:photo_id => 'photo_id',:secret => 'secret',:humandates => 'humandates',:privacy_filter => 'privacy_filter',:get_contexts => 'get_contexts',:get_geofences => 'get_geofences',:datecreate => 'datecreate',:extras => 'extras') click to toggle source

flickr.photos.getInfo request.

Get information about a photo. The calling user must have permission to view the photo.

Arguments

photo_id (required)

The id of the photo to get information for.

secret

The secret for the photo. If the correct secret is passed then permissions checking is skipped. This enables the 'sharing' of individual photos by passing around the id and secret.

humandates
privacy_filter
get_contexts
get_geofences

Return geofence information in the photo's location property

datecreate

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

extras

Error codes

  • 1: Photo not found.

    The photo id was either invalid or was for a photo not viewable by the calling 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

orford_castle_tasterhello!1foowooyayhooplahttp://www.flickr.com/photos/bees/2733/
# Generated automatically from flickr api
  def getInfo(*args)
    @flickr.call 'flickr.photos.getInfo', *args
  end
getNotInSet(:max_upload_date => 'max_upload_date',:min_taken_date => 'min_taken_date',:max_taken_date => 'max_taken_date',:privacy_filter => 'privacy_filter',:media => 'media',:min_upload_date => 'min_upload_date',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.photos.getNotInSet request.

Returns a list of your photos that are not part of any sets.

Arguments

max_upload_date

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

min_taken_date

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

max_taken_date

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

privacy_filter

Return photos only matching a certain privacy level. 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

media

Filter results by media type. Possible values are all (default), photos or videos

min_upload_date

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

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

  • 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.

# Generated automatically from flickr api
  def getNotInSet(*args)
    @flickr.call 'flickr.photos.getNotInSet', *args
  end
getPerms(:photo_id => 'photo_id') click to toggle source

flickr.photos.getPerms request.

Get permissions for a photo.

Arguments

photo_id (required)

The id of the photo to get permissions for.

Error codes

  • 1: Photo not found

    The photo id passed was not a valid photo id of a photo belonging to the calling 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 getPerms(*args)
    @flickr.call 'flickr.photos.getPerms', *args
  end
getRecent(:jump_to => 'jump_to',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.photos.getRecent request.

Returns a list of the latest public photos uploaded to flickr.

Arguments

jump_to
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: bad value for jump_to, must be valid photo id.

  • 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 getRecent(*args)
    @flickr.call 'flickr.photos.getRecent', *args
  end
getSizes(:photo_id => 'photo_id') click to toggle source

flickr.photos.getSizes request.

Returns the available sizes for a photo. The calling user must have permission to view the photo.

Arguments

photo_id (required)

The id of the photo to fetch size information for.

Error codes

  • 1: Photo not found

    The photo id passed was not a valid photo id.

  • 2: Permission denied

    The calling user does not have permission to view the photo.

  • 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 getSizes(*args)
    @flickr.call 'flickr.photos.getSizes', *args
  end
getUntagged(:min_upload_date => 'min_upload_date',:max_upload_date => 'max_upload_date',:min_taken_date => 'min_taken_date',:max_taken_date => 'max_taken_date',:privacy_filter => 'privacy_filter',:media => 'media',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.photos.getUntagged request.

Returns a list of your photos with no tags.

Arguments

min_upload_date

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

max_upload_date

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

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 or unix timestamp.

max_taken_date

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

privacy_filter

Return photos only matching a certain privacy level. 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

media

Filter results by media type. Possible values are all (default), photos or videos

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

  • 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.

# Generated automatically from flickr api
  def getUntagged(*args)
    @flickr.call 'flickr.photos.getUntagged', *args
  end
getWithGeoData(:min_upload_date => 'min_upload_date',:max_upload_date => 'max_upload_date',:min_taken_date => 'min_taken_date',:max_taken_date => 'max_taken_date',:privacy_filter => 'privacy_filter',:sort => 'sort',:media => 'media',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.photos.getWithGeoData request.

Returns a list of your geo-tagged photos.

Arguments

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.

privacy_filter

Return photos only matching a certain privacy level. 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

sort

The order in which to sort returned photos. Deafults to date-posted-desc. The possible values are: date-posted-asc, date-posted-desc, date-taken-asc, date-taken-desc, interestingness-desc, and interestingness-asc.

media

Filter results by media type. Possible values are all (default), photos or videos

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

  • 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.

# Generated automatically from flickr api
  def getWithGeoData(*args)
    @flickr.call 'flickr.photos.getWithGeoData', *args
  end
getWithoutGeoData(:max_upload_date => 'max_upload_date',:min_taken_date => 'min_taken_date',:max_taken_date => 'max_taken_date',:privacy_filter => 'privacy_filter',:sort => 'sort',:media => 'media',:min_upload_date => 'min_upload_date',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.photos.getWithoutGeoData request.

Returns a list of your photos which haven't been geo-tagged.

Arguments

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 can be in the form of a mysql datetime or unix timestamp.

max_taken_date

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

privacy_filter

Return photos only matching a certain privacy level. 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

sort

The order in which to sort returned photos. Deafults to date-posted-desc. The possible values are: date-posted-asc, date-posted-desc, date-taken-asc, date-taken-desc, interestingness-desc, and interestingness-asc.

media

Filter results by media type. Possible values are all (default), photos or videos

min_upload_date

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

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

  • 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.

# Generated automatically from flickr api
  def getWithoutGeoData(*args)
    @flickr.call 'flickr.photos.getWithoutGeoData', *args
  end
licenses()

Returns a Licenses object.

notes()

Returns a Notes object.

people()

Returns a People object.

recentlyUpdated(:min_date => 'min_date',:extras => 'extras',:per_page => 'per_page',:page => 'page') click to toggle source

flickr.photos.recentlyUpdated request.

Return a list of your photos that have been recently created or which have been recently modified.

Recently modified may mean that the photo's metadata (title, description, tags) may have been changed or a comment has been added (or just modified somehow :-)

Arguments

min_date (required)

A Unix timestamp or any English textual datetime description indicating the date from which modifications should be compared.

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 argument missing.

    Some or all of the required arguments were not supplied.

  • 2: Not a valid date

    The date argument did not pass validation.

  • 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 recentlyUpdated(*args)
    @flickr.call 'flickr.photos.recentlyUpdated', *args
  end
removeTag(:tag_id => 'tag_id') click to toggle source

flickr.photos.removeTag request.

Remove a tag from a photo.

Arguments

tag_id (required)

The tag to remove from the photo. This parameter should contain a tag id, as returned by flickr.photos.getInfo.

Error codes

  • 1: Tag not found

    The calling user doesn't have permission to delete the specified tag. This could mean it belongs to someone else, or doesn't exist.

  • 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.

# Generated automatically from flickr api
  def removeTag(*args)
    @flickr.call 'flickr.photos.removeTag', *args
  end
setContentType(:photo_id => 'photo_id',:content_type => 'content_type') click to toggle source

flickr.photos.setContentType request.

Set the content type of a photo.

Arguments

photo_id (required)

The id of the photo to set the adultness of.

content_type (required)

The content type of the photo. Must be one of: 1 for Photo, 2 for Screenshot, and 3 for Other.

Error codes

  • 1: Photo not found

    The photo id passed was not a valid photo id of a photo belonging to the calling user.

  • 2: Required arguments missing

    Some or all of the required arguments were not supplied.

  • 3: Change not allowed

    Changing the content type of this photo is not allowed.

  • 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 setContentType(*args)
    @flickr.call 'flickr.photos.setContentType', *args
  end
setDates(:photo_id => 'photo_id',:date_posted => 'date_posted',:date_taken => 'date_taken',:date_taken_granularity => 'date_taken_granularity') click to toggle source

flickr.photos.setDates request.

Set one or both of the dates for a photo.

Arguments

photo_id (required)

The id of the photo to edit dates for.

date_posted

The date the photo was uploaded to flickr (see the dates documentation)

date_taken

The date the photo was taken (see the dates documentation)

date_taken_granularity

The granularity of the date the photo was taken (see the dates documentation)

Error codes

  • 1: Photo not found

    The photo id was not the id of a valid photo belonging to the calling user.

  • 2: Not enough arguments

    No dates were specified to be changed.

  • 3: Invalid granularity

    The value passed for 'granularity' was not a valid flickr date granularity.

  • 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.

# Generated automatically from flickr api
  def setDates(*args)
    @flickr.call 'flickr.photos.setDates', *args
  end
setMeta(:photo_id => 'photo_id',:title => 'title',:description => 'description') click to toggle source

flickr.photos.setMeta request.

Set the meta information for a photo.

Arguments

photo_id (required)

The id of the photo to set information for.

title (required)

The title for the photo.

description (required)

The description for the photo.

Error codes

  • 1: Photo not found

    The photo id passed was not the id of a photo belonging to the calling user. It might be an invalid id, or the photo might be owned by another 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.

# Generated automatically from flickr api
  def setMeta(*args)
    @flickr.call 'flickr.photos.setMeta', *args
  end
setPerms(:photo_id => 'photo_id',:is_public => 'is_public',:is_friend => 'is_friend',:is_family => 'is_family',:perm_comment => 'perm_comment',:perm_addmeta => 'perm_addmeta') click to toggle source

flickr.photos.setPerms request.

Set permissions for a photo.

Arguments

photo_id (required)

The id of the photo to set permissions for.

is_public (required)

1 to set the photo to public, 0 to set it to private.

is_friend (required)

1 to make the photo visible to friends when private, 0 to not.

is_family (required)

1 to make the photo visible to family when private, 0 to not.

perm_comment (required)

who can add comments to the photo and it's notes. one of:0: nobody1: friends & family2: contacts3: everybody

perm_addmeta (required)

who can add notes and tags to the photo. one of:0: nobody / just the owner1: friends & family2: contacts3: everybody

Error codes

  • 1: Photo not found

    The photo id passed was not a valid photo id of a photo belonging to the calling user.

  • 2: Required arguments missing

    Some or all of the required arguments were not supplied.

  • 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

1234
# Generated automatically from flickr api
  def setPerms(*args)
    @flickr.call 'flickr.photos.setPerms', *args
  end
setSafetyLevel(:photo_id => 'photo_id',:safety_level => 'safety_level',:hidden => 'hidden') click to toggle source

flickr.photos.setSafetyLevel request.

Set the safety level of a photo.

Arguments

photo_id (required)

The id of the photo to set the adultness of.

safety_level

The safety level of the photo. Must be one of:

1 for Safe, 2 for Moderate, and 3 for Restricted.

hidden

Whether or not to additionally hide the photo from public searches. Must be either 1 for Yes or 0 for No.

Error codes

  • 1: Photo not found

    The photo id passed was not a valid photo id of a photo belonging to the calling user.

  • 2: Invalid or missing arguments

    Neither a valid safety level nor a hidden value were passed.

  • 3: Change not allowed

    Changing the safety level of this photo is not allowed.

  • 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 setSafetyLevel(*args)
    @flickr.call 'flickr.photos.setSafetyLevel', *args
  end
setTags(:photo_id => 'photo_id',:tags => 'tags') click to toggle source

flickr.photos.setTags request.

Set the tags for a photo.

Arguments

photo_id (required)

The id of the photo to set tags for.

tags (required)

All tags for the photo (as a single space-delimited string).

Error codes

  • 1: Photo not found

    The photo id passed was not the id of a photo belonging to the calling user. It might be an invalid id, or the photo might be owned by another user.

  • 2: Maximum number of tags reached

    The number of tags specified exceeds the limit for the photo. No tags were modified.

  • 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.

# Generated automatically from flickr api
  def setTags(*args)
    @flickr.call 'flickr.photos.setTags', *args
  end
suggestions()

Returns a Suggestions object.

transform()

Returns a Transform object.

upload()

Returns a Upload object.