Favorites

Get favorites

getFavorites Authentication needed Frontend needs to be restricted or open

Get a user's favorites. It uses your authentification token to find the right user's favorites.

Request
{
    filter: 'Dragon Ball', // Search words to filter the results with.
    from: 0, // Results to start from
    size: 400, // Number of results to return   
}

See getKaras response
Response
{
    code: 500,
    message: {
        code: 'FAVORITES_VIEW_ERROR'
    }
}

Get favorites (micro)

getFavoritesMicro Authentication needed Frontend needs to be restricted or open

Get a user's favorites with minimal information. It uses your authentification token to find the right user's favorites.

Request
{
    from: 0, // Results to start from
    size: 400, // Number of results to return    
}

If user is a guest, it returns an empty array.

Response
[
    {kid: '2fed9947-a1b4-4a36-b8da-0e417d2b8ee6'},
    {kid: '86221fc3-2b71-4e9e-8fbb-4aa39923452a'},
    {kid: '39c1d4d6-26e0-422d-9e29-971eb3b015d6'}
]
Response
{
    code: 500,
    message: {
        code: 'FAVORITES_VIEW_ERROR'
    }
}

Add favorites

addFavorites Operator user required Frontend needs to be open

Add favorites to your favorites list

Request
{
    kids: [
        '2fed9947-a1b4-4a36-b8da-0e417d2b8ee6',
        '86221fc3-2b71-4e9e-8fbb-4aa39923452a',
        '39c1d4d6-26e0-422d-9e29-971eb3b015d6'
    ]
}

Call just resolves.
Response
{
    code: 500,
    message: {
        code: 'FAVORITES_ADDED_ERROR'
    }
}

Remove favorites

deleteFavorites Operator user required Frontend needs to be open

Remove favorites from your list

Request
{
    kids: [
        '2fed9947-a1b4-4a36-b8da-0e417d2b8ee6',
        '86221fc3-2b71-4e9e-8fbb-4aa39923452a',
        '39c1d4d6-26e0-422d-9e29-971eb3b015d6'
    ]
}

Call just resolves.
Response
{
    code: 500,
    message: {
        code: 'FAVORITES_DELETED_ERROR'
    }
}

Export favorites

exportFavorites Normal user required Frontend needs to be restricted or open

Export your favorites in a JSON format

No parameters needed, username will be decided from your authorization token

Response
{
  Header: { version: 1, description: 'Karaoke Mugen Favorites List File' },
  Favorites: [
    {
      kid: '54171ae9-4de8-48fe-bd0e-fc73fc68a9d6',
      title: 'Open your Mind',
      songorder: null,
      serie: 'Aa! Megami-sama! (2005)',
      songtype: 'OP',
      language: 'jpn'
    },
    ...
  ]
}
Response
{
    code: 500,
    message: {
        code: 'FAVORITES_EXPORTED_ERROR'
    }
}

Import favorites

importFavorites Normal user required Frontend needs to be restricted or open

Import your favorites from a JSON data file

Request
{
  favorites: {
    Header: { version: 1, description: 'Karaoke Mugen Favorites List File' },
    Favorites: [
        {
        kid: '54171ae9-4de8-48fe-bd0e-fc73fc68a9d6',
        title: 'Open your Mind',
        songorder: null,
        serie: 'Aa! Megami-sama! (2005)',
        songtype: 'OP',
        language: 'jpn'
        },
        ...
    ]
  }
}
Response
{
  code: 200:
  message: {
      code: 'FAVORITES_IMPORTED'
  }
}
Response
{
    code: 500,
    message: {
        code: 'FAVORITES_IMPORTED_ERROR'
    }
}

Sent when request data is not JSON.

Response
{
    code: 400
}
Authentication Karaokes