View source

== Overview ==

MeeMix Web Service enables partners to synchronize their own media libraries with the MeeMix database, and subsequently suggest musical recommendations and playlists to their users, whether unregistered or registered users. 


Once the partner has [[lib.create|created]] their media libraries and [[lib.submitTrack|submitted music]] (synchronizing with MeeMix database), the web service allows two modes of operation: 

1. '''Single Request Discovery Mode''' (for your unregistered users): suggest recommendations or a one-time playlist to an unknown user. User information and history are not saved in the MeeMix database. Tracks are suggested based on musical DNA similarity only. Should be used for unregistered guests or unrecognized users.

2. '''Taste Prediction and Discovery Mode''' (personalized, for your registered users): suggest personalized recommendations or playlists to a known and recognized user. Track and artist personalized recommendations are suggested based on musical DNA similarity and user information/history. User information and playlists are saved in MeeMix, thus allowing for continued and more precise recommendations over time. 


MeeMix Web Service exposes SOAP and REST API in two environments: 

1. Test and Integration Environment, endpoint:  http://ws.shadow.meemix.com:8080/mxws/services/mxws

2. Production Environment, endpoint: http://ws.meemix.com:8080/mxws/services/mxws


WSDL file: http://ws.shadow.meemix.com:8080/mxws/services/mxws?wsdl


== Web Service Data Types ==

* [[Playlist Data Type|Playlist]]
* [[Track Data Type|Track]]
* [[Link Data Type|Link]]
* [[Artist Data Type|Artist]]
* [[Album Data Type|Album]]
* [[artistSuggestions Data Type|Artist Suggestions]]
* [[trackSuggestions Data Type|Track Suggestions]]


== Web Service Modes and Operations ==

=== Build your media library (synchronizing with MeeMix) ===

* [[lib.create]]
Creates a new media library in MeeMix (a partner can create several libraries). 
* [[lib.submitTrack]]
Submits a track to a media library.
* [[lib.deleteTrack]]
Delete a track from a media library.
* [[lib.trackStatus]]
Check submitted track status.
* [[lib.submitArtistLinks]]
Attaches [[Link Data Type|links]] to a previously-submitted artist using the [[lib.submitTrack]].

=== Single Request Discovery Mode (for your unregistered users) ===

* [[similar.getArtistsByArtist]]
Searches for standalone artist recommendations according to a given artist name or MeeMix artist ID. Recommendations are based on musical DNA similarity.
* [[similar.getTracksByArtist]]
Searches for standalone track recommendations according to a given artist name or MeeMix artist ID. Recommendations are based on musical DNA similarity.
* [[similar.getTracksByTrack]]
Searches for standalone track recommendations according to a given track name or MeeMix track ID. Recommendations are based on musical DNA similarity.


=== Taste Prediction and Discovery Mode (for your registered users) ===
==== User operations ====
* [[user.register]]
Registers a user from a partner in the MeeMix database using your assigned partner ID and a unique (in your partner namespace) user ID.
* [[user.getPlaylists]]
Retrieves the user`s personalized playlists.
* [[user.createPlaylistByArtist]]
Creates a personalized playlist based on artist name or by MeeMix artist ID.
* [[user.createPlaylistByTrack]]
Creates a personalized playlist based on track name or by MeeMix track ID.
* [[user.deletePlaylist]]
Deletes a user personalized playlist (previously created with the user.createPlaylistBy* operations).
* [[user.setTrackAction]]
Notifies MeeMix about an action a specific user took regrading a specific track (purchased track, downloaded its ringtone etc.)
* [[user.getTracks]]
Retrieves personalized track recommendations for a specific user.
* [[user.getFavoriteTracks]]
Retrieves a specific user's favorite tracks.
* [[user.setArtistAction]]
Notifies MeeMix about an action a specific user took regrading a specific artist (e.g, searched for artist event).
* [[user.getArtists]]
Retrieves personalized artist recommendations for a specific user.
* [[user.getFavoriteArtists]]
Retrieves a specific user's favorite artists.

==== Personalized playlist operations ====
* [[playlist.getTrack]]
Requests the next track on a user`s personalized playlist. 
* [[playlist.rateTrack]]
Rates a track previously provided by the [[playlist.getTrack]] operation on this playlist. 
* [[playlist.setPulse]]
Sets the personalized playlist's pulse level. 
* [[playlist.setAtmo]]
Sets the personalized playlist's atmosphere. 
* [[playlist.setSurprise]]
Sets the personalized playlist's surprise (exploration) level. 
* [[playlist.blockTrack]]
Blocks a specific track on this personalized playlist from playing for a period of time. 
* [[playlist.blockArtist]]
Blocks a specific artist on this personalized playlist from playing for a period of time. 
* [[playlist.unblockTrack]]
Unblocks a previously blocked track. 
* [[playlist.unblockArtist]]
Unblocks a previously blocked artist. 
* [[playlist.addTrack]]
Adds a track to the personalized playlist. 
* [[playlist.addArtist]]
Adds an artist to the personalized playlist.