Info

Welcome to the generated API reference. Get Postman Collection

AnalyticsController

Longer description

storeEvent

store the events in mongodb for our analytics. The values passed are 'event' (for example 'open_song') and the 'url' of the page where is generated for 'play', 'pause', 'stop' and seek events let's store also the 'position' this function can be called also from mobile api

Example request:

curl "http://yalp.dev/api/store_event" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/store_event",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/store_event

QuoteController

Longer description

getRandomQuote

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/get-random-quote" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/get-random-quote",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "error": "Unauthenticated."
}

HTTP Request

GET api/get-random-quote

HEAD api/get-random-quote

RegionalController

Longer description

getCountries

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/get-countries" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/get-countries",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "error": "Unauthenticated."
}

HTTP Request

GET api/get-countries

HEAD api/get-countries

RegisterController

Longer description

api/create-account

Example request:

curl "http://yalp.dev/api/create-account" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/create-account",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/create-account

ResetPasswordController

Longer description

api/forgot-password

Example request:

curl "http://yalp.dev/api/forgot-password" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/forgot-password",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/forgot-password

SongController

Longer description

getPlaylist

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/playlist" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/playlist",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/playlist

HEAD api/playlist

getRandomYoutubeApiTracks

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/random-youtube-tracks" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/random-youtube-tracks",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "error": "Unauthenticated."
}

HTTP Request

GET api/random-youtube-tracks

HEAD api/random-youtube-tracks

searchTrackYalp

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/search-track" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/search-track",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/search-track

getSongInfoForPlay

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/get-song-info/{token}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/get-song-info/{token}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "error": "Unauthenticated."
}

HTTP Request

GET api/get-song-info/{token}

HEAD api/get-song-info/{token}

addSongPlaylist

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/add-song-playlist/{token}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/add-song-playlist/{token}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/add-song-playlist/{token}

HEAD api/add-song-playlist/{token}

removeSongPlaylist

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/remove-song-playlist/{token}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/remove-song-playlist/{token}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/remove-song-playlist/{token}

HEAD api/remove-song-playlist/{token}

updatePlaylist

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/update-playlist" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/update-playlist",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/update-playlist

transcribeSong

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/transcribe-song/{youtube_video_id}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/transcribe-song/{youtube_video_id}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "error": "Unauthenticated."
}

HTTP Request

GET api/transcribe-song/{youtube_video_id}

HEAD api/transcribe-song/{youtube_video_id}

checkTranscribeProgress

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/transcribe-progress/{token}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/transcribe-progress/{token}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "error": "Unauthenticated."
}

HTTP Request

GET api/transcribe-progress/{token}

HEAD api/transcribe-progress/{token}

printSheet

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/print-sheet/{token}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/print-sheet/{token}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "error": "Unauthenticated."
}

HTTP Request

GET api/print-sheet/{token}

HEAD api/print-sheet/{token}

transposeSong

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/transpose" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/transpose",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/transpose

UserController

Longer description

authFromFacebook

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/facebook-login" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/facebook-login",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/facebook-login

saveProfile

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/save-user-profile" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/save-user-profile",
    "method": "POST",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST api/save-user-profile

getProfile

This can be an optional longer description of your API call, used within the documentation.

Example request:

curl "http://yalp.dev/api/get-user-profile" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://yalp.dev/api/get-user-profile",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

null

HTTP Request

GET api/get-user-profile

HEAD api/get-user-profile