Home

HipServ Web Services API v0.1

1. l There cannot be two contacts with the same email address in the 400 10 Duplicate email contact list of a Hip Serv user 401 Unauthorized The current visitor is not an authenticated Hip Serv user The contact list to which the contact is added is not the one of the 404 Not Found ae current visitor Edit a contact Edits a contact Changing its email address changes its URI Request HIPSERV_URL CONTACT_URI http johndoe my hip serv com ap i 2 0 rest contacts johndoe jenny 40examp le com URE URL Example MIME Type hip serv contact xml without href attribute The email and or DisplayName attribute must not be empty CONTACT_URI is the URI of a contact they are available in the href attributes of the Get all the contacts of a user Web Service Success Response HTTP Status Code 200 OK MIME Type hip serv contact xml Details the response status code might be 201 although it should be 200 Failure Responses The email address must match the following Perl regular expression ignore line breaks SONN AOAN OH 2 0 4 d 5 0 5 1 2 d 1 2 2 0 4 d 5 0 5 1 d 1 2 31 a zA Z 0 9 a zA Z 2 400 6 Invalid Email Edit contact User already 400 49 owns a contact with that e mail address 401 Unauthorized The current visitor is not an authenticated Hip Serv user The current visitor is not the authenticated Hip Serv user whose 404 Not Found P
2. Failure Responses album name must not start with a dot album name must not match the Perl Regular Expression lt gt amp 400 1 Illegal Filename MANASA i e must not contain any of the following characters lt gt amp 400 2 File Already Exists The HipServ user already owns an album with the same name f When creating editing an album with contacts the contacts must 400 11 Contact does not exist 4 8 already exist The current visitor is not an the authenticated Hip Serv user who 401 Unauthorized Ea P owns the requested album listing Update an Album Updates the properties of a specified album Note when sharing with friends contacts must already exist Note renaming an album changes its URI and the URI of its assets Request HIPSERV_ URL ALBUM URI http johndoe my hip serv com ap 1 2 0 rest albums users am9obmRvZS9IT YW 1 wbGU gQWxidW0 MIME Type hip serv albumRequest xml ALBUM_URI is the URI of a HipServ album which can be obtained via the album listing or gallery Web Service Success Response HTTP Status Code 200 OK Type hip SONS LTE ents xml without children mediafilter folderfilder nbFilteredAssets Failure Responses album name must not start with a dot album name must not match the Perl Regular Expression lt gt amp 400 1 Illegal Filename VAN AS ON i e must not contain any of the following characters lt gt amp 400 2 File
3. lt share with public gt lt share with contacts until 2010 10 22 withPassword true gt lt contact email jenny example com href api 2 0 rest contacts johndoe jenny 40example com DisplayName Jenny Doe gt lt contact email junior example com href api 2 0 rest contacts johndoe junior 40example com DisplayName Junior Doe gt lt share gt lt share with family gt lt sharing gt lt externalServices gt lt service name facebook gt lt service name flickr gt lt externalServices gt lt file name 06 Dissolved Girl mp3 type audio href api 2 0 rest albums users am9o0bmRvZS 9TYWlwbGUgQWxidWOVvMDYgLSBEaXNzb2x2ZWOQgR21ybC5tcDM mimeType audio mpeg size 5873792 mtime 1285158715 gt lt file name Paris avi type video href api 2 0 rest albums users am9obmRVZS 9TYW1wbGUgQWxidW0VvUGFyaXMuYXZp mimeType video x msvideo size 16540732 mtime 1285158726 gt lt tags gt lt tag gt paris lt tag gt lt tags gt lt file gt lt file name paris0l jpg type image href api 2 0 rest albums users am9obmRvZS 9TYW1wbGUgQWxidW0vcGFyaXMwMS5qcGc mimeType image jpeg caption Paris 2010 size 415297 mtime 1285158722 gt lt tags gt lt tag gt notre dame lt tag gt lt tag gt paris lt tag gt lt tags gt lt file gt lt file name USER GUIDE pdf type document href api 2 0 rest albums users am9obmRVvZS 9TYW1wbGUgQWxidWOVVVNFUilHVULERS5wZGY mimeType applica
4. Already Exists The Hip Serv user already owns another album with the same name When creating editing an album with contacts the contacts must 400 11 Contact does not exist s z already exist The current visitor is not an the authenticated HipServ user who 401 Unauthorized i owns the requested album Rename an Album alternate Web Service Renames an album This is an alternate Web Service to perform a rename action only Note renaming an album changs its URI and the URI of its assets Request HIPSERV URL ALBUM _URI name http johndoe my hip serv com ap 1 2 0 rest albums users am9obmRvZS9IT YW 1 wbGU gQ Wxid W0 name lt xml version 1 0 gt lt file name NAME gt ALBUM_URI is the URI of a Hip Serv album which can be obtained via the album listing or gallery Web Service NAME is the new album name Success Response HTTP Status Code 200 OK hip serv albumContents xml without children mediafilter folderfilder MIME T ype nbFilteredAssets Failure Responses album name must not start with a dot album name must not match the Perl Regular Expression lt gt amp DN A S 0 2 Illegal Filename i e must not contain any of the following characters lt gt amp 400 2 File Already Exists The Hip Serv user already owns another album with the same name k The current visitor is not an the authenticated Hip Serv user who 401 Unauthorized owns the requested album S
5. HTTP Status Code 200 OK MIME Type hipserv light Directory Assets xml Failure Responses The current visitor is not an authenticated Hip Serv user who has 401 Unauthorized access to the directory Get Directory Details Returns details about a folder without its children Request Method GET URL HIPSERV_URL DIRECTORY_URI details URL Example http johndoe my hipserv com ap i 2 0 rest files ZmF taWx5LINhbXBsZ XM details DIRECTORY URI is the URI of a Hip Serv directory i e the href of any file of Details i i type folder or the href of a media source see Hip Serv User Information Success Response HTTP Status Code 200 OK Type hip serv directory Contents xml without children elements mediafilter folderfilder yP nbFilteredAssets or assetsOffset Failure Responses f The current visitor is not an authenticated Hip Serv user who has 401 Unauthorized access to the directory Get Directory Last Modified Date Time Returns the last modified date time of a directory Request HIPSERV_URL DIRECTORY_URI mtime URL Example http johndoe my hip serv com ap i 2 0 rest files ZmF taWx5LINhbXBsZ XM mtime DIRECTORY URI is the URI of a Hip Serv directory i e the href of any file of type folder or the href of a media source see Hip Serv User Information Success Response HTTP Status Code 200 OK Bod lt xml version 1 0 gt ony lt file href DIRECTORY URI mtime MTIME gt Detai
6. USER URI od Example http johndoe my hip serv com ap i 2 0 rest accounts users johndoe Details US ER_URI is the URI of the Hip Serv user received in the userURI attribute as a i result of a user login Success Response Failure Responses Get HipServ User Preferences Returns the preferences of a given HipServ user Only this authenticated Hip Serv user is allowed to call this service Request HIPSERV_URLIUSER URIipref od Example http johndoe my hip serv com ap i 2 0 rest accounts users johndoe prefs Detak US ER_URI is the URI of the Hip Serv user received in the userURI attribute as a result of a user login Success Response HTTP Status Code 200 OK MIME Type hip serv preferencest xml Failure Responses 400 4 Input Output Error 401 The current visitor is not an authenticated Hip Serv user s The current authenticated Hip Serv user is not the user whose 403 Forbidden ae L information is requested Change HipServ User Preferences Changes preferences of a given Hip Serv user Only this authenticated Hip Serv user is allowed to call this service HIPSERV_URLIUSER URIipref URL Example http johndoe my hip serv com ap i 2 0 rest accounts users johndoe prefs lt xml version 1 0 gt lt preferences gt Bod lt preference name NAME1 value VALUE1 gt ony lt preference name NAME2 value VALUE2 gt LES sou S gt lt preferences gt USER URI is the URI of the Hip Serv
7. a Single File 2 7 22 Delete Files 2 7 23 Copy Files m 2 7 24 Move Files m 2 8 Contacts Web Services 2 8 1 Get all the contacts of a user m 2 8 2 Get a Contact m 2 8 3 Create a contact m 2 8 4 Edit a contact m 2 8 5 Delete a Contact 2 9 Themes Web Services 2 9 1 Get All Themes m 2 9 2 Get a Theme 2 10 Albums Web Services 2 10 1 Get Listing of Albums owned by a user 2 10 2 Get Album Contents 2 10 3 Get Light Album Assets 2 10 4 Get Album Details 2 10 5 Get Album Asset Details Thumbnail Webview Source 2 10 6 Save Album Asset Playback Position Reset Saved Album Asset Playback Position 2 10 7 Create an Album 2 10 8 Update an Album 2 10 9 Rename an Album alternate Web Service 2 10 10 Send a Share Email to all Album Contacts 2 10 11 Add Assets to an Album 2 10 12 Update an Album Cover Asset 2 10 13 Delete Album or Remove an Asset from an Album 2 10 14 Remove Multiple Assets from an Album m 2 11 3rd Party Web Services m 2 11 1 Get Listing of Photosets owned by the current user on a 3rd party service m 2 11 2 Link an album to a 3rd party photoset m 2 11 3 Unlink an album from a 3rd party photoset 3 Non REST Web Services API 3 1 File Upload Services 3 1 1 Upload Files m 4 Appendix 4 1 HipServ XML MIME Types 4 1 1 hipserv session xml 4 1 2 hipserv serverconfig xml 4 1 3 hipserv user xml 4 1 4 hipserv mediaSources xml 4 1 5 hipserv preferencest xml 4 1 6 hipserv gallery xml 4 1 7 hipserv directory Contents xml 4 1 8 h
8. and its assets nip serv albumRequest xml Hip Serv album creation edition request hipserv 3rdParty PhotosetListing xml Hip Serv 3rd party photoset listing Session Web Services Here are the steps to follow to log in m Call the Get an AUTH Login Code and the URL to the HipServ Web Service using the fully qualified domain name of the Central Server the HipServ name username and password and get an AUTH login code and the URL to the HipServ Call the Create a new session for a HipServ user aka User login via the CS Web Service using the URL to the HipServ and the AUTH login code and get the user URI server config URI and locale along with the session cookie to authenticate further requests The typical Web Services to call next are m Get Server Configuration Get HipServ User Information Get an AUTH Login Code and the URL to the HipServ Returns the URL to a given Hip Serv and the AUTH login code to send to that Hip Serv to login as a given Hip Serv Request https CS FQDN_OR IP rest 1 0 sessions hip serv URL Example https Awww myhipserv com rest 1 0 sessions hip serv lt xml version 1 0 gt lt session hipserv HIPSERV username USERNAME password PASSWORD Ve The request must be made over HTTPS CS_FQDN_OR IP is the fully qualifying domain name or the IP address of the central server with which the Hip Serv is registered HIPS ERV is the HipServ name US ERNAME is the username of the Hip Serv u
9. attributes User is not authorized logged into the requested 3rd party service m service the requested 3rd party service m loginURL the 3rd party login access URL The user must be directed to the login URL and allow the Hip Serv app lication to access the 3rd party service Once it s done he can retry to call this Web Service 400 29 Service is disabled The requested 3rd party service is not enabled on the Hip Serv The current visitor is not an authenticated Hip Serv user Link an album to a 3rd party photoset Link an album to a flickr facebook photoset and upload all current photos to the 3rd party service Once linked images added to the album will be uploaded to the 3rd party service Request HIPSERV_URL ALBUM_URI 3rdparty SERVICE photoset http johndoe myhi 2 t al URL Example tp johndoe my hip serv com ap 1 2 0 rest albums users YWRtaW4vQWRtaW4gU2FtcGxlIEFs YnVt 3rdp arty photoset lt xml version 1 0 gt lt photoset name NAME caption CAPTION gt Body or lt xml version 1 0 gt lt photoset id ID gt ALBUM_URI is the URI of a HipServ album which can be obtained via the album listing or gallery Web Service SERVICE is the name of a supported 3rd party service Provide NAME and CAPTION optional to link to a new photoset Provide ID to link to an existing photoset Success Response HTTP Status Code 200 OK Failure Responses The user is not logged on the 3rd party servic
10. hip serv com ap i 2 0 rest files ZmF taWx5LINhbXBsZ XM lt xml version 1 0 gt lt file sharingWithDMA true false gt ue version 1 0 gt name NAME gt version 1 0 gt name NAME sharingWithDMA true false gt DIRECTORY_URI is the URI of the Hip Serv directory i e the href of any file of Success Response type folder or the href of a media source see HipServ User Information HITE Status Code NANG the new filename roe cae ee without children elements mediafilter folderfilder sels icha ne need to be part of the request and that Failure Responses directory name must not start with a dot directory name must not match the Perl Regular Expression 400 1 Illegal Filename lt gt EVNMWW ESV i e must not contain any of the following characters lt gt amp 400 2 Piece rice file with the requested name already exists in the requested directory 3 The current visitor is not an authenticated Hip Serv user who has 401 Unauthorized access to the directory Update Asset Name and or Caption Updates the name and or caption of an asset Note renaming an asset changes its URI Request HIPSERV_URL ASSET_ URI http johndoe my hip serv com ap 1 2 0 rest files ZmFtaWx5SL1NhbXBsZ XM veGFyaXM wM SSqceGe lt xml version 1 0 gt lt file caption CAPTION gt Que version 1 0 gt name NAME gt version 1 0 gt name NAME caption
11. in seconds since the epoch type the folder or file type folder image audio video document parentHref URI of the parent folder empty if the file is a media source matchedFields comma separated list of fields matching the searched key words Fields are tags caption name and for folders nbFolders the number of folders in the folder nbFiles the number of files in the folder sharingWithDMA true if the folder is shared with DMA inherited if the folder is shared with DMA because one of its ancestors is false otherwise optional default false deviceHref URI of the ejectable USB storage device where the folder resides optional readOnly truelfalse true for folders that cannot be deleted copied renamed or moved and where no file or folder can be created added cop ied moved so far only ExternalStorage op tional default false isCoreMount true false true for folders that are core mountpoints i e can only be ejected by admins so far My Library Family Library My Computers on plugs where those folders are on the eSATA drive optional default false and for assets if available mimeType Asset MIME type audio mpeg image jpeg etc caption caption size file size in bytes m tags tags element containing a tag element for each tag in a text node See below an example implementation of hipserv searchResultst xml MIME type oar version 1 0 gt lt searchResults keywor
12. l Li I l l l I l l K contacts gt l hipserv contact x ml A hipserv contact xml document describes a contact with its href email and Display Name Sample document contact href api 2 0 rest contacts johndoe jenny 40example com 1 email jenny example com DisplayName Jenny Doe gt hipserv themes x ml A hipserv themes xml document describes the list of themes available on the Hip Serv and follows the following temp late i e a list of themes with href id localized names and the background color style only I lt xml version 1 0 gt K lt themes gt lt theme rank 1 href api 2 0 rest themes hipserv travel id hipservTravel gt 1 lt names gt i lt name locale en_US value Travel gt lt name locale de DE value Reise gt 1 lt name locale es_ ES value Viaje gt lt name locale fr FR value Voyage gt 1 lt name locale it_IT value Viaggio gt i lt name locale n1_ _NL value Reizen gt 1 lt names gt i lt styles gt gt lt style property background color value 7eb3d2 gt 1 lt styles gt lt theme gt lt theme rank 2 href api 2 0 rest themes hipserv party id hipservParty gt l I l l l l l l Li l l l l l l I l l I I lt names gt lt name locale en_US value Party gt lt name locale de_DE value Party gt lt name locale es_ES value Fiesta gt lt name locale fr_ FR value
13. od Example http johndoe my hip serv com ap i 2 0 rest contacts johndoe CONTACTS_URI is available in the contactsURI attribute of the Get Hip Serv Details User Information Web Service Success Response Failure Responses Get a Contact Returns a given contact of a user who must be logged in Request HIPSERV_URL CONTACT_URI CONTACT_URI is the URI of a contact they are available in the href attributes of the Get all the contacts of a user Web Service URL Example http johndoe my hip serv com ap i 2 0 rest contacts johndoe jenny 40examp le com Success Response HTTP Status Code 200 OK MIME Type hip serv contact xml Failure Responses The current visitor is not an authenticated Hip Serv user 04 The current visitor is not the authenticated Hip Serv user whose 4 Not Found contact is requested Create a contact Adds a contact to the contact list of a Hip Serv user Request ALBUM_UIS TING_URI is available in the albumsURI attribute of the Get HipServ User Information Web Service Success Response HTTP Status Code 201 Created MIME Type hip serv contact xml Failure Responses Cannot parse XML Input Output Error The email address must match the following Perl regular expression ignore line breaks Invalid Email J SONN AOAN SONN AOH 2 0 4 d 5 0 5 1 d 1 2 2 0 4 d 5 0 5 1 Ad 1 23 33 a zA Z 0 9 a zA Z 2 1
14. party services The error element contains the following attributes m service the 3rd party service to log on to User is not authorized logged m loginURL the 3rd party service login access URL on one or more 3rd party userDisplayName optional display name to log on as on services to which the requested the 3rd party service can happen if the current user is album is linked logged on as another user than the one who linked the album to the 3rd party service The user must be directed to the login URL and allow the Hip Serv app lication to access the 3rd party service Once it s done he can retry to call this Web Service Alternatively the album can be unlinked from the 3rd party service s 3rd party photoset does not The 3rd party service photoset to which the album is linked does 400 21 exit not exist It should be unlinked Be current visitor is not the authenticated owner of the requested album Update an Album Cover Asset Updates the Cover Asset of an Album Request TE HIPSERV_URL ALBUM _URI cover http johndoe my hip serv com ap 1 2 0 rest albums users am9obmRvZS9IT YW 1 wbGU gQWxidW0 cover lt xml version 1 0 gt lt file Dref SVN SIE WISI Laie ALBUM_URI is the URI of a HipServ album which can be obtained via the album listing or gallery Web Service Details AS SET_URI is the URI of the album asset to use as a cover asset Success Response Failure Responses Delete Album or
15. tagList xml ASSET_URI is the URI of a Hip Serv asset i e the href of any file of type other Details than folder Success Response HTTP Status Code 201 Created MIME Type hipserv tagList xml containing all tags attached to the asset Failure Responses 400 5 Invalid Parameter The current visitor is not an authenticated Hip Serv user who has 401 Unauthorized access to the asset Update all Tags in an Asset Replaces the tags attached to an asset with new ones Request HIPSERV_URL ASSET_URI tags http johndoe my hip serv com ap 1 2 0 rest files ZmFtaWxSLINhbXBsZ XM vUGFyaXMuYXZp tags hip serv tagList xml AS SET_URT is the URI of a HipServ asset i e the href of any file of type other than folder Success Response Failure Responses Delete all the Tags of an Asset Deletes all the tags of an asset Request DELETE HIPSERV_URL ASSET_URI tags http johndoe my hip serv com ap 1 2 0 rest files ZmFtaWxSLINhbXBsZ XM vUGFyaXMuYXZp tags AS SET_URT is the URI of a Hip Serv asset i e the href of any file of type other than folder Success Response Failure Responses Delete a Single File Delete a singe file assets and or directories Request DELETE od Example http johndoe my hip serv com ap i 2 0 rest files ZmF taWx5LINhbXBsZ XM FILE_URI is the URI of the asset or directory to delete Success Response Failure Responses Delete Files Delete
16. user received in the userURI attribute as a result of a user login NAME is the name of the first preference and VALUEI is its value etc Success Response HTTP Status Code 200 OK MIME Type hipserv preferencest xml The response only includes the preferences listed in the request Failure Responses 401 The current visitor is not an authenticated Hip Serv user The current authenticated Hip Serv user is not the user whose 403 o Ee a i information is requested Get HipServ User Gallery Returns the information needed to display the gallery of a Hip Serv user i e the list of albums s he has access to Only this authenticated Hip Serv user is allowed to call this service Request GET HIPSERV_URL USER_URI gallery http johndoe my hipserv com ap i 2 0 rest accounts users johndoe gallery US ER_URI is the URI of the Hip Serv user received in the userURI attribute as a result of a user login Success Response HTTP Status Code 200 OK MIME Type hip serv gallery xml Failure Responses 401 Unauthorized The current visitor is not an authenticated Hip Serv user 403 Forbidden The current HipServ user is not the one whose gallery is requested Change HipServ User Password eta the password of a given Hip Serv user Only this authenticated Hip Serv user is allowed to call this service Request maa pr URL es HIPSERV_URL USER_URI password URL Example http johndoe my hip serv com
17. validationMessage Invalid editable True visible True sort sortOn handler user gt lt value name en_ US desc en_US gt lt value name fr_ FR desc fr_ FR gt lt value name es_ES desc es_ ES gt lt value name nl_ NL desc nl_NL gt lt value name de_ DE desc de_ DE gt lt value name it_IT desc it_IT gt lt preference gt lt preference name share_ from_email desc Sharing Emails Sender value john example com weight 2 type string category User categoryID User required False permission user default validation w w w w w 0 66 a z 2 6 a z 2 relatedRule reloadRequired False validationMessage invalidFormatEmailAddress editable True visible True sort _sortOn _handler user gt lt preferences gt lt user gt hipserv mediaS ources x ml The hipserv mediaS ources xml MIME type defines an XML data structure which describes the media sources available to a Hip Serv user The mediaS ources root element contains 0 or more mediaS ource elements containing the following attributes id media source id My Library M yComputers Family Library Ext ernalStorage name media source name filename on the Hip Serv href media source URI i e directory URTI backupHref media source backup URI only if either USB or Online backup is enabled See below an example implementation of the hi
18. CAPTION gt AS SET_URTis the URI of a Hip Serv asset i e the href of any file of type other than folder CAPTION is the new caption and NAME is the new filename Note that only the fields which change need to be part of the request Success Response HTTP Status Code 200 OK MIME Type hip serv assetDetails xml Failure Responses asset name must not start with a dot asset name must not match the Perl Regular Expression lt gt amp Illegal Filename AAAS i e must not contain any of the following characters lt gt amp 400 2 Pile Already Eats A i with the requested name already exists in the requested asse The current visitor is not an authenticated Hip Serv user who has 401 Unauthorized access to the asset Rename a Directory alternate Web Service Renames a directory Note renaming a directory changes its URI and the URI of its assets Request ge ERT URL Example http johndoe my hip serv com ap i 2 0 rest files ZmF taWx5LINhbXBsZ XM name lt xml version 1 0 gt Body x a 14 Tat lt file name NAME gt DIRECTORY_URI is the URI of the HipServ directory i e the href of any file of Details type folder or the href of a media source see Hip Serv User Information NAME is the new filename Success Response HTTP HTTP Status Code Code 200K OK T hip serv directory Contents xml without children elements mediafilter folderfilder ype nb
19. F te gt lt name locale it_IT value Festa gt lt name locale nl_ NL value Feest gt lt names gt lt styles gt lt style property background color value 0d312f gt lt styles gt lt theme gt themes hipserv theme x ml A hipserv theme xml document describes a theme and follows the following template lt xml version 1 0 gt Ktheme rank 2 href api 2 0 rest themes hipserv travel id hipservTravel gt lt names gt lt name locale en_US value Travel gt lt name locale de_DE value Reise gt lt name locale es_ES value Viaje gt lt name locale fr_FR value Voyage gt lt name locale it_IT value Viaggio gt lt name locale nl_ NL value Reizen gt I I I I I I I I I i lt names gt lt styles gt 1 lt background color gt lt style property background color value 7eb3d2 gt 1 lt font family gt i lt style property font family value Georgia Arial gt i lt navbar text color gt 1 lt style property navbar color value 1le507b gt i lt navbar text rollover color gt 1 lt style property navbar color rollover value 3495ac gt lt default text color gt i lt style property color value ffffff gt 1 lt album name text color gt i lt style property album name color value 1e507b gt 1 lt media type text color gt i lt style proper
20. FilteredAssets or assetsOffset Failure Responses directory name must not start with a dot directory name must not match the Perl Regular Expression Illegal Filename K gt EANAN OAS A i e must not contain any of the following characters lt gt amp FSO Nr 400 2 mn rene Bae A file with the requested name already exists in the requested directory f The current visitor is not an authenticated Hip Serv user who has 401 Unauthorized access to the directory Rename an Asset alternate Web Service Renames an asset Note renaming an asset changes its URI Request HIPSERV_URL ASSET_URI name http johndoe my hip serv com ap 1 2 0 rest files ZmFtaWx5L1NhbXBsZ XM vcGFyaXM wM S5qcGc name lt xml version 1 0 gt lt file name NAME gt AS SET_URTis the URI of a HipServ asset i e the href of any file of type other than folder NAME is the new filename Success Response HTTP Status Code 200 OK MIME Type hip serv assetDetails xml Failure Responses asset name must not start with a dot asset name must not match the Perl Regular Expression lt gt amp Illegal Filename AAAS i e must not contain any of the following characters lt gt amp A file with th t lr ts in th t 400 2 Fie Already Exists gt wi e requested name already exists in the requested asse The current visitor is not an authenticated Hip Serv user who has 401 Unauthoriz
21. HipServ Web Services API v0 1 Contents m Introduction m 1 Prerequisites m 1 2 Authentication m 2 REST Web Services API 2 1 Overview 2 2 Flex mode 2 3 Hip Serv XML MIME Types 2 4 Session Web Services m 2 4 1 Get an AUTH Login Code and the URL to the Hip Serv m 2 4 2 Create a new session for a Hip Serv user aka User login via the CS 2 4 3 Invalidate the Current Session aka Log Out 2 5 Server Web Services m 2 5 1 Get Server Configuration m 2 6 Account Web Services 2 6 1 Get HipServ User Information 2 6 2 Get Hip Serv User Preferences 2 6 3 Change Hip Serv User Preferences 2 6 4 Get HipServ User Gallery 2 6 5 Change Hip Serv User Password iles Web Services 2 7 1 Get Directory Contents 2 7 2 Get Light Directory Assets 2 7 3 Get Directory Details 2 7 4 Get Directory Last Modified Date Time 2 7 5 Get Asset Details 2 7 6 Get Asset or Directory Thumbnail 2 7 7 Get Asset or Directory Webview 2 7 8 Get Asset Source 2 7 9 Search for Files 2 7 10 Create a directory 2 7 11 Update Directory Name and or Sharing With DMA 2 7 12 Update Asset Name and or Caption 2 7 13 Rename a Directory alternate Web Service 2 7 14 Rename an Asset alternate Web Service 2 7 15 Save Asset Playback Position 2 7 16 Reset Saved Asset Playback Position 2 7 17 Rotate Image Asset 2 7 18 Add Tags to an Asset 2 7 19 Update all Tags in an Asset 2 7 20 Delete all the Tags of an Asset m 2 7 E E E E EEE HNE EENE 8 8 EEHEEHE TEENE E 2 7 21 Delete
22. Massive Attack album Mezzanine year 1998 title Dissolved Girl gt lt xml version 1 0 gt file name Paris avi href api 2 0 rest files ZmFtaWx5L1NhbXBsZXMvUGFyaXMuYXZp type video parentHref api 2 0 rest files ZmFtaWx5L1NhbXBsZXM path FamilyLibrary Samples Paris avi mimeType video x msvideo size 16540732 mtime 1285158726 width 720 height 400 codec mpeg4 bitrate 291 playtimeSeconds 454 gt lt tags gt lt tag gt paris lt tag gt lt tags gt lt file gt K xml version 1 0 gt file name USER GUIDE pdf href api 2 0 rest files ZmFtaWx5L1NhbXBsZXMvVVVNFUi lHVUlERS5wZGY type document parentHref api 2 0 rest files ZmFtaWx5L1NhbXBsZXM path FamilyLibrary Samples USER GUIDE pdf mimeType application pdf size 481239 mtime 1285158728 gt hipserv search Results x ml The hipserv searchResults xml MIME type defines the XML data structure of search results The searchResults root element contains the following attributes keywords space separated list of unique key words of 3 characters or more nbResults number of results returned capped moreResults true if more files matching the keywords exist but were not returned because the number of results is capped The searchResults root element also contains one file element per search result containing the following attributes name name of file or directory href file or directory URI mtime last modification time
23. RI is the URI of a HipServ album which can be obtained via the album Details Ae Fa listing or gallery Web Service Success Response HTTP Status Code 200 OK URL Example T hip serv albumContents xml without children elements mediafilter folderfilder ype nbFilteredAssets or assetsOffset Failure Responses Get Album Asset Details Thumbnail Webview Source Same as Asset Details Thumbnail Webview Source but with album assets URIs and error 403 Forbidden can be returned if access to the asset is denied to the current visitor Note the path attribute returned by an Album Asset Details Web Service call will be the path of the underly ing Asset and will be empty if the current visitor is not allowed to access this asset via Samba Save Album Asset Playback Position Reset Saved Album Asset Playback Position Same as Save Asset Playback Position Reset Saved Asset Playback Position but with album asset URIs for the current Hip Serv user or guest with access to the asset but not for anonymous visitors Error 403 Forbidden is returned if the visitor does not have access to the asset and for anonymous visitors Create an Album Creates an album in the specified album listing and returns the new album Note when sharing with friends contacts must already exist Request Details ALBUM_LUIS TING_URI is available in the albumsURI attribute of the Get HipServ User Information Web Service Success Response
24. Remove an Asset from an Album Same as Delete Directory but with Album URIs and Delete Asset but with Album Asset URIs Remove Multiple Assets from an Album Removes listed assets from an album Request HIPSERV_URUALBUM _URI trash http johndoe my hip serv com ap 1 2 0 rest albums users am9obmRvZS9IT YW 1 wbGUgQWxidW0 trash lt xml version 1 0 gt lt files gt lt file href URI1 gt lt file href URI2 gt lt files gt ALBUM_URI is the URI of a HipServ album which can be obtained via the album listing or gallery Web Service URI URE etc are the URIs of the assets to remove from the album Success Response Failure Responses 3rd Party Web Services Supported 3rd party services are m facebook Facebook m flickr Flickr Get Listing of Photosets owned by the current user on a 3rd party service Returns the listing of all photosets owned by the current user on a given 3rd party service Request HIPSERV_URL api 2 0 rest 3rdp arty SER VICE photosets URL Example http johndoe my hip serv com ap i 2 0 rest 3rdp arty facebook photosets SERVICE is the name of a supported 3rd party service Success Response HTTP Status Code 200 OK MIME Type hipserv 3rdParty PhotosetListing xml Failure Responses The user is not logged on the 3rd party service and or has not allowed the HipServ application to access the 3rd party service The error element contains the following
25. Success Response HTTP Status Code 204 No Content Failure Responses 400 4 Input Output Error Saved position not supported for this media type The requested asset is an audio asset and the current visitor is a Service is disabled Hip Serv user who set the ResumeAudioP lay back preference to False The current visitor is not an authenticated Hip Serv user who has Unauthorized access to the asset 401 403 Forbidden Anonymous visitors cannot save playback positions Rotate Image Asset Rotates an image asset by specified number of degrees Request HIPSERV_URL ASSET_ URI http johndoe my hip serv com ap 1 2 0 rest files ZmFtaWx5L1INhbXBsZ XM veGFyaXM wM SSqceGe lt xml version 1 0 gt lt file rotation DEGREE AS SET_URT is the URI of an audio or video HipServ asset i e the href of any file of type audio or video DEGREES is the clockwise rotation angle in degrees 90 180 or 270 Success Response HTTP Status Code 200 OK MIME Type hip serv assetDetails xml Failure Responses 400 3 Cannot parse XML 400 4 Input Output Error The current visitor is not an authenticated Hip Serv user who has 401 Unauthorized access to the asset Add Tags to an Asset Adds one or more tags to an asset Request POST HIPSERV URL ASSET_URI tags http johndoe my hip serv com ap 1 2 0 rest files ZmFtaWxSLINhbXBsZ XM vUGFyaXMuYXZp tags Method URL Example MIME Type hip serv
26. YYYY MM DD optional not for dma withPassword do contacts require to type a password to see the album optional true if present only for contacts lt share with contacts gt elements must contain 1 or more contact elements each with the URI of the contact in the href attribute K xml version 1 0 gt file name Sample Album type folder caption Here is the sample album theme api 2 0 rest themes hipserv travel canDownload true gt lt sharing gt lt share with dma gt lt share with public gt lt share with contacts until 2010 10 22 withPassword true gt lt contact href api 2 0 rest contacts johndoe jenny 40example com gt lt contact href api 2 0 rest contacts johndoe juniors40example com gt lt share gt lt share with family gt lt sharing gt lt file gt hipserv 3rd PartyPhotosetListing x ml A hipservw 3rdPartyPhotosetListing xml document lists the photosets available to the current authenticated Hip Serv User Its photosets root element contains 1 or more photoset elements one per photoset each with the following attributes m id photoset id name photoset name caption photoset caption lt xml version 1 0 gt Kkphotosets gt 1 lt photoset id 0 name Default Photostream caption Default Photostream gt i lt photoset id 72157625010626410 name Sample caption This is a sample album gt K photosets gt I Retrieved from http devwik
27. ame 06 Dissolved Girl mp3 type a href api 2 0 rest files ZmFtaWx5L1Nh name Paris avi type video href api 2 0 rest files ZmFtaWx5L1Nh name paris0l jpg type image href api 2 0 rest files ZmFtaWx5L1Nh name USER GUIDE pdf type document href api 2 0 rest files ZmFtaWx5L1Nh BSZXM gt udio bXBs ZXMvMDYgLSBEaXNzb2x2ZWQgR2lybC5tcDM gt bXBsZXMvUGFyaXMuYXZp gt bXBsZXMvcGFyaXMwMS5qcGec gt bXBsZXMvVVNFUilHVULERS 5wZGY gt hipserv assetDetails x ml The hipserv assetDetails xml MIME type defines an XML data structure providing access to the details of a Hip Serv asset The root file element contains the following attributes name asset filename href asset URI parentHref URI of the parent folder path Samba path to the asset empty if the asset is not accessible via samba for the current visitor type type of asset images audio video document mimeType MIME type of the asset for example image jpeg size number of bytes the asset occupies on the file system mtime last modified time stamp in seconds since the epoch caption descriptive end user supplied caption if defined type specific metadata m for image assets height image height m width image width timeTaken time taken if defined for audio assets each if defined bitrate audio bitrate playtimeS econds play time in seconds artist artist composer comp oser album album name year album year t
28. an authenticated Hip Serv user Create a directory Creates a subdirectory in the specified directory and returns its directory contents Request HIPSERV_URL DIRECTORY URI URL Example http johndoe my hip serv com ap i 2 0 rest files ZmFtaWx5LINhbXBsZ XM lt xml version 1 0 gt Body Zn Tu lt file name NAME type folder gt DIRECTORY URI is the URI of the parent Hip Serv directory i e the href of any file of type folder or the href of a media source see Hip Serv User Information Success Response HTTP HTTP Status Code Code 201 rca hip serv directory Contents xml without children elements mediafilter folderfilder MIME Type nbFilteredAssets or assetsOffset Failure Responses directory name must not start with a dot directory name must not match the Perl Regular Expression lt gt amp 0 AS Illegal Filename i e must not contain any of the following characters lt gt amp A file with th t l ists in th t 400 2 EAko Es ile wi e requested name already exists in the requested directory The current visitor is not an authenticated Hip Serv user who has 401 Unauthorized access to the directory Update Directory Name and or Sharing With DMA Updates the name and or Sharing With DMA of a directory Note renaming a directory changes its URI and the URI of its assets Request Method PUT HIPSERV_URL DIRECTORY_URI URL Example http johndoe my
29. ap i 2 0 rest accounts users johndoe password Bod lt 2xmle yers ion Ville Ot 2 gt cay lt user password PASSWORD gt USER URI is the URI of the Hip Serv user received in the userURI attribute as a result of a user login Details PAS S WORD is the password which must be 6 or more characters long and include at least one digt Success Response HTTP Status Code 204 No Content Failure Responses mos fmre SSS Eo o E The current visitor is not an authenticated Hip Serv user The current authenticated Hip Serv user is not the user whose Forbidden information is requested Files Web Services Get Directory Contents Returns the directory contents for the specified directory Subdirectories will not be traversed Request HIPSERV_URL DIRECTORY URI URL Example http johndoe my hip serv com ap i 2 0 rest files ZmF taWx5LINhbXBsZ XM offset integer gt 0 skip that many children from the beginning of the result set startHref use the index of the asset with this href as the offset startHref has precedence over offset length integer gt 0 max number of children to return sort name mimeT y pelsize mtime cap tion tags sort by that field order asc desc ascending default or descending order folderfilter true false if false filters out folders mediafilter image audio video documentiall only return files of that type Query String audiodetails true false if true and mediafilter is
30. atedListParent yet to document relatedListChild yet to document button button to click it set the value of the preference to buttonClicked category preference category in plain English for information only m categoryID preference category id preferences should be grouped by category for edition User preferences are all in the User category m required if true or True the preference value cannot be an empty string This attribute can also contain a condition such as dhcp False which mean the preference is required if and only if the value of the dhcp preference is False permission who is allowed to access the preference user Hip Serv users admin admin users setup local visitors during setup empty string any body default default value a validation validation criterion can be safely ignored for non string bigString preferences Can be either m csv REGEX the value must be split on commas and each piece must match the REGEX regular expression m REGEX the value must match the REGEX regular expression relatedRule condition to meet for the preference to be displayed for example dhcp True means show this preference if and only if the value of the dhcp preference is True reloadRequired if true or True the user should re log in once the preference is saved validationMessage legacy not used editable legacy not used visible if False or false the preference should not be displayed sort i
31. audio add title album artist Arguments playtimeSeconds and savedPosition to the attributes of the children assets Default is false mobile true false if true the children file elements returned will not contain tags elements and the only attributes they will contain are name type and href Note if offset or length is not defined or invalid all children are returned Note if sort is not defined or invalid children are ordered by ascending name Note if folderfilter is not defined or invalid folders are returned Note if mediafilter is not defined or invalid all media types are returned Details DIRECTORY URI is the URI of a Hip Serv directory i e the href of any file of type folder or the href of a media source see Hip Serv User Information Success Response HTTP Status Code 200 OK MIME Type hip serv directory Contents xml Failure Responses f The current visitor is not an authenticated Hip Serv user who has 401 Unauthorized access to the directory Get Light Directory Assets Returns a lightweight faster version of the directory contents for the specified directory excluding directories Request HIPSERV URL DIRECTORY URI lightassets http johndoe my hip serv com ap 1 2 0 rest files Z mFtaWx5LINhbXBsZ XM lightassets DIRECTORY URI is the URI of a Hip Serv directory i e the href of any file of type folder or the href of a media source see Hip Serv User Information Success Response
32. central server logs a HipServ user in first logging out the current HipServ user if there is one and returns the new session Request POST HIPSERV_URL api 2 0 rest sessions lt xml version 1 0 gt lt session code AUTH gt HIPS ERV_URL is the URL of the HipServ received from the central server iepys Response AUTH is the AUTH login code received from the central server HTTP Status Code 200 OK MIME Type hip serv session xml Failure Responses fa CmorrancxMt pos mowo SSS a ee S Ce SSS Invalidate the Current Session aka Log Out Invalidates the current session if the visitor is logged Returns the information of an anonymous visitor in any case Request HIPSERV_URL SESSION_ URI SES SION_URI is the URI of the current session received in the href attribute as a result of a user login Success Response HTTP Status Code 200 OK MIME Type hip serv usert xml The XML returned is the one of an anony mous visitor since the session was Details invalidated Failure Responses Server Web Services Get Server Configuration Returns the configuration of the server Request Method HIPSERV_URL api 2 0 rest server config Success Response Failure Responses Account Web S ervices Get HipServ User Information Returns the information about a given Hip Serv user Only this authenticated Hip Serv user is allowed to call this service Request HIPSERV URL
33. contact is requested Delete a Contact Deletes a contact owned by a HipServ user who must be logged in Request HIPSERV_URLICONTACT _URI URL Example http johndoe my hip serv com ap i 2 0 rest contacts johndoe jenny 40examp le com Query String force true remove the contact even if one or more albums owned by the Arguments authenticated Hip Serv user are shared with the contact to remove CONTACT_URI is the URI of a contact they are available in the href attributes of Details the Get all the contacts of a user Web Service Success Response HTTP Status Code 204 No Content There cannot be two contacts with the same email address in the contact list of a HipServ user MIME Type hip serv contact xml Failure Responses Themes Web Services Get All Themes Returns all themes ordered by rank only available to authenticated HipServ users Request HIPSERV_URUTHEMES URI od Example http johndoe my hipserv com ap i 2 0 rest themes THEMES _URT is available in the themesURI attribute of the Get Hip Serv User Details TT Information Web Service Success Response Failure Responses Get a Theme Returns a given theme Request HIPSERV_URL THEME URI URL Example http johndoe my hip serv com ap i 2 0 rest themes hip serv travel THEME URI is the value of a href attribute of the response of the Get All Themes Web Service Success Response Failure Responses Albu
34. ds paris nbResults 2 gt lt file name Paris avi href api 2 0 rest files ZmFtaWx5LINhbXBsZXMvUGFyaXMuYXZp type video mimeType video x msvideo size 16540732 mtime 1285158726 matchedFields tags name parentHref api 2 0 rest files ZmFtaWx5L1INhbXBsZXM gt lt tags gt lt tag gt paris lt tag gt lt tags gt lt file gt lt file name paris01l jpg href api 2 0 rest files ZmFtaWx5LINhbxXBsZXMvcGFyaXMwMS5qcGc type image mimeType image jpeg caption Paris 2010 size 415297 mtime 1285158722 matchedFields tags caption name parentHref api 2 0 rest files ZmFtaWx5L1INhbxBsZXxXM gt lt tags gt lt tag gt notre dame lt tag gt lt tag gt paris lt tag gt lt tags gt l lt file gt K searchResults gt I hipserv tagList x ml A hipserv tagList xml document describes a list of tags associated with an asset Samp le document lt xml version 1 0 gt lt tags gt lt tag gt Vacation lt tag gt lt tag gt Beach lt tag gt lt tag gt Picnic lt tag gt l l l Li l K tags gt l hipserv contacts x ml A hipserv contact xml document describes a list of contacts with their href email and Display Name Sample document lt contacts gt lt contact href api 2 0 rest contacts johndoe jenny 40example com email jenny example com DisplayName Jenny Doe gt lt contact href api 2 0 rest contacts johndoe junior 40example com email junior example com DisplayName Junior Doe gt
35. e and or has not allowed the HipServ application to access the 3rd party service i The error element contains the following attributes User is not authorized logged into the requested 3rd party m service the requested 3rd party service service m loginURL the 3rd party login access URL The user must be directed to the loginURL and allow the Hip Serv application to access the 3rd party service Once it s done he can retry to call this Web Service 400 29 Service is disabled The requested 3rd party service is not enabled on the Hip Serv A The current visitor is not the authenticated owner of the requested 401 Unauthorized ib album Unlink an album from a 3rd party photoset Unlinks an album from a flickr facebook photoset Request DELETE HIPSERV URL ALBUM _URI 3rdparty SERVICE photoset http johndoe my hip serv com ap 1 2 0 rest albums users YWRtaW4vQWRtaW4gU2FtcGxlIEFs YnVt 3rdp arty photoset ALBUM_URI is the URI of a HipServ album which can be obtained via the album listing or gallery Web Service SERVICE is the name of a supported 3rd party service Success Response HTTP Status Code 204 No Content Failure Responses 400 29 Service is disabled The requested 3rd party service is not enabled on the Hip Serv s The current visitor is not the authenticated owner of the requested 401 Unauthorized ib album Non REST Web Services API File Upload Services Upload Files Standard HTTP up
36. ed access to the asset Save Asset Playback Position Saves the asset playback position for the current visitor not anonymous Request http eens ae i 2 0 rest files ZmFtaWx5L1NhbXBsZ XM vM DYgLSBEaXNzb2x2Z WQsgR2lybC5tcDM savedPosition lt xml version 1 0 gt lt fille SavedPosit1on SHCONDS gt AS SET_URT is the URI of an audio or video HipServ asset i e the href of any file of type audio or video SECONDS is the the playback position to save in seconds Success Response HTTP Status Code 200 OK MIME Type hip serv assetDetails xml Failure Responses mos eamo panes pos powo SSS mos ar OOS 400 17 aa p a not supported for this media type The requested asset is an audio asset and the current visitor is a Service is disabled Hip Serv user who set the ResumeAudioPlay back preference to False The current visitor is not an authenticated Hip Serv user who has Unauthorized access to the asset 403 Forbidden Anonymous visitors cannot save playback positions Reset Saved Asset Playback Position Resets the saved asset playback position for the current visitor not anony mous Request DELETE HIPSERV_URL ASSET_URI savedPosition http johndoe my hip serv com ap 1 2 0 rest files ZmFtaWx5L1NhbXBsZ XM vM DYgLSBEaXNzb2x2Z WQsgR2ly bCS5tcDM savedPosition AS SET_URI is the URI of an audio or video HipServ asset i e the href of any file of type audio or video
37. elements and the only attributes they will contain are name type and href Note if offset or length is not defined or invalid all children are returned Note if sort is not defined or invalid children are ordered by ascending name Note if folderfilter is not defined or invalid folders are returned Note if mediafilter is not defined or invalid all media ty pes are returned ALBUM_URI is the URI of a HipServ album which can be obtained via the album Detail nee aks listing or gallery Web Service Success Response Failure Responses Get Light Album Assets Returns a lightweight faster version of the album contents for the specified album Request Method HIPSERV_URL ALBUM_ URIlightassets http johndoe my hip serv com ap 1 2 0 rest files URL Ex l P am9obmRvZS9IT YW 1 wbGU gQWxidWO lightassets ALBUM_URI is the URI of a HipServ album which can be obtained via the album Details listing or gallery Web Service Success Response HTTP Status Code 200 OK hip serv light AlbumA ssets xml without children elements mediafilter folderfilder MIME Type nbFilteredAssets or assetsOffset Failure Responses The current visitor does not have read access to the requested Get Album Details Returns details about an album without its children Request HIPSERV_URL ALBUM_ URI details http johndoe my hip serv com ap 1 2 0 rest files am9obmRvZS9IT YW 1 wbGU gQWxidW0 details ALBUM_U
38. ements must contain 1 or more contact elements each with the href email address and Display Name of the contact in the contact attribute Samp le document lt xml version 1 0 gt Kfile name johndoe href api 2 0 rest albums users am9o0bmRvZQ type folder parentHref _nbFolders 1 nbFiles 0 mediafilter all folderfilter true nbFilteredAssets 1 gt lt file name Sample Album type folder href api 2 0 rest albums users am90bmRVZS ITYW1lwbGUgQWxidwo canDownload true theme api 2 0 rest themes hipserv travel themeId hipservTravel caption Here is the sample album nbFiles 5 gt lt sharing gt lt share with dma gt lt share with public gt lt share with contacts until 2010 10 22 withPassword true gt lt contact email jenny example com href api 2 0 rest contacts johndoe jenny 40example com DisplayName Jenny Doe gt lt contact email junior example com href api 2 0 rest contacts johndoe juniors40example com DisplayName Junior Doe gt lt share gt lt share with family gt lt sharing gt lt file gt lt file gt hipserv albumContents x ml A hipserv albumContents xml document is an XML document describing an album and its contents Its file root element contains the following attributes name album name href album URI parentHref URI of the parent folder album listing type always folder mtime last modification time in sec
39. end a Share Email to all Album Contacts Sends a Share Email to all Album Contacts Request POST HIPSERV_URL ALBUM_URI email http johndoe my hip serv com ap 1 2 0 rest albums users am9obmRvZS9IT YW 1 wbGU gQ Wxid W0 email lt xml version 1 0 gt lt email gt ALBUM_URI is the URI of a HipServ album which can be obtained via the album listing or gallery Web Service Success Response HTTP Status Code 204 No Content Failure Responses Add Assets to an Album Adds the assets listed in the request to a given album as well as the assets at the root of the directories listed in the request Subdirectories are not traversed Request Method POST HIPSERV_ URL ALBUM URI http johndoe my hip serv com ap 1 2 0 rest albums users am9obmRvZS9IT YW 1 wbGU gQWxidW0 lt xml version 1 0 gt lt files gt lt file href URI1 gt lt file href URI2 gt URL Example lt files gt OLE lt xml version 1 0 gt Seales Igitee MURTI ALBUM_URI is the URI of a HipServ album which can be obtained via the album listing or gallery Web Service URI URM etc are the URIs of the assets and directories to add to the album Failure Responses Cannot parse XML Invalid Parameter one or more URIs are invalid The user is not logged on one or more 3rd party services to which the requested album is linked and or has not allowed the Hip Serv app lication to access one ore more of those 3rd
40. erence gt lt preference name ResumeAudioPlayback desc _ value False weight 10 type bool category User categoryID User required false permission user default False validation relatedRule reloadRequired False validationMessage Invalid editable True visible true sort sortOn handler user gt lt value name True desc True gt lt value name False desc False gt lt preference gt lt preference lt preferences gt name do_not_ prompt clear desc Reset all prompts value null weight 12 type button category User categoryID User required False permission user default validation relatedRule reloadRequired False validationMessage Invalid editable True visible True sort sortOn handler user gt 1 User preferences applicable to a mobile UI locale user locale branding dependent usually de DE branding en US es ES fr FR it IT and dependent nl NL usually en US file _exists_action Action to perform when TENAME NEW moving copying m new keep the new file up loading a file overwrite the old one to a directory containing E rename new rename the new a file with the same name file to avoid overwriting the old one m old keep the old file do not overwrite it landing page bg clear button to clear the buttonClicked n a landing page image landing page bg position landing page image center scaling method m center scale the image so that
41. es the number of files in the folder sharingWithDMA true if the folder is shared with DMA inherited if the folder is shared with DMA because one of its ancestors is false otherwise optional default false deviceHref URI of the ejectable USB storage device where the folder resides optional readOnly truelfalse true for folders that cannot be deleted copied renamed or moved and where no file or folder can be created added cop ied moved so far only ExternalStorage op tional default false isCoreMount true false true for folders that are core mountpoints i e can only be ejected by admins so far My Library Family Library My Computers on plugs where those folders are on the eSATA drive optional default false and for assets if available mimeType Asset MIME type audio mpeg image jpeg etc caption caption m size file size in bytes m tags tags element containing a tag element for each tag in a text node See below an example implementation of hipserv directory Contents xml MIME type lt xml ve file na parentHref api 2 0 rest files ZmFtaWx5 path FamilyLibrary Samples nb fo lt file lt file lt file lt tag lt t lt ta lt file lt file lt tag lt t lt t lt ta lt file lt file rsion 1 0 gt me Samples href api 2 0 rest files Folders 1 nbFiles 4 mtime 1285158 lderfilter true nbFilteredAssets 5 name Sample Folder ty
42. f True or true the supported values for the preference should be sorted in the UI sortOn if set to name sort the supported values by localized name handler user for user preferences server for server preferences preference elements of type string bigString or relatedListChild also contain 1 or more value elements with one per supported value with the following attributes m name the supported preference value desc a description of the value for information only Samp le lt preferences gt lt preference lt preference name Share from_email desc Sharing Emails Sender value john example com weight 2 type string category User categoryID User required False permission user default validation w w w w w 0 66 a z 2 6 a z 2 relatedRule reloadRequired False validationMessage invalidFormatEmailAddress editable True visible True sort sortOn handler user gt name landing page _bg position desc Landing Page Background Position value center weight 4 type list category User categoryID User required True permission user default center validation relatedRule reloadRequired False validationMessage Invalid editable True visible True sort sortOn handler user gt lt value name center desc backgroundposition center gt lt value name fit desc backgroundposition fit gt lt pref
43. he href of any file or the href of a media source see Hip Serv User Information Success Response HTTP Status Code 200 OK Details The response is a JPEG PNG or GIF image that can fit in a 1024x768 rectangle Failure Responses Get Asset Source Returns the source for the specified asset Directories do not support this call HIPSERV_URL ASSET_UR sre http johndoe my hip serv com ap 1 2 0 rest files ZmFtaWxSL1NhbXBsZ XM vUGFyaXMuYXZp sre AS SET_URIT is the URI of a Hip Serv asset i e the href of any file of type other than folder Streaming for files smaller than 2GB can be achieved by using the Range HTTP header Failure Responses Search for Files Returns up to 500 files accessible to the current Hip Serv user assets and directories which caption tags or filename match all the key words specified in the query string The files found through the caption are returned first then tags then filename Only a logged in HipServ User is allowed to search for files Request URLs HIPSERV_URL api 2 0 rest files search Query String kw space separated keyword list to search in tags captions and filenames A i s 2 eee Details Keywords under 3 characters are ignored Success Response HTTP Status Code 200 OK MIME Type hipserv searchResults xml Failure Responses At least one of the key words 400 18 TE have 3 characters or more 401 Unauthoriz ed The current visitor is not
44. he theme of the album themeld ID of the theme of the album lt xml version 1 0 gt lt gallery gt lt file name Admin Sample Album type folder href api 2 0 rest albums users YWRtaW4vQWRtaW4gU2FtcGxlIEFsYnVt ownerFullName Admin coverURI api 2 0 rest albums users YWRtaW4vQWRtaW4gU2FtcGxlIEFsYnVtL3Bhom1zMDEuanBn canDownload true theme api 2 0 rest themes hipserv birthday themeId hipservBirthday nbFiles 4 gt lt file name Sample Album type folder href api 2 0 rest albums users am9o0bmRvZS9TYW1lwbGUgQWxidW0 ownerFullName John Doe coverURI api 2 0 rest albums users am9obmRvZS9TYW1wbGUgQWxidW0vcGFyaXMwMS5qcGc canDownload true theme api 2 0 rest themes hipserv travel themeId hipservTravel nbFiles 4 gt lt gallery gt hipserv directoryConten ts x ml The hipserv directory Contentst xml MIME type defines an XML data structure providing access to the contents of a HipServ directory All assets and subdirectories in the directory are provided subdirectories are not traversed The file root node containts the following attributes name folder name href folder URI parentHref URI of the parent folder or empty if the folder is a media source path the Samba path of the folder type always folder mtime last modification time in seconds since the epoch nbFolders the number of folders in the folder nbFiles the number of files in the folder sharingWithDMA true if the folde
45. i axentra com index php HS_2 0 _Web_Services_API
46. ipserv light Directory Assets xml 4 1 9 hipserv assetDetails xml 4 1 10 hipserv searchResults xml 4 1 11 hipserv tagList xml 4 1 12 hipserv contacts xml 4 1 13 hipserv contact xml 4 1 14 hipserv themes xml 4 1 15 hipserv theme xml 4 1 16 hipserv albumListing xml 4 1 17 hipserv albumContents xml 4 1 18 hipserv lightAlbumAssets xml 4 1 19 hipserv albumRequest xml 4 1 20 hipserv 3rdParty PhotosetListing xml Introduction This document describes the main Web Services available on a HipServ v2 4 to HipServ users It does not describe Web Services targeting Hip Serv administrators or branding dependent Web Services Prerequisites To call the Web Services you need good knowledge of HTTP a HipServ running v2 4 or higher configured with access to the Internet a client device with access to the Internet the fully qualified domain name or IP address of the Central Server CS where the Hip Serv is registered CS FQDN in this document the name as which the HipServ is registered aka hipname m the name of a Hip Serv user aka username m the password of this user Authentication Most Hip Serv Web Services are only available to authenticated users so logging in is the first thing to do see Session Services A session cookie is sent by the Hip Serv in response to a successful user login This cookie must be sent with all further requests for the Hip Serv user to be authenticated User sessions usually expire after 3 hours of inac
47. it fills the screen as much as possible without cropping it maintaining the image ratio m fit scale the image so that it fills the whole screen cropping it if necessary maintaining the image ratio landing page bg url Landing page background The URI of an image asset accessible empty string image URI by the user new_album_ sharing dma Share new albums with True or False False media players by default new_album_ sharing family Share new albums with True or False nea other family accounts by default ResumeA udioPlay back Resume Audio Playback True or False False where it stopped i e allow visitors to save the position of the playback of audio files Sharing Emails Sender a valid email address empty string hipserv gallery x ml A hipserv gallery xml document is an XML document describing the albums available read access to a visitor Hip Serv user guest or anonymous visitor Its gallery root element contains 0 or more file elements with the following attributes name album name type folder href album URI ownerFullName display name of the album owner nbFiles approximate number of files in the album coverURI URI of the asset to use for the album cover from the DB if defined otherwise the first image video music or document asset in the album in this order missing if the album is empty canDownload true false can gallery visitors download files from this albums theme URI of t
48. it must be GET PUT DELETE or POST in uppercase M oreover in Flex mode a 200 status code is always returned Responses for status codes over 400 in Flex mode look like l werrors gt i lt error code 401 msg Unauthorized gt K errors gt Li The Flex mode is optional HipS erv XML MIME Types The following table defines the XML MIME types used in the Hip Serv REST API They are describe in great detail in the appendix MIME Type Description hipserv session xml Hip Serv session hip serv serverconfigtxml Hip Serv configuration hipserv user xml Hip Serv user hip serv mediaSources xml Hip Sery media sources hip serv preferences xml Hip Serv preferences hip serv gallery xml Hipserv gallery nip serv directory Contents xml Hip Serv directory and its assets and subdirectories hip serv lightDirectory Assets xml Light version of a Hip Serv directory and its assets hipserv assetDetails xml Hipserv asset details hipserv searchResults xml Hip Serv search results hip serv tagList xml Hipserv tag list usually associated with an asset hip serv contacts xml Hip Serv contacts listing hipserv contactt xml Hip Serv contact hip serv themes xml Hip Serv themes listing hipserv theme xml Hip Serv theme hipserv albumListing xml HipServ album listing and its albums hip serv albumContents xml Hip Serv album and its assets hip serv light AlbumA ssets xml Light version of a HipServ album
49. itle track title savedPosition saved playback position in milliseconds for video assets each if defined width video width height video height codec video codec bitrate video bitrate playtimeS econds play time in seconds savedPosition saved playback position in milliseconds for document assets none The root file element can also contain a single tags element containing one or more tag element each containing a search tag associated with the asset in a text node See below an example implementation of hipserv assetDetails xml MIME type for each of the supported asset types Image Asset lt xml version 1 0 gt Kfile name paris01l jpg i href api 2 0 rest files ZmFtaWx5L1NhbXBsZXMvcGFyaXxMwMS5qcGce f type image parentHref api 2 0 rest files ZmFtaWx5L1NhbXBsZXM 1 path FamilyLibrary Samples paris0l jpg mimeType image jpeg i size 415297 mtime 1285158722 caption Paris 2010 1 width 1024 height 641 gt lt tags gt lt tag gt notre dame lt tag gt i lt tag gt paris lt tag gt lt tags gt K file gt I lt xml version 1 0 gt Kfile name 06 Dissolved Girl mp3 href api 2 0 rest files ZmFtaWx5L1NhbXBsZXMvVMDYgLSBEaXNzb2x2ZWQgR2lybC5tcDM type audio parentHref api 2 0 rest files ZmFtaWx5L1NhbXBsZXM path FamilyLibrary Samples 06 Dissolved Girl mp3 mimeType audio mpeg size 5873792 mtime 1285158715 bitrate 128 playtimeSeconds 366 artist
50. load can be used to upload files to a directory accessible to a Hip Serv user To do so send a POST request to filemanager done_upload on the HipServ with the following parameters in multip art form data encryption np target directory URI Example api 2 0 rest files Z mFtaWx5 a m ACTION UPLOAD FILE file 0 first file to upload a a file 1 second file to upload etc The response will unfortunately always be an HTML document sent with status code 200 The best way to verify that the upload was successful is to request a directory listing Sample Request Body Content Type multipart form data Content Length 533 I 3164 30335698 Content Disposition form data name ACTION 3164 30335698 I IContent Disposition form data name np I 1 Vapi 2 0 rest files ZmFtawx5 a 3164 Content Disposition form data name file 0 30335698 Content Type application octet stream I filename foo Appendix HipServ XML MIME Types hipserv session x ml A hipserv session xml document describes a Hip Serv user session and contains enough information for the client to get started It is made of a single session root element with the following attributes supportURL URL of the support page userURI URI where to gather information about the current Hip Serv user href URI of the session requesti
51. logged in via SSO or if the SSO binding was created in the current session The user root node contains also asingle mediaS ources element hipserv mediaSources xml Hip Serv user only m asingle preferences element hipserv preferences xml Hip Serv user only See below an example implementation of the hipserv user xml MIME type Kk xml version 1 0 gt Kuser href api 2 0 rest accounts users johndoe username johndoe displayName John Doe isAdmin true isGuest false isHipServUser true isFamilyMember true albumsURI api 2 0 rest albums users am9o0bmRvZQ contactsURI api 2 0 rest contacts johndoe themesURI api 2 0 rest themes gt lt mediaSources gt lt mediaSource id FamilyLibrary name FamilyLibrary href api 2 0 rest files ZmFtawWx5 backupHref api 2 0 rest backup files ZmFtaWx5 gt lt mediaSource id MyLibrary name MyLibrary href api 2 0 rest files users johndoe TX1MaWJyYxXJ5 backupHref api 2 0 rest backup files users johndoe TX1MaWJyYxXJ5 gt lt mediaSource id MyComputers name MyComputers href api 2 0 rest files users johndoe TX1Db21wdXRlcnM backupHref api 2 0 rest backup files users johndoe TX1Db21wdXRlcnM gt lt mediaSources gt lt preferences gt lt preference name locale desc Language value en US weight 1 type list category User categoryID User required True permission user default en US validation relatedRule reloadRequired False
52. ls MTIME is the last modified time of the directory in seconds since the epoch Failure Responses Get Asset Details Returns details about the sp ecified asset Request HIPSERV_URL ASSET_URI URL Esme http johndoe my hip serv com ap 1 2 0 rest files ZmFtaWxSL1NhbXBsZXM vUGFyaXMuYXZp AS SET_URI is the URI of a Hip Serv asset i e the href of any file of type other Details than folder Success Response od Example Failure Responses Get Asset or Directory Thumbnail Returns the thumbnail image for the specified file asset or directory Request Mista HIPSERV_URL FILE_URI thumbnail http johndoe my hip serv com ap 1 2 0 rest files Z mFtaWx5LINhbXBsZ XM CRL DE ipie hanbail FILE URI is the URI of a Hip Serv asset or directory i e the href of any file or the Details j href of a media source see Hip Serv User Information Success Response HTTP Status Code 200 OK The response is a JPEG PNG or GIF imag that can fit in a 115x115 square Failure Responses The current visitor is not an authenticated Hip Serv user who has 401 Unauthorized access to the asset or directory Get Asset or Directory Webview Returns the webview image for the specified file asset or directory Request HIPSERV_URLIFILE_URIiwebview URL Example http johndoe my hip serv com ap 1 2 0 rest files Z mFtaWx5LINhbXBsZ XM webview FILE_URI is the URI of a HipServ asset or directory i e t
53. ms Web Services Get Listing of Albums owned by a user Returns the listing of all albums owned by a user who must be logged in Request HIPSERV_URL ALBUM_ LISTING URI od Example http johndoe my hip serv com ap i 2 0 rest albums users am90bmRvZQ ALBUM_UIS TING_URI is available in the albumsURI attribute of the Get Details 3 mre HipServ User Information Web Service Success Response Failure Responses Get Album Contents Returns information about the requested album and its contents Request HIPSERV_URUALBUM _URI http johndoe my hip serv com ap 1 2 0 rest files am9obmRvZS9IT YW 1 wbGU gQWxidW0 Query String Arguments m offset integer gt 0 skip that many children from the beginning of the result set m startHref use the index of the asset with this href as the offset startHref has precedence over offset length integer gt 0 max number of children to return sort name mimeTypelsize mtime caption tags sort by that field order asc desc ascending default or descending order folderfilter true false if false filters out folders mediafilter imagelaudio video documentiall only return files of that type audiodetails true false if true and mediafilter is audio add title album artist playtimeSeconds and savedPosition to the attributes of the children assets Default is false mobile true false if true the children file elements returned will not contain tags
54. ng a DELETE method on this URI will log the user out serverConfigURI URI where to gather information about the server configuration locale current locale lt xml version 1 0 gt Ksession 1 supportURL http www hipserv com support userURI api 2 0 rest accounts users johndoe serverConfigURI api 2 0 rest server config href api 2 0 rest sessions 12345678123456781234567812345678 locale en US hipserv serverconfig x ml The hipserw serverconfig xml MIME type defines an XML data structure providing access to the Hip Serv configuration The configuration root node contains the following attributes version HipServ version release HipServ release key Product key issued to the HipServ only for admin users portal Registered portal name for the Hip Serv aka Hip Name or Hip Serv Name apache URL Apache URL for open source credits phpURL PHP URL for open source credits supportURL Product support site URL userManual URL Product user manual URL mediaPlaybackHelpURL Absolute Path to the media player help button on the Hip Serv eulaURL Absolute Path to the End User License Agreement EULA on the Hip Serv loginURL Absolute Path to the End User login portal on the HipServ serverNoticesURI Absolute Path to the Web Service endpoint to get Server Notices on the Hip Serv downloadURL Absolute Path to the download HTML popup page on the Hip Serv uploadURL Absolute Path to the upl
55. not an authenticated Hip Serv user who has 401 Unauthorized access to the target directory Move Files Moves files assets and or directories to a target directory Request HIPSERV_URLIDIRECTORY_URtimovelis http johndoe my hip serv com ap 1 2 0 rest files Z mFtaWx5LINhbXBsZ XM movelist lt xml version 1 0 gt lt files gt lt file href URI1 type TYPE1L gt lt file href URI2 type TYPE2 gt lt files gt DIRECTORY _ URI is the URI of the target Hip Serv directory i e the href of any file of type folder or the href of a media source see Hip Serv User Information URI URM etc are the URIs of the assets and directories to move and TYPE1 TYP2 etc are their types Success Response HTTP Status Code 201 Created a file root element containing the newly moved files a hipserv assetDetailstxml document for each moved asset anda Body hipserv directoryContentstxml without children elements mediafilter folderfilder nbFilteredAssets or assetsOffset document for each moved directory Failure Responses mos fms OSS pos upwowputmr OO ooo 400 23 Cannot copy move to self or to a descendant i The current visitor is not an authenticated Hip Serv user who has 401 Unauthorized access to the target directory Contacts Web Services Get all the contacts of a user Returns all the contacts of a user who must be logged in Request HIPSERV_URLICONTACTS URI
56. oad HTML popup page on the Hip Serv brandingLogoURL Absolute Path to the branding logo on the Hip Serv a a a a a a E a a a a a a 5 E productName branded name for the Hip Serv quickTourVideoURL Flash video URL providing QuickT our product intro optional brandingLogoLink URL of the link to put on the branding logo optional defaultHipName the default HipName in LAN Only mode optional subscription standard premium only for admin users when the concept of subscription exists isRemote true false false if the client is in the same local network as the Hip Serv only for admin users when the concept of subscription exists hasNoPrivate Files true if MyComputers and My Library do not exist missing otherwise hasNoFamilyLibrary true if Family Library does not exist missing otherwise isOnlyUS BS torage true if no hard drive is permanent i e the Hip Serv is a plug missing otherwise supportsNoCS true if the Hip Serv supports switching between LAN Only and Remote Access noC true if the CPE is LAN Only i e no remote access i e does not communicate with the CS See below a sample implementation lt xml version 1 0 gt configuration version 2 3 2 release 2 0 0 261 portal johndoe loginURL homebase signin i 1234567 serverNoticesURI api 2 0 rest server notices userManualURL http support hipserv com help apacheURL http www apache org phpURL http www ph
57. onds since the epoch nbFolders number of folders in the album always 0 nbFiles number of files in the album sharingWithDMA true if the album is shared with DMA false otherwise optional default false caption album caption descrip tion p aragrap h optional theme theme URI themeld theme Id ownerFullName album owner full name canDownload true false can gallery visitors download files from this albums publicS hare URL URL of the album in the public gallery Ignore it for non public albums RSS20URL URL of the RSS feed for the album only for public albums and only if RSS support is enabled coverURI URI of the asset to use for the album cover from the DB if defined otherwise the first image video music or document asset in the album in this order missing if the album is empty mediafilter media type filter applied to the current directory content imagelaudio video document all folderfilter true false if false folders are filtered out nbFilteredAssets total number of children files and folder returned in the document after media type and folder filtering and paging m assetsOffset the offset from the beginning the directory listing If the current visitor is the owner of the album the root file element can contain a single sharing element with 1 to 4 share elements each with a different with attribute Attributes of the share elements are m with with whom the album is shared dma p
58. p net supportURL http support hipserv com support mediaPlaybackHelpURL http support hipserv com support documentation codecs eulaURL eula html uploadURL filemanager upload_ file downloadURL filemanager download_ files brandingLogoURL images Co Brand Logos HipServ png productName HipServ brandingLogoLink http www axentra com key ABCD EFGH IJKL MNOP subscription premium isRemote false gt hipserv user x ml The hipserv user xml MIME type defines an XML data structure providing access to a Hip Serv user guest account The user root node contains the following attributes username Login username for hipserv user or email for guest empty for an anony mous visitor href User URI displayName user display name isAdmin administrator account flag Boolean flag indicating if the user is an Administrator on the system true false isGuest guest account flag Boolean flag indicating if the user is a guest on the system true false isHipServUser Hip Serv account flag Boolean flag indicating if the user has a Hip Serv account true false isFamilyMember Family member flag Boolean flag indicating if the Hip Serv account has access to the family library true false albumsURI user album listing URI hipserv user only contactsURI user contacts URI hipserv user only themesURI themes listing URI hipserv user only SS OLoginID SSO login ID only if the user
59. pe folder href api 2 0 rest files ZmFtaWx5L1N sharingWithDMA true nbFolders 0 nb D name 06 Dissolved Girl mp3 type a href api 2 0 rest files ZmFtaWx5L1Nh mimeType audio mpeg size 5873792 m name Paris avi type video href api 2 0 rest files ZmFtaWx5L1Nh mimeType video x msvideo size 16540 s gt ag gt paris lt tag gt gs gt gt name paris0l jpg type image href api 2 0 rest files ZmFtaWx5L1Nh mimeType image jpeg caption Paris 2 s gt ag gt notre dame lt tag gt ag gt paris lt tag gt gs gt gt name USER GUIDE pdf type document href api 2 0 rest files ZmFtaWx5L1Nh mimeType application pdf size 48123 ZmFtaWx5L1INhbXBsZXM type folder 728 mediafilter all gt bXBSZXMvU2FtcGxlIEZvbGRlicg Files 0 mtime 1285158852 gt udio bXBsZXMvMDYgLSBEaxNzb2x2ZWQgR21lybC5tcDM time 1285158715 gt bXBs ZXMVUGFyaXMuYXZp 732 mtime 1285158726 gt bXBsZXMvcGFyaXMwMS5qcGc 010 size 415297 mtime 1285158722 gt bXBSZXMVVVNFUi1LHVULERS 5wZGY 9 mtime 1285158728 gt hipserv lightDirectory Assets x ml A hipserv lightDirectory Assets xml document is a lightweight description of a HipServ directory with the directory s URI and the list of all assets with their URI name and type subdirectories are excluded 1 Kfile href api 2 0 rest files ZmFtaWx5L1Nhbx lt file lt file lt file lt file lt file gt n
60. pserv mediaS ources xml MIME type lt xml version 1 0 gt KmediaSources gt lt mediaSource id MyLibrary name MyLibrary lt mediaSource id FamilyLibrary name FamilyLibrary href api 2 0 rest files ZmFtawWx5 backupHref api 2 0 rest backup files ZmFtaWx5 gt href api 2 0 rest files users johndoe TX1MaWJyYXJ5 backupHref api 2 0 rest backup files users johndoe TX1MaWJyYXJ5 gt lt mediaSource id MyComputers name MyComputers href api 2 0 rest files users johndoe TX1Db21wdXRlcnM backupHref api 2 0 rest backup files users johndoe TX1Db21wdXRlcnM gt lt mediaSources gt hipserv preferences x ml A hipserv preferences xml defines a list of preferences the current visitor has access to Its preferences root element contains 0 or more preference elements one per preference containing the following attributes name preference name id desc description of the preference in plain English for information only value preference value if defined default value otherwise weight integer used to sort preferences of the same category lower numbers go first type preference type they are label just a label not a real preference bool boolean True or False string single line string list the supported value of the preference are listed in value elements see below bigS tring multiline string date date yyy y mm dd time time in military time hh mm rel
61. r is shared with DMA inherited if the folder is shared with DMA because one of its ancestors is false otherwise optional default false deviceHref URI of the ejectable USB storage device where the folder resides optional readOnly truelfalse true for folders that cannot be deleted copied renamed or moved and where no file or folder can be created added copied moved so far only ExternalStorage optional default false isCoreMount true false true for folders that are core mountpoints i e can only be ejected by admins so far MyLibrary Family Library MyComputers on plugs where those folders are on the eSATA drive optional default false mediafilter media type filter applied to the current directory content imagelaudio video document all folderfilter true false if false folders are filtered out nbFilteredAssets total number of children files and folder returned in the document after media type and folder filtering and paging m assetsOffset the offset from the beginning the directory listing The file root node also contains zero or more file elements one for each filtered paged child file or folder with the following attributes name name of file or directory href file or directory URI mtime last modification time in seconds since the epoch type the folder or file type folder image jaudio video document and for folders nbFolders the number of folders in the folder nbFil
62. s files assets and or directories Request HIPSERV_URL api 2 0 rest files trash lt xml version 1 0 gt lt files gt lt file href URI1 type TYPE1L gt lt file href URI2 type TYPE2 gt lt files gt Details URI URI etc are the URIs of the assets and directories to delete and TYPE1 TYP2 etc are their types Success Response Failure Responses Copy Files Copies files assets and or directories to a target directory Request HIPSERV_URLIDIRECTORY_URI URL Example http johndoe my hipserv com ap i 2 0 rest files ZmF taWx5LINhbXBsZ XM lt m nA 8 af oben PO AEs lt files gt lt file href URI1 type TYPE1 gt lt file href URI2 type TYPE2 gt lees DIRECTORY URI is the URI of the target Hip Serv directory i e the href of any file of type folder or the href of a media source see Hip Serv User Information URI URP etc are the URIs of the assets and directories to copy and TYPE1 TYP2 etc are their types Success Response a file root element containing the newly copied files a hipserv assetDetails xml document for each copied asset and a Body hipserv directoryContentstxml without children elements mediafilter folderfilder nbFilteredAssets or assetsOffset document for each copied directory Failure Responses mos fms S moa fowo OOOO Cannot copy move to self or 400 23 py to a descendant f The current visitor is
63. ser PAS S WORD is the password of the Hip Serv user Success Response HTTP Status Code 200 OK lt xml version 1 0 encoding UTF 8 gt lt sessionhandler code CODE description DESCRIPTION gt lt session hipserv HIPSERV username USERNAME auth AUTH url HIPSERV_URL I gt lt sessionhandler gt CODE DESCRIPTION can be 0 success if the login credentials were verified as correct 1 bad credentials if the Hip Serv name username or password are incorrect No specific information given to thwart account discovery attacks 2 hipserv offline if the Hip Serv is down or otherwise inaccessible from the Details client s current network location The lt session gt element will only be returned in the response if code 0 is returned HIPS ERV_URL is the complete URL prefix that the client should use to access the HipServ and takes into account open blocked ports LAN WAN access direct NAT traversal etc The AUTH is the AUTH login code which must be passed to the CPE Failure Responses 500 A ceaae Laue was a database failure looking up the login credentials or storing an AUTH login key to the database Because this action requires transmission of sensitive information Secure connection required both the password and the AUTH login key it will not proceed unless performed via SSL Create a new session for a HipServ user aka User login via the CS From an AUTH login code received from the
64. tion pdf size 481239 mtime 1285158728 gt lt file gt hipserv lightAlbumAssets x ml A hipserv lightA lbumAssets xml document is a light description of a Hip Serv album with the album s URI and theme and the list of all assets with their URI name and type Samp le Kfile href api 2 0 rest albums users am9o0bmRvZS9ITYW1wbGUgQWxidwo theme api 2 0 rest themes hipserv traw lt file name 06 Dissolved Girl mp3 type audio href api 2 0 rest albums users am9o0bmRvZS 9TYW1wbGUgQWs lt file name Paris avi type video href api 2 0 rest albums users am9obmRvZS9TYW1wbGUgQWxidWOvUGFyaXMuw lt file name paris01l jpg type image href api 2 0 rest albums users am90bmRVZS 9TYW1wbGUgQWxidWOvcGFyaXxM lt file name USER GUIDE pdf type document href api 2 0 rest albums users am9obmRvZS 9TYW1wbGUgQWxidWw0v lt file gt 1 hipserv albumRequest x ml A hipserv albumRequest xml document is an XML document with a file root element with the following attributes name album name type folder caption album caption descrip tion p aragrap h optional theme theme URI canDownload true false can gallery visitors download files from this albums The root file element can contain a single sharing element with 1 to 4 share elements each with a different with attribute Attributes of the share elements are m with with whom the album is shared dma public family contacts m until until when the album is shared
65. tivity but this number is branding dependent REST Web Services API Overview All requests are GET POST PUT or DELETE HTTP requests and most of them return XML The body of POST and PUT requests contain XML as well It is assumed that all XML will be properly formed and encoded as UTF 8 Success responses are returned with status code 2xx Failure responses are returned with status code 4xx or 5xx Status codes 401 mean that access is unauthorized Status codes 403 mean that access is forbidden Status code 400 is used to report all other errors with a response of the following format known as hipserv errors xml 1 K xml version 1 0 gt Kerrors gt lt error code c msg m gt K errors gt l Where c is the error code positive or negative and m is an error message in English optional Note in this document code 400 c means status code 400 with error code c For example Get Server Configuration can only return a failure with status code 400 and code 4 I O Error Flex mode To accommodate Flex s weak HTTP support limited to GET and POST HTTP methods status code other than 200 considered as an error no ability to set HTTP request headers no ability to get the status code or body of an error response a Flex mode was added to the API It is enabled for all Web Service requests containing a method query parameter In that case the method in the query string overrides the method in the HTTP request
66. ty media type color value ffffff gt lt ruler color gt 1 lt style property ruler color value 7b7a6be gt lt styles gt I lt theme gt 1 The styles are those used by the HTML mobile UI They can be used by other UIs or be ignored hipserv albumListing x ml A hipserv albumListing xml document is an XML document with a file root element with the following attributes name listing name href listing URI type folder parentHref 0 empty string nbFolders number of albums in the listing nbFiles 0 mediafilter a11 folderfilter true nbFilteredAssets same as nbFolders The root element contains 0 or more file elements each describing an album they contain the following attributes name album name type folder href album URI canDownload true false can gallery visitors download files from this albums theme theme URI themeld theme ID caption album caption optional nbFiles approximate number of assets in the album Each album can contain a single sharing element with 1 to 4 share elements each with a different with attribute Attributes of the share elements are m with with whom the album is shared dma public family contacts until until when the album is shared YYYY M M DD optional not for dma withPassword do contacts require to type a password to see the album optional true if present only for contacts lt share with contacts gt el
67. ublic family contacts m until until when the album is shared YYYY MM DD optional not for dma withPassword do contacts require to type a password to see the album optional true if present only for contacts lt share with contacts gt elements must contain 1 or more contact elements each with the href email address and Display Name of the contact in the contact attribute If the album is linked with any 3rd party services i e Flickr or Facebook an externalServices element will be present containing the list of services that are linked see sample The root file element can contain 0 or more file elements following the same pattern as those in hip serv directory Contents xml lt xml version 1 0 gt file name Sample Album href api 2 0 rest albums users am9obmRvZS9ITYW1lwbGUgQWxidwo type folder parentHref api 2 0 rest albums users am9o0bmRvZQ nbFolders 0 nbFiles 4 caption Here is the sample album theme api 2 0 rest themes hipserv travel themelId hipservTravel ownerFullName John Doe canDownload true publicShareURL http www myhipserv com share johndoe share johndoe Sample 20Album coverURI api 2 0 rest albums users am9obmRvZS 9TYW1wbGUgQWxidWO0vcGFyaXMwMS5qcGc RSS20URL http www myhipserv com feeds johndoe api 2 0 rest albums users am9obmRVvZS9TYW1wbGUgQWxidWG mediafilter all folderfilter false nbFilteredAssets 4 assetsOffset 0 gt lt sharing gt lt share with dma gt

HipServ Web Services API v0.1

Contents

Download Pdf Manuals

Related Search

Related Contents