Joomeo API XML-RPC: Reference guide

Transcription

1 Joomeo API XML-RPC: Reference guide 0.8 Page 1 / 87 Joomeo API XML-RPC: Reference guide Object Reference guide Project Joomeo API XML-RPC Version Language English Creation date :00 Last update Content Joomeo API XML-RPC reference guide. Version Modification reason Date Version Adding joomeo.user.folder package Adding joomeo.user.comment package Updating joomeo.user.addcontact and joomeo.user.contact package Adding allowprint and allowcomment rights Adding the network class which replace hub class Adding methods to create folders and to manage albums into folders Adding the videos management Adding method joomeo.user.getfolderchildren Adding classes and methods to manage contacts and albums Adding methods to upload files and to create collections Upgrade of file.php script Fixed minor bug API and documentation creation

2 Joomeo API XML-RPC: Reference guide 0.8 Page 2 / 87 2 Requirements Overview API Key Current release What to know before to begin Classes joomeo.session Methods list Methods definition joomeo.system Methods list Methods definition joomeo.user Methods list Methods definition Associated scripts joomeo.user.album Methods list Methods definition joomeo.user.collection (deprecated) Methods list Methods definition joomeo.user.comment Methods list Methods definition joomeo.user.contact Methods list Methods definition joomeo.user.file Methods list Methods definition Associated scripts joomeo.user.folder Methods list Methods definition joomeo Methods list Methods definition system Methods list Methods definition Errors codes and messages XMLRPC errors API key, session and authorisations errors API methods errors... 42

3 Joomeo API XML-RPC: Reference guide 0.8 Page 3 / 87 6 Annexes XML-RPC format XML-RPC Request format XML-RPC Response format XML-RPC methods examples Method Name : joomeo.session.getproperties Method Name : joomeo.session.init Method Name : joomeo.session.initcontact Method Name : joomeo.session.kill Method Name : joomeo.user.getstatistics Method Name : joomeo.user.addalbum Method Name : joomeo.user.addcontact Method Name : joomeo.user.addfolder (to create) Method Name : joomeo.user.getalbumlist Method Name : joomeo.user.getallowedfiletype Method Name : joomeo.user.getcontactlist Method Name : joomeo.user.album.getfileslist Method Name : joomeo.user.getfolderchildren Method Name : joomeo.user.getnetwork Method Name : joomeo.user.getnumberoffiles Method Name : joomeo.user.uploadbinary Method Name : joomeo.user.album.allowcontactaccess Method Name : joomeo.user.album.delete Method Name : joomeo.user.album.deletefile Method Name : joomeo.user.album.getallowedcontactaccesslist Method Name : joomeo.user.album.getfileslist Method Name : joomeo.user.album.getnumberoffiles Method Name : joomeo.user.album.removecontactaccess Method Name : joomeo.user.album.saveuploadedfile Method Name : joomeo.user.album.update Method Name : joomeo.user.contact.delete Method Name : joomeo.user.contact.sendinvite Method Name : joomeo.user.contact.update Method Name : joomeo.user.file.delete Method Name : joomeo.user.file.getbinary Method Name : joomeo..about Method Name : system.listmethods... 86

4 Joomeo API XML-RPC: Reference guide 0.8 Page 4 / 87 2 Requirements Joomeo s Application Programming Interface (API) allows you to build your own creative applications around the content created on Joomeo. You can retrieve, explore albums, pictures from a Joomeo space. You'll need an API Key to get started, and need to use XML-RPC (1) to interact with the service. The service is available on the following URL : or

5 Joomeo API XML-RPC: Reference guide 0.8 Page 5 / 87 3 Overview Anyone is free to write application to do cool stuff with available Joomeo data via our API. Follow the steps below to build your first application : Read the Joomeo API documentation Sign up for a user account Register for an API Key (Public or Commercial) 3.1 API Key To use Joomeo's API, you need an API key. Each individual application or use of the API can use its own key. It also helps us track how it's being used so we can improve it. We encourage you to develop Commercial applications to build your business on top of Joomeo. There are few exceptions on commercial applications and we invite you to contact us for clarification. Also note that the Joomeo name, the Joomeo logo are owned and trademarked by Airsens and may not be used without permission. Have questions? Please contact us with anything you might want to know : api_developer@joomeo.com. 3.2 Current release Joomeo API : Beta 3.3 What to know before to begin There are some notions to know about Joomeo before beginning to develop with this API: 1. A Joomeo user has access to its own Joomeo space to store its files (photos, videos,... ). This Joomeo space has its own URL: With this API you have to know the joomeo space name to which you want to connect. 2. Into its Joomeo space, a user can manage contacts who be able to access to its space. Each contact has a username and password to access the Joomeo space. 3. To authenticate a user (the Joomeo space administrator) you have to know at least the of the Joomeo space administrator and its password. 4. To authenticate a contact to a Joomeo space you have to know the spacename of the Joomeo space to which you want to connect (the contact must be registred on this Joomeo space), the username of the contact and its password.

