The Data Transfer Objects

V2

Album

It contains details of an album

Properties

Type Property name Description
Integer id The album identifier
Integer ownerId The identifier of the album owner
String ownerUsername The username of the owner
String title The title of the album
String description The description of the album
String coverURL The URL for the cover

Comment

It contains details of a comment related to a picture

Properties

Type Property name Description
Integer id The comment identifier
Integer ownerId The owner identifier
String ownerUsername The owner username
Integer parentId The previous comment identifier
Date date The date of the comment
String text The text of the comment
String pictureId The picture identifier to which the comment is related to

Contact

It contains contact information

Properties

Type Property name Description
Integer userId The identifier of the user
String username The username of the contact
Integer ownerId The identifier of the user of type "owner"
Boolean isFamily Is the contact from the family?
Boolean isFriend Is the a contact just a friend?
Boolean isContact Is the a contact just a basic person?

Tag

It contains tag information

Properties

Type Property name Description
Constant integer CATEGORY_WHAT To distinguish the category "WHAT". The value is 1.
Constant integer CATEGORY_WHO To distinguish the category "WHO". The value is 2.
Constant integer CATEGORY_WHERE To distinguish the category "WHERE". The value is 3.
Integer id identifier of the tag
Integer category Category of the tag, amoung : who, what and where. See constant values above.
String name name of the tag entered by the user

LocationTag

It inherits from Tag and contains tag plus location information

Properties

Type Property name Description
Constant integer CATEGORY_WHAT [Inherited from Tag] To distinguish the category "WHAT". The value is 1.
Constant integer CATEGORY_WHO [Inherited from Tag] To distinguish the category "WHO". The value is 2.
Constant integer CATEGORY_WHERE [Inherited from Tag] To distinguish the category "WHERE". The value is 3.
Integer id [Inherited from Tag] identifier of the tag
Integer category [Inherited from Tag] Category of the tag, amoung : who, what and where. See constant values above.
String name [Inherited from Tag] name of the tag entered by the user
Double latitude Latitude
Double longitude Longitude

Group

It contains details of a group

Properties

Type Property name Description
Integer id The group identifier
Integer creatorId The identifier of the group creator
String name
 The name of the group
String description
 The description of the group
String url
 The url of the group
String lastChange The last change date of the group
String creationDate The ceration date of the group
Integer members The number of members in the group
Boolean
 closed
 If the group is closed


Person

It contains information related to the person. A user is a person.

Properties

Type Property name Description
Integer id The Person identifier
String username Person name
String location The person city and the country code. The pattern is as follow: city + ", "+ countryCode
String avatarURL The URL of the avatar
String profileURL the URL of the profile

MyPerson

It inherits from Person. It contains person plus other information

Properties

Type Property name Description
Integer id [Inherited from Person] The Person identifier
String username [Inherited from Person] Person name
String location [Inherited from Person] The person city and the country code. The pattern is as follow: city + ", "+ countryCode
String avatarURL [Inherited from Person] The URL of the avatar
String profileURL [Inherited from Person] the URL of the profile
String realName the user real name
String email the user email address
String blogURL the URL of the person's blog
Date birthday the birthday of the person

GroupMember

It inherits from Person. It contains person plus other information between user and group.

Properties

Type Property name Description
Integer id [Inherited from Person] The Person identifier
String username [Inherited from Person] Person name
String location [Inherited from Person] The person city and the country code. The pattern is as follow: city + ", "+ countryCode
String avatarURL [Inherited from Person] The URL of the avatar
String profileURL [Inherited from Person] the URL of the profile
Date subscriptionDate the user's join date in the group
Boolean admin means if the user is admin of the group
Boolean banned means if the user is banned of the group
Integer groupId the group id given as parameter

Photo

It contains photo information

Properties

Type Property name Description
Integer id the photo identifier
Integer ownerId the owner's person id of the photo
String ownerUsername
 the owner's person name
String
 ownerLocation
 the owner's location (city - country)
String
 ownerAvatarUrl
 the owner's avatar url
String urlPrefix the prefix of the photo URL
String secret random secret key of the photo
String original Original version of the photo
String title Title of the photo
String description Title of the photo
Date datePosted Date when the photo has been posted
Date dateTaken Date when the photo has been taken
Boolean isContact if the photo is accessible to contacts
Boolean isFriend if the photo is accessible to friends
Boolean isFamily if the photo is accessible to the family
List of Tag tags the photo list of tags
Integer width Width of the photo (since release 2.1)
Integer height Height of the photo (since release 2.1)
Integer originalFileSize Original version file size of the photo (since release 2.1)
String mimeType MIME Type of the photo (since release 2.1)

Partner

It contains information related to the partner.

Properties

Type Property name Description
Integer id The Partner identifier
String name The name of the partner
String contactEmail The email address of the contact
String apiKey The API key owned by the partner
String secret The API secret associated to the key.

version 9 as of 1 year ago by kodemus

Comments

New comments are not being accepted at this time.