class FlickRaw::Flickr::Photos::Notes

Public Instance Methods

add(:photo_id => 'photo_id',:note_x => 'note_x',:note_y => 'note_y',:note_w => 'note_w',:note_h => 'note_h',:note_text => 'note_text') click to toggle source

flickr.photos.notes.add request.

Add a note to a photo. Coordinates and sizes are in pixels, based on the 500px image size shown on individual photo pages.

Arguments

photo_id (required)

The id of the photo to add a note to

note_x (required)

The left coordinate of the note

note_y (required)

The top coordinate of the note

note_w (required)

The width of the note

note_h (required)

The height of the note

note_text (required)

The description of the note

Error codes

  • 1: Photo not found

    The photo id passed was not a valid photo id

  • 2: User cannot add notes

    The calling user does not have permission to add a note to this photo

  • 3: Missing required arguments

    One or more of the required arguments were not supplied.

  • 4: Maximum number of notes reached

    The maximum number of notes for the photo has been reached.

  • 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 add(*args)
    @flickr.call 'flickr.photos.notes.add', *args
  end
delete(:note_id => 'note_id') click to toggle source

flickr.photos.notes.delete request.

Delete a note from a photo.

Arguments

note_id (required)

The id of the note to delete

Error codes

  • 1: Note not found

    The note id passed was not a valid note id

  • 2: User cannot delete note

    The calling user does not have permission to delete the specified note

  • 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.notes.delete', *args
  end
edit(:note_id => 'note_id',:note_x => 'note_x',:note_y => 'note_y',:note_w => 'note_w',:note_h => 'note_h',:note_text => 'note_text') click to toggle source

flickr.photos.notes.edit request.

Edit a note on a photo. Coordinates and sizes are in pixels, based on the 500px image size shown on individual photo pages.

Arguments

note_id (required)

The id of the note to edit

note_x (required)

The left coordinate of the note

note_y (required)

The top coordinate of the note

note_w (required)

The width of the note

note_h (required)

The height of the note

note_text (required)

The description of the note

Error codes

  • 1: Note not found

    The note id passed was not a valid note id

  • 2: User cannot edit note

    The calling user does not have permission to edit the specified note

  • 3: Missing required arguments

    One or more 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.

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