6 Joomeo API XML-RPC: Reference guide 0.8 Page 6 / 87 4 Classes These are the Joomeo APIs. Class name Description API joomeo.session Provides methods that manage functionalities such as session 0.1 initialisation, session properties/validity and session killing. joomeo.user Provides methods that manage main functionalities for a user such 0.1 as adding albums, files, contacts,... getting albums list, contacts list,... joomeo.user.album Provides methods that manage functionalities for albums such as 0.5 deleting, updating or managing album files. joomeo.user.collection Provides methods that manage functionalities for collections such as 0.1 getting files information from an album. All the methods of this class are deprecated. joomeo.user.contact Provides methods that manage functionalities for contacts such as 0.5 deleting, updating or sending messages. joomeo.user.file Contains methods for deleting and getting file. 0.1 joomeo. Contains methods to have all informations about the current 0.1 of this API. system Contains methods to have all infomations about the XML-RPC engine and the Joomeo API. 0.1

7 Joomeo API XML-RPC: Reference guide 0.8 Page 7 / joomeo.session Provides methods that manage functionalities such as session initialisation, session properties/validity and session killing Methods list Method name Description joomeo.session.getproperties Method is used to get or re-initialize a user session. GetProperties can be the first method of the API call in the application if you ever get a sessionid. joomeo.session.init Method used to initialize a user session and sets up internal control structures. Init must be the first method of the API call in the application. joomeo.session.initcontact Method used to initialize a contact session and sets up internal control structures. InitContact must be used to explore the Joomeo network. joomeo.session.kill Method used to kill an existant session. Kill must be used before leaving your application. API Methods definition joomeo.session.getproperties Method is used to get or re-initialize a user session. GetProperties can be the first method of the API call in the application if you ever get a sessionid. Request: A structure with the apikey and the sessionid apikey (Required) string Your application API key 0.5 sessionid (Required) string Session Id 0.5 Response: A structure with the properties of the current sessionid sessionid string Unique identifiant of the current session 0.5 sessiontype int 0 - User Session, 1 - Contact Session 0.5 spacename string Joomeo space name 0.5 spaceurl string Joomeo space URL 0.5 servertime double Server time allowing to synchronize with the device time (timestamp in second) 0.8 joomeo.session.init Method used to initialize a user session and sets up internal control structures. Init must be the first method of the API call in the application.

8 Joomeo API XML-RPC: Reference guide 0.8 Page 8 / 87 Request: A structure with the properties used to authenticate the user apikey (Required) string Your application API key 0.1 login (Required) string The address for the Joomeo space administrator or the username for a contact 0.1 password (Required) string The password associated to the login 0.1 spacename string Joomeo space name. This parameter is require to init a session for a contact. 0.1 Response: A structure with the properties of the current sessionid sessionid string Unique identifiant of the current session 0.1 sessiontype int 0 - User Session, 1 - Contact Session 0.1 spacename string Joomeo space name 0.5 spaceurl string Joomeo space URL 0.5 servertime double Server time allowing to synchronize with the device time (timestamp in second) 0.8 joomeo.session.initcontact Method used to initialize a contact session and sets up internal control structures. InitContact must be used to explore the Joomeo network. Request: A structure with the apikey, the sessionid and a contactid apikey (Required) string Your application API key 0.1 sessionid (Required) string An administrator session id 0.1 contactid (Required) string Contactid returned from the getnetwork Method 0.1 Response: A structure with the properties of the new sessionid sessionid string Unique identifiant of the current session 0.1 sessiontype int 1 - Contact Session 0.1 spacename string Joomeo space name 0.5 spaceurl string Joomeo space URL 0.5 joomeo.session.kill Method used to kill an existant session. Kill must be used before leaving your application. Request: A structure with the apikey and the sessionid

9 Joomeo API XML-RPC: Reference guide 0.8 Page 9 / 87 apikey (Required) string Your application API key 0.5 sessionid (Required) string An administrator session id 0.5 Response: A structure with the success member success string 1 - session killed with success 0.5

10 Joomeo API XML-RPC: Reference guide 0.8 Page 10 / joomeo.system Provides methods that allow to get information about the API such as the available protocol Methods list Method name Description joomeo.system.getavailableprotocol Method is used to get the availables protocols to exchange with API. API Methods definition joomeo.system.getavailableprotocol Method is used to get the availables protocols to exchange with API. Request: A structure with the apikey apikey (Required) string Your application API key 0.8 Response: A structure with the list of supported protocol type default string default protocol used (http) 0.8 secured string secured protocol used (https) If secured protocol is not available, the secured member name is not added to the response 0.8

11 Joomeo API XML-RPC: Reference guide 0.8 Page 11 / joomeo.user Provides methods that manage main functionalities for a user such as adding albums, files, contacts,... getting albums list, contacts list, Methods list Method name Description joomeo.user.addalbum Method used to add a new album in the user Joomeo space. joomeo.user.addcollection Deprecated method, use joomeo.user.addalbum instead. joomeo.user.addcontact Method used to add a new contact in the user Joomeo space. joomeo.user.addfolder Method used to add a new folder in the user Joomeo space. joomeo.user.getalbumlist Method used to get the albums list of the user Joomeo space. joomeo.user.getallowedfiletype Method used to get the allowed file type to upload in the user Joomeo space. joomeo.user.getcollectionlist Deprecated method, use joomeo.user.getalbumlist instead. joomeo.user.getcontactlist Method used to get the list of the contacts in the user Joomeo space. joomeo.user.getextensionjoomeofiletype Method used to get allowed files extensions to be uploaded in a Joomeo space. joomeo.user.getfileslist Method used to get the list of files in the user Joomeo space. joomeo.user.getfolderchildren Method used to get the list of folders and albums of the specified sessionid for specified folder identifiant. joomeo.user.gethublist Deprecated method, use joomeo.user.getnetwork instead. joomeo.user.getnetwork Method used to get the list of Joomeo space from your Joomeo network. joomeo.user. getnumberoffiles Method to get the number of files for the current Joomeo space. joomeo.user.getproperties Method to get some properties of the Joomeo space associated to the user session. joomeo.user.getstatistics Method to get statistics about the Joomeo space associated to the user session. joomeo.user.uploadbinary Method used to upload the binary file to save in an album with the method saveuploadedfile. API

