class FlickRaw::Flickr::Photos::People

Public Instance Methods

add(:photo_id => 'photo_id',:user_id => 'user_id',:person_x => 'person_x',:person_y => 'person_y',:person_w => 'person_w',:person_h => 'person_h',:persons => 'persons') click to toggle source

flickr.photos.people.add request.

Add a person to a photo. Coordinates and sizes of boxes are optional; they are measured 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 person to.
user_id (required): The NSID of the user to add to the photo.
person_x: The left-most pixel co-ordinate of the box around the person.
person_y: The top-most pixel co-ordinate of the box around the person.
person_w: The width (in pixels) of the box around the person.
person_h: The height (in pixels) of the box around the person.
persons: A JSON array of 'person' instances. Each person contains the following properties:

face_id: An id obtained by a previous call to flickr.photos.getInfo x: X coordinate of the top left of the bounding box, normalized by the width of the photo (between 0 and 1) y: X coordinate of the top left of the bounding box, normalized by the height of the photo (between 0 and 1) w: Width of the bounding box, normalized by the width of the photo (between 0 and 1) h: Height of the bounding box, normalized by the height of the photo (between 0 and 1) user_id: Flickr user_id of the person being tagged person_id: A person_id, in case the person being tagged does not have a Flickr identity but was previously tagged in other photos fullname: The full name of the person being tagged, in case the person being tagged does not have a Flickr identity and was not previously tagged in other photos

One of face_id or x,y,w,h are required. One of user_id, fullname, person_id are required.

Error codes

1: Person not found

The NSID passed was not a valid user id.
2: Photo not found

The photo id passed was not a valid photo id.
3: User cannot add this person to photos

The person being added to the photo does not allow the calling user to add them.
4: User cannot add people to that photo

The owner of the photo doesn't allow the calling user to add people to their photos.
5: Person can't be tagged in that photo

The person being added to the photo does not want to be identified in this photo.
6: Some co-ordinate paramters were blank

Not all of the co-ordinate parameters (person_x, person_y, person_w, person_h) were passed with valid values.
7: Can't add that person to a non-public photo

You can only add yourself to another member's non-public photos.
8: Too many people in that photo

The maximum number of people has already been added to the photo.
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 add(*args)
    @flickr.call 'flickr.photos.people.add', *args
  end

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

flickr.photos.people.delete request.

Remove a person from a photo.

Arguments

photo_id (required): The id of the photo to remove a person from.
user_id (required): The NSID of the person to remove from the photo.
email: An email address for an invited user.

Error codes

1: Person not found

The NSID passed was not a valid user id.
2: Photo not found

The photo id passed was not a valid photo id.
3: User cannot remove that person

The calling user did not have permission to remove this person from this photo.
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.people.delete', *args
  end

deleteCoords(:photo_id => 'photo_id',:user_id => 'user_id') click to toggle source

flickr.photos.people.deleteCoords request.

Remove the bounding box from a person in a photo

Arguments

photo_id (required): The id of the photo to edit a person in.
user_id (required): The NSID of the person whose bounding box you want to remove.

Error codes

1: Person not found

The NSID passed was not a valid user id.
2: Photo not found

The photo id passed was not a valid photo id.
3: User cannot edit that person in that photo

The calling user is neither the person depicted in the photo nor the person who added the bounding box.
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 deleteCoords(*args)
    @flickr.call 'flickr.photos.people.deleteCoords', *args
  end

editCoords(:photo_id => 'photo_id',:user_id => 'user_id',:person_x => 'person_x',:person_y => 'person_y',:person_w => 'person_w',:person_h => 'person_h',:email => 'email') click to toggle source

flickr.photos.people.editCoords request.

Edit the bounding box of an existing person on a photo.

Arguments

photo_id (required): The id of the photo to edit a person in.
user_id (required): The NSID of the person to edit in a photo.
person_x (required): The left-most pixel co-ordinate of the box around the person.
person_y (required): The top-most pixel co-ordinate of the box around the person.
person_w (required): The width (in pixels) of the box around the person.
person_h (required): The height (in pixels) of the box around the person.
email: An email address for an 'invited' person in a photo

Error codes

1: Person not found

The NSID passed was not a valid user id.
2: Photo not found

The photo id passed was not a valid photo id.
3: User cannot edit that person in that photo

The calling user did not originally add this person to the photo, and is not the person in question.
4: Some co-ordinate paramters were blank

Not all of the co-ordinate parameters (person_x, person_y, person_w, person_h) were passed with valid values.
5: No co-ordinates given

None of the co-ordinate parameters were valid.
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 editCoords(*args)
    @flickr.call 'flickr.photos.people.editCoords', *args
  end

getList(:photo_id => 'photo_id',:extras => 'extras') click to toggle source

flickr.photos.people.getList request.

Get a list of people in a given photo.

Arguments

photo_id (required): The id of the photo to get a list of people for.
extras: Accepts the following extras: icon_urls, icon_urls_deep, paid_products

icon_urls, icon_urls_deep: returns the persons buddy icon urls paid_products: returns if the person is pro or has a add on.

Error codes

1: Photo not found

The photo id passed was not a 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.

Returns

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