12 Joomeo API XML-RPC: Reference guide 0.8 Page 12 / Methods definition joomeo.user.addalbum Method used to add a new album in the user Joomeo Space. This method is allowed with a sessiontype equals to 0. Request: A structure with the properties of the album to add apikey (Required) string Your application API key 0.5 sessionid (Required) string Session Id 0.5 label (Required) string Name of the album 0.5 previewsize int Maximum size of the slideshow and the previews (1920 by default, 1280 or 720) 0.5 albumdate double Date of the album (date of the day by default) (unix timestamp) public int 1 to add an album accessible by all the Joomeo space's contacts, or 0 to add a private album (0 by default) gmt int signed int allowing to know the timezone you want to apply to the album date allowdownload int 0 to not allow contacts to download original files from this album, 1 to allow contacts to download original files. By default the user preferences are used to set this value. allowupload int 0 current user is not allowed to upload new photos into this album, or 1 current user is allowed to upload. By default the user preferences are used to set this value. allowprintorder int 0 to not allow contacts to order photo print from this album, 1 to allow contacts to order photo print. By default the user preferences are used to set this value. allowsendcomments int 0 current user is not allowed to send comments to files into this album, or 1 current user is allowed to send comments. By default the user preferences are used to set this value. watermark int 0 to not add watermark to the previews of this album, 1 to add watermark to the previews of this album folderid string null to add the album to the root, or a valid folderid to add the album into this folder Response: A structure with the properties of the album added albumid string Identifiant of the album 0.5 label string Name of the album 0.5 orderby string default order to display the album s photos ("date" (original file date), "name", "date_created" (uploaded date) or "manual" - (date by default)) 0.5 previewsize int Maximum size of the slideshow and the previews (1920 by default, 1280 or 720) 0.5 albumdate double date of the album (unix timestamp) 0.5

13 Joomeo API XML-RPC: Reference guide 0.8 Page 13 / 87 createddate double created date of the album (unix timestamp) 0.5 public int 1 to add an album accessible by all the Joomeo space's contacts, 0 to add a private album (0 by default) 0.5 gmt int signed int allowing to know the timezone you want to apply to the album date 0.7 allowdownload int 0 current user is not allowed to download original photos from this album, 1 current user is allowed to download 0.5 original photos allowupload int 0 current user is not allowed to upload new files into this album or current user is allowed to upload allowprintorder int 0 to not allow contacts to order photo print from this album or 1 to allow contacts to order photo print allowsendcomments int 0 current user is not allowed to send comments to files into this album, or 1 current user is allowed to send comments. watermark int 0 if there are no watermarks to the previews of this album, if there are watermarks to the previews of this album folderid string parent folder id 0.7 joomeo.user.addcollection Deprecated method, use joomeo.user.addalbum instead. joomeo.user.addcontact Method used to add a new contact in the Joomeo Space. This method is allowed with a sessiontype equals to 0. Request: A structure with the properties of the album to add apikey (Required) string Your application API key 0.5 sessionid (Required) string Session Id 0.5 type int 0 to add classic contact (by default) to add advanced contact 2 to add anonymous contact (firstname, lastname, and phonenumber are not used) string A valid address (can t be used by another contact) 0.5 phonenumber string The phone number of the contact (can t be used by 0.8 another contact) firstname string The firstname of the contact to add 0.5 lastname string The lastname of the contact to add 0.5 login string The username used to connect to the Joomeo space 0.5 password string The password used to connect to the Joomeo space 0.5 usepreferences int 0 to not used preferences of this contact (by default)(user 0.8 preferences will be used in this case) 1 to use preferences of this contact The arguments :

14 Joomeo API XML-RPC: Reference guide 0.8 Page 14 / 87 - firstname, lastname, login and password are required if one of them are passed - if is passed, phonenumber is not required - if phonenumber is passed, is not required - if type = 2, just login and password are required Response: The structure properties of the contact added exist int 1 if contact already exist, 0 if not 0.5 contactid string The crypted uniq ID of the contact 0.5 type int 0 to add classic contact to add advanced contact 2 to add anonymous contact login string The username used to connect to the Joomeo space 0.5 password string The password used to connect to the Joomeo space 0.5 string The of the contact 0.5 phonenumber string The phone number of the contact 0.8 firstname string The firstname of the contact 0.5 lastname string The lastname of the contact 0.5 usepreferences int 0 to not used preferences of this contact 1 to use preferences of this contact 0.8 joomeo.user.addfolder Method used to add a new folder in the user Joomeo Space. This method is allowed with a sessiontype equals to 0. Request: A structure with the properties of the folder to add apikey (Required) string Your application API key 0.7 sessionid (Required) string Session Id 0.7 label (Required) string Name of the album 0.7 parentfolderid string null to add the album to the root, or a valid parent folderid to add the album into this folder 0.7 Response: The structure properties of the folder added folderid string Identifiant of the folder 0.7 label string Name of the album 0.7 position int Position from 0 where the folder has been added into the current tree. 0.7 parentfolderid string parent folder id 0.7 joomeo.user.getalbumlist Method used to get the albums list of the Joomeo Space.

15 Joomeo API XML-RPC: Reference guide 0.8 Page 15 / 87 Request: A structure with the apikey and the sessionid apikey (Required) string Your application API key 0.5 sessionid (Required) string Session Id 0.5 orderby string date or name - (user preference by default) 0.5 Response: An array of structures with the properties of each album of the Joomeo space albumid string Identifiant of the album 0.5 label string label of the album (not in structure if null) 0.5 orderby string sort by criteria (not in structure if null) 0.5 date double date of creation by the user 0.5 createddate double date of creation in the database 0.5 lastvisitdate double last visit date by the user of the sessionid 0.8 lastfileaddeddate double last added file in this album 0.8 public int 0 (private) - 1 (public) 0.5 allowdownload int 0 (No) - 1 (Yes) 0.5 allowupload int 0 (No) - 1 (Yes) 0.5 folderid string Identifiant of the folder (not in structure if null) 0.5 joomeo.user.getallowedfiletype Method used to get the allowed file type to upload in the Joomeo space of the current user. Request: A structure with the apikey and the sessionid. apikey (Required) string Your application API key 0.5 sessionid (Required) string Session ID 0.5 Response: The list of the files types allowed to be uploaded in the current Joomeo space (their extensions with an array of associated mime type). extension string Extension name (.jpg,.png, ) 0.5 typemimes array of structure The list of mime type allowed with the extension joomeo.user.getcollectionlist Deprecated method, use joomeo.user.getalbumlist instead. joomeo.user.getcontactlist Method used to get the list of the contacts. This method is allowed with a sessiontype equals to 0. Request: A structure with the apikey and the sessionid

16 Joomeo API XML-RPC: Reference guide 0.8 Page 16 / 87 apikey (Required) string Your application API key 0.5 sessionid (Required) string Session Id 0.5 orderby string lastvisit, lastname (default), firstname, ou login 0.8 Response: An array of structure properties of each contacts of the Joomeo space contactid string Identifiant of the contact 0.5 type int 0 to add classic contact to add advanced contact 2 to add anonymous contact login string Login of the contact 0.5 password string contact password to connect him to the Joomeo space associated to the current user session 0.5 string 0.5 phonenumber string The phone number of the contact 0.8 firstname string FirstName 0.5 lastname string LastName 0.5 lastvisit double Date when the contact has been connected for the last time 0.5 usepreferences int 0 to not used preferences of this contact 1 to use preferences of this contact 0.8 joomeo.user.getextensionjoomeofiletype Method used to get allowed files extensions to be uploaded in a Joomeo space. Request: A structure with the apikey and the sessionid. apikey (Required) string Your application API key 0.5 sessionid (Required) string Session ID 0.5 Response: The list of the files extensions allowed to be uploaded in a Joomeo space (their extensions with an joomeo file type linked). extension string Extension name (.jpg,.png, ) 0.5 joomeo_type string The joomeo file type (image, video, raw or file) joomeo.user.getfileslist Method used to get the list of files in the user Joomeo space. Request: A structure with the properties needed to get the right files list.

17 Joomeo API XML-RPC: Reference guide 0.8 Page 17 / 87 apikey (Required) string Your application API key 0.1 sessionid (Required) string Session Id 0.1 orderby string "date" or "name" - (date by default) 0.1 random int Generate a Random result sort order : 0 (No) - 1 (Yes) - (0 by default) 0.1 startresult int Start index to get files list (used if maxresult >0) (0 bydefault) 0.1 maxresult int Number of files to return : 0 or N - (0 - unlimited by default) 0.1 sorttype string ascending or descending 0.8 Response: An array of structures with the properties of each files of the Joomeo space fileid string Identifiant of the file 0.1 filename string Name of the file (not in structure if null) 0.1 rotation int rotation in degree 0.1 rating int rate of the picture 0.1 joomeo_type string type use by joomeo to categorize the file: - image: jpeg, tiff, png or gif file - video: one of the video types allowed by Joomeo - raw: one of the photo raw types allowed by Joomeo (dng, nef,...) - file: pdf, psd, eps or ai 0.7 preview string available if the picture previews exist unavailable if there is no picture previews 0.7 video_preview string available if the video previews exist unavailable if there is no video previews 0.7 type_mime string Mime type of the file (not in structure if null) 0.1 size int size in bytes 0.1 width int width of the original file 0.1 height int height of the original file 0.1 date_shooting double shooting date of the picture 0.1 date_creation double adding date of the file into Joomeo 0.1 allowdownload int to know if user is allowed to download the original file: 0 (No) - 1 (Yes) 0.1 legend string caption of the photo (not in structure if null) 0.1 collectionid string Parent Album Id (this member is deprecated, Use albumid instead) 0.1 albumid string Parent album ID 0.5 joomeo.user.getfolderchildren Method used to get the list of folders and albums of the specified sessionid for specified folder identifiant. Request: A structure with the apikey and the sessionid apikey (Required) string Your application API key 0.6 sessionid (Required) string Session Id 0.6 folderid string parent folderid or empty for root 0.6 orderby string date or name - (user preference by default) 0.6

18 Joomeo API XML-RPC: Reference guide 0.8 Page 18 / 87 Response: An array with two types of structure: album structure or folder structure with their properties Folder structure : type string folder 0.6 folderid string Identifiant of the folder 0.6 label string label of the album (not in structure if null) 0.6 orderby string sort by criteria (not in structure if null) 0.6 modificationdate double date of creation by the user 0.6 createddate double date of creation in the database 0.6 parentid string Identifiant of the folder (not in structure if null) 0.6 Album structure : type string album 0.6 albumid string Identifiant of the album 0.6 label string label of the album (not in structure if null) 0.6 orderby string sort by criteria (not in structure if null) 0.6 date double date of creation by the user 0.6 createddate double date of creation in the database 0.6 lastvisitdate double last visit date by the user of the sessionid 0.8 lastfileaddeddate double last added file in this album 0.8 public int 0 (private) - 1 (public) 0.6 allowdownload int 0 (No) - 1 (Yes) 0.6 allowupload int 0 (No) - 1 (Yes) 0.6 parentid string Identifiant of the folder (not in structure if null) 0.6 joomeo.user.gethublist Deprecated method, use joomeo.user.getnetwork instead. joomeo.user.getnetwork Method used to get the list of Joomeo space from your Joomeo network. This method is allowed with a sessiontype equals to 0. Request: A structure with the apikey and the sessionid apikey (Required) string Your application API key 0.7 sessionid (Required) string Session Id 0.7 Response: An array of structure properties of each Joomeo space present into your Joomeo network spaceid string Identifiant of the Joomeo space 0.8 contactid string Identifiant of the contact 0.7 username string Login of the contact 0.7 string 0.7 firstname string FirstName 0.7

19 Joomeo API XML-RPC: Reference guide 0.8 Page 19 / 87 lastname string LastName 0.7 lastvisit double Date when the contact has been connected for the last 0.7 time joomeo.user.getnumberoffiles Method to get the number of files for the current Joomeo space. Request: A structure with the apikey and the sessionid apikey (Required) string Your application API key 0.4 sessionid (Required) string Session Id 0.4 Response: A structure with the nbfiles member nbfiles int Number of files in the Joomeo space 0.4 joomeo.user.getproperties Method to get some properties of the Joomeo space associated to the user session. Request: A structure with the apikey and the sessionid apikey (Required) string Your application API key 0.7 sessionid (Required) string Session Id 0.7 Response: An array of structure properties of each Joomeo space present into your Joomeo network spacename string Joomeo space name 0.7 string User address 0.7 firstname string User firstname 0.7 lastname string User lastname 0.7 country string Country code (ISO alpha-2) 0.7 lang string User language (ISO 639-1) 0.7 video_streaming int 0 not allowed to watch video 1 allowed to watch video 0.7 joomeo.user.getstatistics Method to get statistics about the Joomeo space associated to the user session. Request: A structure with the apikey and the sessionid

20 Joomeo API XML-RPC: Reference guide 0.8 Page 20 / 87 apikey (Required) string Your application API key 0.5 sessionid (Required) string Session Id 0.5 Response: An array of structure properties of each Joomeo space present into your Joomeo network numberoffiles int Number of files in the Joomeo space 0.5 numberofalbums int Number of albums in the Joomeo space 0.5 numberofcontacts int Number of contacts in the Joomeo space (this member is present only with a sessiontype = 0) 0.5 totalusedspace double total size of the stored files (in byte) 0.5 freespace double free space to upload new files (in byte) 0.5 spaceallowed double space allowed per month or total space for enterprise offers 0.5 joomeo.user.uploadbinary Method used to upload the binary file to save in an album with the method saveuploadedfile. To get best performances, we encourage you to use the upload.php script discribes bellow instead of this method. Request: A structure with file properties to upload apikey (Required) string Your application API key 0.4 sessionid (Required) string Session Id 0.4 data (Required) base64 The binary data in base64 corresponding to the binary serialized file 0.4 filename (Required) string The name of the binary file with the extension 0.4 size (Required) binary The size of the binary data (in byte) 0.4 Response: An array of structure properties of each Joomeo space present into your Joomeo network uploadid string Temporary identifiant of the uploaded file. You must use this identifiant to save the file into an album just after the upload successed Associated scripts upload.php Script PHP used to upload a file. Request: A string of parameters with the apikey and the sessionid Parameters name Type Description API

21 Joomeo API XML-RPC: Reference guide 0.8 Page 21 / 87 apikey (Required) string Your application API key 0.4 sessionid (Required) string Session ID 0.4 Posted data upload.php must receive a request POST with the following parameters : - an element Content-Type with multipart/form-data - an element Content-Disposition with the attribut name defined on "Filedata" and an attribut name defined on the original file name - the binary data of the file to upload Returns: An upload id used in the method saveuploadedfile URL access Request format 5d905a4e45707 Posted data example Content-Type: multipart/form-data; boundary=aab03x --AaB03x Content-Disposition: form-data; name="filedata"; filename ="example.jpg" Content-Type: application/octet stream... binary data of example.jpg... --AaB03x-- Response format Success : <uploadid> _419</uploadid> Error : <error>200</error>

22 Joomeo API XML-RPC: Reference guide 0.8 Page 22 / joomeo.user.album Provides methods that manage functionalities for albums such as deleting, updating or managing album files Methods list Method name Description API joomeo.user.album.allowcontactaccess Method used to allow a contact to access to a 0.5 given album. joomeo.user.album.delete Method used to delete an album from the Joomeo 0.5 space of the current user session. joomeo.user.album.deletefile Method used to delete a file from a given album. 0.5 joomeo.user.album.getallowedcontactaccesslist Method used to get the contact list who are 0.5 allowed to access to a given album. joomeo.user.album.getfileslist Method used to get the list of files in the choosen 0.1 album of the Joomeo space. joomeo.user.album.getnumberoffiles Method to get the number of files contained in 0.5 given album. joomeo.user.album.removecontactaccess Method used to remove the contact access to a 0.5 given album. joomeo.user.album.saveuploadedfile Method used to save an uploaded file in an 0.4 album. joomeo.user.album.update Method used to update a given album Methods definition joomeo.user.album.allowcontactaccess Method used to allow a contact to access to a given album. This method is allowed with a sessiontype equals to 0. Request: A structure with the properties needed to allowed contact to access the album. apikey (Required) string Your application API key 0.5 sessionid (Required) string Session ID 0.5 albumid (Required) string Album ID 0.5 contactid (Required) string Contact id to be allowed to access to the album 0.5 allowdownload int 0 do not allow contact to download original file from the album 1 - allow contact to download original file from the album 0.5 allowupload int 0 do not allow contact to upload new files into the album 1 - allow contact to upload new files into the album 0.5 allowprintorder int 0 do not allow contact to order print from the album 1 - allow contact to order print from the album 0.8 allowsendcomments int 0 do not allow contact to send comment on the file of the album allow contact to send comment on the file of the album

23 Joomeo API XML-RPC: Reference guide 0.8 Page 23 / 87 Response: A structures with success member. success int 1 contact has been allowed to access to the album with success 0.5 joomeo.user.album.delete Method used to delete an album from the Joomeo space of the current user session. This method is allowed with a sessiontype equals to 0. Request: A structure with the properties needed to allowed contact to access the album. apikey (Required) string Your application API key 0.5 sessionid (Required) string Session ID 0.5 albumid (Required) string Album ID 0.5 Response: A structures with success member. success int 1 - album deleted with success 0.5 joomeo.user.album.deletefile Method used to delete a file from a given album. This method is allowed with a sessiontype equals to 0. Request: A structure with the properties needed to delete the file from the album. apikey (Required) string Your application API key 0.5 sessionid (Required) string Session ID 0.5 albumid (Required) string Album ID 0.5 fileid (Required) string File ID to remove from the album 0.5 Response: A structures with success member. success int 1 - file deleted with success 0.5 joomeo.user.album.getallowedcontactaccesslist Method used to get the contact list who are allowed to access to a given album. This method is allowed with a sessiontype equals to 0.

24 Joomeo API XML-RPC: Reference guide 0.8 Page 24 / 87 Request: A structure with the properties needed to get the right contact list. apikey (Required) string Your application API key 0.5 sessionid (Required) string Session ID 0.5 albumid (Required) string Album ID 0.5 Response: An array of structure with the properties of the allowed contact for a given albumid. contactid string Identifiant of the contact 0.5 allowdownload int 0 do not allow contact to download original file from the album allow contact to download original file from the album allowupload int 0 do not allow contact to upload new fikles into the album 1 - allow contact to upload new fikles into the album 0.5 allowprintorder int 0 do not allow contact to order print from the album 1 - allow contact to order print from the album 0.8 allowsendcomments int 0 do not allow contact to send comment on the file of the album allow contact to send comment on the file of the album joomeo.user.album.getfileslist Method used to get the list of files in the choosen album of the Joomeo space. Request: A structure with the properties needed to get the right files list. apikey (Required) string Your application API key 0.1 sessionid (Required) string Session Id 0.1 albumid (Required) string Album ID from which get the files list. orderby string "date" (original file date), "name", "date_created" (uploaded date) or "manual" - (date by default) 0.1 random int Generate a Random result sort order : 0 (No) - 1 (Yes) - (0 by default) 0.1 startresult int Start index to get files list (used if maxresult >0) (0 bydefault) 0.1 maxresult int Number of files to return : 0 or N - (0 - unlimited by default) 0.1 Response: An array of structures with the properties of each files of the Joomeo space fileid string Identifiant of the file 0.1 filename string Name of the file (not in structure if null) 0.1 rotation int rotation in degree 0.1

25 Joomeo API XML-RPC: Reference guide 0.8 Page 25 / 87 rating int rate of the picture 0.1 joomeo_type string type use by joomeo to categorize the file: - image: jpeg, tiff, png or gif file - video: one of the video types allowed by Joomeo - raw: one of the photo raw types allowed by Joomeo (dng, nef,...) - file: pdf, psd, eps or ai 0.7 preview string available if the picture previews exist unavailable if there is no picture previews 0.7 video_preview string available if the video previews exist unavailable if there is no video previews 0.7 type_mime string Mime type of the file (not in structure if null) 0.1 size int size in bytes 0.1 width int width of the original file 0.1 height int height of the original file 0.1 date_shooting double shooting date of the picture 0.1 date_creation double adding date of the file into Joomeo 0.1 lastvisitdate double last visit date on the parent album by the user of the sessionid allowdownload int to know if user is allowed to download the original file: 0 (No) - 1 (Yes) 0.1 allowprintorder int to know if user is allowed to order print with the file: 0 (No) - 1 (Yes) 0.8 allowsendcomments int to know if user is allowed to add comment on the file: 0 (No) - 1 (Yes) 0.8 legend string caption of the photo (not in structure if null) 0.1 nbcomments int number of comments on this file 0.8 collectionid string Parent Album Id (this member is deprecated, Use albumid instead) 0.1 joomeo.user.album.getnumberoffiles Method to get the number of files contained in given album. Request: A structure with the album properties. apikey (Required) string Your application API key 0.5 sessionid (Required) string Session ID 0.5 albumid (Required) string Album ID 0.5 Response: A structure with nbfiles number. nbfiles int Number of files in the album 0.5 joomeo.user.album.removecontactaccess Method used to remove the contact access to a given album. This method is allowed with a sessiontype equals to 0. Request: A structure with the properties needed to delete the contact from the album.

26 Joomeo API XML-RPC: Reference guide 0.8 Page 26 / 87 apikey (Required) string Your application API key 0.5 sessionid (Required) string Session ID 0.5 albumid (Required) string Album ID 0.5 contactid (Required) string Contact ID to remove from the album 0.5 Response: A structures with success member. success int 1 - contact removed with success 0.5 joomeo.user.album.saveuploadedfile Method used to save an uploaded file in an album. Request: A structure with the properties needed to delete the contact from the album. apikey (Required) string Your application API key 0.4 sessionid (Required) string Session ID 0.4 albumid (Required) string Album ID 0.4 uploadid (Required) string Upload Id return by the method uploadbinary or by the PHP script upload.php 0.4 filename (Required) string name of the uploaded file (with extension) 0.4 legend string caption of the file 0.4 Response: A structures with the added file properties. fileid string Identifiant of the file 0.4 filename string Name of the file (not in structure if null) 0.5 rotation int rotation in degree 0.5 rating int rate of the picture 0.5 joomeo_type string type use by joomeo to categorize the file: - image: jpeg, tiff, png or gif file - video: one of the video types allowed by Joomeo - raw: one of the photo raw types allowed by Joomeo (dng, nef,...) - file: pdf, psd, eps or ai 0.7 preview string available if the picture previews exist unavailable if there is no picture previews 0.7 video_preview string available if the video previews exist unavailable if there is no video previews 0.7 type_mime string Mime type of the file (not in structure if null) 0.5 size int size in bytes 0.5 width int width of the original file 0.5 height int height of the original file 0.5 date_shooting double shooting date of the picture 0.5

27 Joomeo API XML-RPC: Reference guide 0.8 Page 27 / 87 date_creation double adding date of the file into Joomeo 0.5 allowdownload int to know if user is allowed to download the original file: 0 (No) - 1 (Yes) 0.5 legend string caption of the file 0.5 albumid string Parent album ID 0.5 joomeo.user.album.update Method used to update a given album. This method is allowed with a sessiontype equals to 0. Request: A structure with the properties needed to update the album. apikey (Required) string Your application API key 0.5 sessionid (Required) string Session ID 0.5 albumid (Required) string Album ID 0.5 label (Required) string Name of the album 0.5 previewsize int Maximum size of the previews available (1920 by default) 0.5 albumdate double Date of the album (date of the day by default) (unixtimestamp) 0.5 public int 0 - to set as private album (just the allowed contacts can access this album) 1 - to set this album accessible by all the Joomeo space's 0.5 contacts Response: A structures with success member. success int 1 - album updated with success 0.5

28 Joomeo API XML-RPC: Reference guide 0.8 Page 28 / joomeo.user.collection (deprecated) Provides methods that manage functionalities for collections such as getting files information from an album. All the methods of this package are deprecated Methods list Method name joomeo.user.collection.getfileslist joomeo.user.collection.getnumberoffiles joomeo.user.collection.saveuploadedfile Description Deprecated method, use joomeo.user.album.getfileslist instead. Deprecated method, use joomeo.user.album.getnumberoffiles instead. Deprecated method, use joomeo.user.album.saveuploadedfile instead. API Methods definition joomeo.user.collection.getfileslist Deprecated method, use joomeo.user.album.getfileslist instead. joomeo.user.collection.getnumberoffiles Deprecated method, use joomeo.user.album.getnumberoffiles instead. joomeo.user.collection.saveuploadedfile Deprecated method, use joomeo.user.album.saveuploadedfile instead.

29 Joomeo API XML-RPC: Reference guide 0.8 Page 29 / joomeo.user.comment Provides methods that manage functionalities for contacts such as deleting, updating or sending messages Methods list Method name Description API joomeo.user.comment.delete Method used to delete a given comment Methods definition joomeo.user.comment.delete Method used to delete a given comment. This method is allowed with a sessiontype equals to 0. Request: A structure with the properties needed to delete comment. apikey (Required) string Your application API key 0.8 sessionid (Required) string Session ID 0.8 commentid (Required) string Comment ID to remove from the Joomeo space 0.8 Response: A structures with success member. success int 1 - comment deleted with success 0.8

30 Joomeo API XML-RPC: Reference guide 0.8 Page 30 / joomeo.user.contact Provides methods that manage functionalities for contacts such as deleting, updating or sending messages Methods list Method name Description API joomeo.user.contact.delete Method used to delete a given contact. 0.5 joomeo.user.contact.sendinvite Method used to send an to the contact. 0.5 joomeo.user.contact.update Method used to update the contact properties. 0.5 joomeo.user.contact.updatepermissions Method used to update permissions to an 0.8 advanced contact joomeo.user.contact.updatepreferences Method used to update preferences to the contact Methods definition joomeo.user.contact.delete Method used to delete a given contact. This method is allowed with a sessiontype equals to 0. Request: A structure with the properties needed to delete contact. apikey (Required) string Your application API key 0.5 sessionid (Required) string Session ID 0.5 contactid (Required) string Contact ID to remove from the Joomeo space 0.5 Response: A structures with success member. success int 1 - album deleted with success 0.5 joomeo.user.contact.sendinvite Method used to send an to the contact. This is automaticaly filled with the access information to the Joomeo space associated to the user session. This method is allowed with a sessiontype equals to 0. Request: A structure with the properties needed to send the to the contact. apikey (Required) string Your application API key 0.5 sessionid (Required) string Session ID 0.5 contactid (Required) string Contact id (get with joomeo.user.getcontactlist method) 0.5 subject string Your personnal subject for the 0.5 message string Your personnal message attached to the 0.5 lang string The language used to write the (one of the allowed 0.5

31 Joomeo API XML-RPC: Reference guide 0.8 Page 31 / 87 language on Joomeo website). If no data the user preference will be used. sendcopy int 0 - do not send a copy to the space manager (by default) 1 - send a copy of this to the manager 0.5 Response: A structures with success member. success int 1 - contact deleted with success 0.5 joomeo.user.contact.update Method used to update the contact properties. Request: A structure with the properties of the contact to update apikey (Required) string Your application API key 0.5 sessionid (Required) string Session Id 0.5 contactid (Required) String Contact ID 0.5 type int 0 to add classic contact (by default) to add advanced contact 2 to add anonymous contact (firstname, lastname, and phonenumber are not used) string A valid address 0.5 phonenumber string The phone number of the contact (can t be used by 0.8 another contact) firstname string The firstname of the contact to update 0.5 lastname string The lastname of the contact to update 0.5 login string The username used to connect to the Joomeo space 0.5 password string The password used to connect to the Joomeo space 0.5 userpreferences int 0 to not used preferences of this contact (by default)(user 0.8 preferences will be used in this case) 1 to use preferences of this contact The arguments : - login and password are required if one of them are passed - if type = 2, just login and password are required Response: A structures with success member. success int 1 - contact updated with success 0.5 joomeo.user.contact.updatepermissions Method used to update permissions to an advanced contact. Request: A structure with the properties and permissions of the contact to update apikey (Required) string Your application API key 0.8

32 Joomeo API XML-RPC: Reference guide 0.8 Page 32 / 87 sessionid (Required) string Session Id 0.8 contactid (Required) String Contact ID 0.8 allowalbumcreate int 0 to not allow contact to add new album to allow contact to add new album allowalbumupdate int 0 to not allow contact to update an album that he has 0.8 added 1 to allow contact to update an album that he has added allowalbumdelete int 0 to not allow contact to delete an album that he has 0.8 added 1 to allow contact to delete an album that he has added allowalbumalert int 0 to not allow contact to alert the others contacts of an 0.8 update 1 to allow contact to alert the others contacts of an update allowfiledelete int 0 to not allow contact to delete files that he has added to allow contact to delete files that he has added allowfileeditcaption int 0 to not allow contact to edit files caption that he has 0.8 added 1 to allow contact to edit files caption that he has added The arguments : - allowalbumupdate and allowalbumdelete has no effect if allowalbumcreate is not to 1 - these permissions are only valid if the contact has the right to import files in the current album Response: A structures with success member. success int 1 - contact permissions updated with success 0.8 joomeo.user.contact.updatepreferences Method used to update preferences of a contact. Request: A structure with the properties and preferences of the contact to update apikey (Required) string Your application API key 0.8 sessionid (Required) string Session Id 0.8 contactid (Required) String Contact ID 0.8 guestmode int 0 use the classic presentation for this contacts use the administrator presentation for this contacts guestmodetree int 0 do not show folders for this contacts show folders for this contacts guestmodeexpand int 0 do not open media library tree structure open media library tree structure allowdownload int 0 by default, do not allow this contact to order photo prints by default, allow this contact to download the original files allowupload int 0 by default, do not allow this contact to order photo prints by default, allow this contact to import files allowprintorder int 0 by default, do not allow this contact to order photo prints by default, allow this contact to order photo prints allowsendcomments 0 by default, do not allow this contact to send comments 1 by default, allow this contact to send comments 0.8