5.0.0 • Published 5 years ago

@datafire/vocadb v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/vocadb

Client library for VocaDB

Installation and Usage

npm install --save @datafire/vocadb
let vocadb = require('@datafire/vocadb').create();

.then(data => {
  console.log(data);
});

Description

Actions

ActivityEntryApi_GetList

Entries are always returned sorted from newest to oldest. Activity for deleted entries is not returned.

vocadb.ActivityEntryApi_GetList({}, context)

Input

  • input object
    • before string: Filter to return activity entries only before this date. Optional, by default no filter.
    • since string: Filter to return activity entries only after this date. Optional, by default no filter.
    • userId integer: Filter by user Id. Optional, by default no filter.
    • editEvent string (values: Created, Updated, Deleted, Restored): Filter by entry edit event (either Created or Updated). Optional, by default no filter.
    • entryType string (values: Undefined, Album, Artist, DiscussionTopic, PV, ReleaseEvent, ReleaseEventSeries, Song, SongList, Tag, User, Venue): Entry type. Optional.
    • maxResults integer: Maximum number of results to return. Default 50. Maximum value 500.
    • getTotalCount boolean: Whether to load total number of items (optional, default to false).
    • fields string (values: None, ArchivedVersion, Entry): Optional fields.
    • entryFields string (values: None, AdditionalNames, Description, MainPicture, Names, PVs, Tags, WebLinks): Optional fields for entries.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference. Optional.
    • sortRule string (values: CreateDateDescending, CreateDate): Sort rule. Optional.

Output

AlbumApi_GetList

Gets a page of albums.

vocadb.AlbumApi_GetList({}, context)

Input

  • input object
    • query string: Album name query (optional).
    • discTypes string (values: Unknown, Album, Single, EP, SplitAlbum, Compilation, Video, Artbook, Game, Fanmade, Instrumental, Other): Disc type. By default nothing. Possible values are Album, Single, EP, SplitAlbum, Compilation, Video, Other. Note: only one type supported for now.
    • tagName array: Filter by tag name (optional). This filter can be specified multiple times.
    • tagId array: Filter by tag Id (optional). This filter can be specified multiple times.
    • childTags boolean: Include child tags, if the tags being filtered by have any.
    • artistId array: Filter by artist Id (optional).
    • artistParticipationStatus string (values: Everything, OnlyMainAlbums, OnlyCollaborations): Filter by artist participation status. Only valid if artistId is specified.
    • childVoicebanks boolean: Include child voicebanks, if the artist being filtered by has any.
    • includeMembers boolean: Include members of groups. This applies if {artistId} is a group.
    • barcode string: Filter by album barcode (optional).
    • status string (values: Draft, Finished, Approved, Locked): Filter by entry status (optional).
    • releaseDateAfter string: Filter by albums whose release date is after this date (inclusive).
    • releaseDateBefore string: Filter by albums whose release date is before this date (exclusive).
    • advancedFilters array: List of advanced filters (optional).
    • start integer: First item to be retrieved (optional, defaults to 0).
    • maxResults integer: Maximum number of results to be loaded (optional, defaults to 10, maximum of 50).
    • getTotalCount boolean: Whether to load total number of items (optional, default to false).
    • sort string (values: None, Name, ReleaseDate, ReleaseDateWithNulls, AdditionDate, RatingAverage, RatingTotal, NameThenReleaseDate, CollectionCount): Sort rule (optional, defaults to Name).
    • preferAccurateMatches boolean: Whether the search should prefer accurate matches.
    • deleted boolean: Whether to search for deleted entries.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Match mode for artist name (optional, defaults to Exact).
    • fields string (values: None, AdditionalNames, Artists, Description, Discs, Identifiers, MainPicture, Names, PVs, ReleaseEvent, Tags, Tracks, WebLinks): Optional fields (optional). Possible values are artists, names, pvs, tags, tracks, webLinks.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

AlbumApi_DeleteComment

Normal users can delete their own comments, moderators can delete all comments. Requires login.

vocadb.AlbumApi_DeleteComment({
  "commentId": 0
}, context)

Input

  • input object
    • commentId required integer: ID of the comment to be deleted.

Output

Output schema unknown

AlbumApi_PostEditComment

Normal users can edit their own comments, moderators can edit all comments. Requires login.

vocadb.AlbumApi_PostEditComment({
  "commentId": 0,
  "contract": {}
}, context)

Input

  • input object

Output

Output schema unknown

AlbumApi_GetNames

Gets a list of album names. Ideal for autocomplete boxes.

vocadb.AlbumApi_GetNames({}, context)

Input

  • input object
    • query string: Text query.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Name match mode.
    • maxResults integer: Maximum number of results.

Output

  • output array
    • items string

AlbumApi_GetNewAlbums

Output is cached for 1 hour.

vocadb.AlbumApi_GetNewAlbums({}, context)

Input

  • input object
    • languagePreference string (values: Default, Japanese, Romaji, English)
    • fields string (values: None, AdditionalNames, Artists, Description, Discs, Identifiers, MainPicture, Names, PVs, ReleaseEvent, Tags, Tracks, WebLinks)

Output

AlbumApi_GetTopAlbums

Output is cached for 1 hour.

vocadb.AlbumApi_GetTopAlbums({}, context)

Input

  • input object
    • ignoreIds array
    • languagePreference string (values: Default, Japanese, Romaji, English)
    • fields string (values: None, AdditionalNames, Artists, Description, Discs, Identifiers, MainPicture, Names, PVs, ReleaseEvent, Tags, Tracks, WebLinks)

Output

AlbumApi_Delete

Deletes an album.

vocadb.AlbumApi_Delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: ID of the album to be deleted.
    • notes string: Notes.

Output

Output schema unknown

AlbumApi_GetOne

Gets an album by Id.

vocadb.AlbumApi_GetOne({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Album Id (required).
    • fields string (values: None, AdditionalNames, Artists, Description, Discs, Identifiers, MainPicture, Names, PVs, ReleaseEvent, Tags, Tracks, WebLinks): Optional fields (optional). Possible values are artists, names, pvs, tags, tracks, webLinks.
    • songFields string (values: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks): Optional fields for tracks, if included (optional).
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

AlbumApi_GetComments

Pagination and sorting might be added later.

vocadb.AlbumApi_GetComments({
  "id": 0
}, context)

Input

  • input object
    • id required integer: ID of the album whose comments to load.

Output

AlbumApi_PostNewComment

Posts a new comment.

vocadb.AlbumApi_PostNewComment({
  "id": 0,
  "contract": {}
}, context)

Input

  • input object
    • id required integer: ID of the album for which to create the comment.
    • contract required CommentForApiContract

Output

AlbumApi_GetReviews

vocadb.AlbumApi_GetReviews({
  "id": 0
}, context)

Input

  • input object
    • id required integer
    • languageCode string

Output

AlbumApi_PostReview

vocadb.AlbumApi_PostReview({
  "id": 0,
  "reviewContract": {}
}, context)

Input

Output

AlbumApi_DeleteReview

vocadb.AlbumApi_DeleteReview({
  "reviewId": 0,
  "id": ""
}, context)

Input

  • input object
    • reviewId required integer
    • id required string

Output

Output schema unknown

AlbumApi_GetTracks

Gets tracks for an album.

vocadb.AlbumApi_GetTracks({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Album ID (required).
    • fields string (values: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks): List of optional fields (optional). Possible values are Albums, Artists, Names, PVs, Tags, ThumbUrl, WebLinks.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

AlbumApi_GetTracksFields

vocadb.AlbumApi_GetTracksFields({
  "id": 0
}, context)

Input

  • input object
    • id required integer
    • field array
    • discNumber integer
    • lang string (values: Default, Japanese, Romaji, English)

Output

  • output array
    • items object

AlbumApi_GetUserCollections

vocadb.AlbumApi_GetUserCollections({
  "id": 0
}, context)

Input

  • input object
    • id required integer
    • languagePreference string (values: Default, Japanese, Romaji, English)

Output

ArtistApi_GetList

Find artists.

vocadb.ArtistApi_GetList({}, context)

Input

  • input object
    • query string: Artist name query (optional).
    • artistTypes string: Filtered artist type (optional).
    • allowBaseVoicebanks boolean: Allow base voicebanks. If false, only root voicebanks will be allowed. Only affects voice synthesizers that can have base voicebanks.
    • tagName array: Filter by tag name (optional).
    • tagId array: Filter by tag Id (optional). This filter can be specified multiple times.
    • childTags boolean: Include child tags, if the tags being filtered by have any.
    • followedByUserId integer: Filter by user following the artists. By default there is no filtering.
    • status string (values: Draft, Finished, Approved, Locked): Filter by entry status (optional).
    • advancedFilters array: List of advanced filters (optional).
    • start integer: First item to be retrieved (optional, defaults to 0).
    • maxResults integer: Maximum number of results to be loaded (optional, defaults to 10, maximum of 100).
    • getTotalCount boolean: Whether to load total number of items (optional, default to false).
    • sort string (values: None, Name, AdditionDate, AdditionDateAsc, ReleaseDate, SongCount, SongRating, FollowerCount): Sort rule (optional, defaults to Name). Possible values are None, Name, AdditionDate, AdditionDateAsc.
    • preferAccurateMatches boolean: Whether the search should prefer accurate matches.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Match mode for artist name (optional, defaults to Exact).
    • fields string (values: None, AdditionalNames, ArtistLinks, ArtistLinksReverse, BaseVoicebank, Description, MainPicture, Names, Tags, WebLinks): List of optional fields (optional). Possible values are Description, Groups, Members, Names, Tags, WebLinks.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

ArtistApi_DeleteComment

Normal users can delete their own comments, moderators can delete all comments. Requires login.

vocadb.ArtistApi_DeleteComment({
  "commentId": 0
}, context)

Input

  • input object
    • commentId required integer: ID of the comment to be deleted.

Output

Output schema unknown

ArtistApi_PostEditComment

Normal users can edit their own comments, moderators can edit all comments. Requires login.

vocadb.ArtistApi_PostEditComment({
  "commentId": 0,
  "contract": {}
}, context)

Input

  • input object

Output

Output schema unknown

ArtistApi_GetNames

Gets a list of artist names. Ideal for autocomplete boxes.

vocadb.ArtistApi_GetNames({}, context)

Input

  • input object
    • query string: Text query.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Name match mode.
    • maxResults integer: Maximum number of results.

Output

  • output array
    • items string

ArtistApi_Delete

Deletes an artist.

vocadb.ArtistApi_Delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: ID of the artist to be deleted.
    • notes string: Notes.

Output

Output schema unknown

ArtistApi_GetOne

Gets an artist by Id.

vocadb.ArtistApi_GetOne({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Artist ID (required).
    • fields string (values: None, AdditionalNames, ArtistLinks, ArtistLinksReverse, BaseVoicebank, Description, MainPicture, Names, Tags, WebLinks): List of optional fields (optional). Possible values are Description, Groups, Members, Names, Tags, WebLinks.
    • relations string (values: None, LatestAlbums, LatestEvents, LatestSongs, PopularAlbums, PopularSongs, All): List of artist relations (optional). Possible values are LatestAlbums, PopularAlbums, LatestSongs, PopularSongs, All
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

ArtistApi_GetComments

Pagination and sorting might be added later.

vocadb.ArtistApi_GetComments({
  "id": 0
}, context)

Input

  • input object
    • id required integer: ID of the artist whose comments to load.

Output

ArtistApi_PostNewComment

Posts a new comment.

vocadb.ArtistApi_PostNewComment({
  "id": 0,
  "contract": {}
}, context)

Input

  • input object
    • id required integer: ID of the artist for which to create the comment.
    • contract required CommentForApiContract

Output

CommentApi_GetComments

Gets a list of comments for an entry.

vocadb.CommentApi_GetComments({
  "entryType": "",
  "entryId": 0
}, context)

Input

  • input object
    • entryType required string (values: Undefined, Album, Artist, DiscussionTopic, PV, ReleaseEvent, ReleaseEventSeries, Song, SongList, Tag, User, Venue): Entry type.
    • entryId required integer: ID of the entry whose comments to load.

Output

CommentApi_PostNewComment

Posts a new comment.

vocadb.CommentApi_PostNewComment({
  "entryType": "",
  "contract": {}
}, context)

Input

  • input object
    • entryType required string (values: Undefined, Album, Artist, DiscussionTopic, PV, ReleaseEvent, ReleaseEventSeries, Song, SongList, Tag, User, Venue): Entry type.
    • contract required CommentForApiContract

Output

CommentApi_DeleteComment

Normal users can delete their own comments, moderators can delete all comments. Requires login.

vocadb.CommentApi_DeleteComment({
  "entryType": "",
  "commentId": 0
}, context)

Input

  • input object
    • entryType required string (values: Undefined, Album, Artist, DiscussionTopic, PV, ReleaseEvent, ReleaseEventSeries, Song, SongList, Tag, User, Venue): Entry type.
    • commentId required integer: ID of the comment to be deleted.

Output

Output schema unknown

CommentApi_PostEditComment

Normal users can edit their own comments, moderators can edit all comments. Requires login.

vocadb.CommentApi_PostEditComment({
  "entryType": "",
  "commentId": 0,
  "contract": {}
}, context)

Input

  • input object
    • entryType required string (values: Undefined, Album, Artist, DiscussionTopic, PV, ReleaseEvent, ReleaseEventSeries, Song, SongList, Tag, User, Venue): Entry type.
    • commentId required integer: ID of the comment to be edited.
    • contract required CommentForApiContract

Output

Output schema unknown

DiscussionApi_DeleteComment

vocadb.DiscussionApi_DeleteComment({
  "commentId": 0
}, context)

Input

  • input object
    • commentId required integer

Output

Output schema unknown

DiscussionApi_PostEditComment

vocadb.DiscussionApi_PostEditComment({
  "commentId": 0,
  "contract": {}
}, context)

Input

Output

Output schema unknown

DiscussionApi_GetFolders

vocadb.DiscussionApi_GetFolders({}, context)

Input

  • input object
    • fields string (values: None, LastTopic, TopicCount)

Output

DiscussionApi_PostNewFolder

vocadb.DiscussionApi_PostNewFolder({
  "contract": {}
}, context)

Input

Output

DiscussionApi_GetTopicsForFolder

vocadb.DiscussionApi_GetTopicsForFolder({
  "folderId": 0
}, context)

Input

  • input object
    • folderId required integer
    • fields string (values: None, Comments, CommentCount, Content, LastComment, All)

Output

DiscussionApi_PostNewTopic

vocadb.DiscussionApi_PostNewTopic({
  "folderId": 0,
  "contract": {}
}, context)

Input

Output

DiscussionApi_GetTopics

vocadb.DiscussionApi_GetTopics({}, context)

Input

  • input object
    • folderId integer
    • start integer
    • maxResults integer
    • getTotalCount boolean
    • sort string (values: None, Name, DateCreated, LastCommentDate)
    • fields string (values: None, Comments, CommentCount, Content, LastComment, All)

Output

DiscussionApi_DeleteTopic

vocadb.DiscussionApi_DeleteTopic({
  "topicId": 0
}, context)

Input

  • input object
    • topicId required integer

Output

Output schema unknown

DiscussionApi_GetTopic

vocadb.DiscussionApi_GetTopic({
  "topicId": 0
}, context)

Input

  • input object
    • topicId required integer
    • fields string (values: None, Comments, CommentCount, Content, LastComment, All)

Output

DiscussionApi_PostEditTopic

vocadb.DiscussionApi_PostEditTopic({
  "topicId": 0,
  "contract": {}
}, context)

Input

Output

Output schema unknown

DiscussionApi_PostNewComment

vocadb.DiscussionApi_PostNewComment({
  "topicId": 0,
  "contract": {}
}, context)

Input

Output

EntryApi_GetList

Find entries.

vocadb.EntryApi_GetList({}, context)

Input

  • input object
    • query string: Entry name query (optional).
    • tagName array: Filter by tag name (optional).
    • tagId array: Filter by tag Id (optional).
    • childTags boolean: Include child tags, if the tags being filtered by have any.
    • entryTypes string (values: Nothing, Album, Artist, DiscussionTopic, PV, ReleaseEvent, ReleaseEventSeries, Song, SongList, Tag, User, Venue): Included entry types (optional).
    • status string (values: Draft, Finished, Approved, Locked): Filter by entry status (optional).
    • start integer: First item to be retrieved (optional, defaults to 0).
    • maxResults integer: Maximum number of results to be loaded (optional, defaults to 10, maximum of 30).
    • getTotalCount boolean: Whether to load total number of items (optional, default to false).
    • sort string (values: None, Name, AdditionDate, ActivityDate): Sort rule (optional, defaults to Name). Possible values are None, Name, AdditionDate.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Match mode for entry name (optional, defaults to Exact).
    • fields string (values: None, AdditionalNames, Description, MainPicture, Names, PVs, Tags, WebLinks): List of optional fields (optional). Possible values are Description, MainPicture, Names, Tags, WebLinks.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

EntryApi_GetNames

Gets a list of entry names. Ideal for autocomplete boxes.

vocadb.EntryApi_GetNames({}, context)

Input

  • input object
    • query string: Text query.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Name match mode.
    • maxResults integer: Maximum number of results.

Output

  • output array
    • items string

EntryTypesApi_GetMappedTag

vocadb.EntryTypesApi_GetMappedTag({
  "entryType": "",
  "subType": ""
}, context)

Input

  • input object
    • entryType required string (values: Undefined, Album, Artist, DiscussionTopic, PV, ReleaseEvent, ReleaseEventSeries, Song, SongList, Tag, User, Venue)
    • subType required string
    • fields string (values: None, AdditionalNames, AliasedTo, Description, MainPicture, Names, Parent, RelatedTags, TranslatedDescription, WebLinks)

Output

PVApi_GetList

Gets a list of PVs for songs.

vocadb.PVApi_GetList({}, context)

Input

  • input object
    • name string: PV title (optional).
    • author string: Uploader name (optional).
    • service string (values: NicoNicoDouga, Youtube, SoundCloud, Vimeo, Piapro, Bilibili, File, LocalFile, Creofuga, Bandcamp): PV service (optional).
    • maxResults integer: Maximum number of results.
    • getTotalCount boolean: Whether to load total number of items (optional, default to false).
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

ReleaseEventSeriesApi_GetList

Gets a page of event series.

vocadb.ReleaseEventSeriesApi_GetList({}, context)

Input

  • input object
    • query string: Text query.
    • fields string (values: None, AdditionalNames, Description, Events, MainPicture, Names, WebLinks): Optional fields to include.
    • start integer: First item to be retrieved (optional).
    • maxResults integer: Maximum number of results to be loaded (optional).
    • getTotalCount boolean: Whether to load total number of items (optional).
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Match mode for event name (optional).
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

ReleaseEventSeriesApi_Delete

Deletes an event series.

vocadb.ReleaseEventSeriesApi_Delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: ID of the series to be deleted.
    • notes string: Notes.
    • hardDelete boolean: If true, the entry is hard deleted. Hard deleted entries cannot be restored normally, but they will be moved to trash.

Output

Output schema unknown

ReleaseEventSeriesApi_GetOne

Gets single event series by ID.

vocadb.ReleaseEventSeriesApi_GetOne({
  "id": 0
}, context)

Input

  • input object
    • id required integer
    • fields string (values: None, AdditionalNames, Description, Events, MainPicture, Names, WebLinks)
    • lang string (values: Default, Japanese, Romaji, English)

Output

ReleaseEventApi_GetList

Gets a page of events.

vocadb.ReleaseEventApi_GetList({}, context)

Input

  • input object
    • query string: Event name query (optional).
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Match mode for event name (optional, defaults to Auto).
    • seriesId integer: Filter by series Id.
    • afterDate string: Filter by events after this date (inclusive).
    • beforeDate string: Filter by events before this date (exclusive).
    • category string (values: Unspecified, AlbumRelease, Anniversary, Club, Concert, Contest, Convention, Other): Filter by event category.
    • userCollectionId integer: Filter to include only events in user's events (interested or attending).
    • tagId array: Filter by one or more tag Ids (optional).
    • childTags boolean: Include child tags, if the tags being filtered by have any.
    • artistId array: Filter by artist Id.
    • childVoicebanks boolean: Include child voicebanks, if the artist being filtered by has any.
    • includeMembers boolean: Include members of groups. This applies if {artistId} is a group.
    • status string (values: Draft, Finished, Approved, Locked): Filter by entry status.
    • start integer: First item to be retrieved (optional, defaults to 0).
    • maxResults integer: Maximum number of results to be loaded (optional, defaults to 10).
    • getTotalCount boolean: Whether to load total number of items (optional, default to false).
    • sort string (values: None, Name, Date, AdditionDate, SeriesName, VenueName): Sort rule (optional, defaults to Name).
    • fields string (values: None, AdditionalNames, Artists, Description, MainPicture, Names, Series, SongList, Tags, Venue, WebLinks): Optional fields (optional). Possible values are Description, Series.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference.

Output

ReleaseEventApi_GetNames

Find event names by a part of name.

        Matching is done anywhere from the name.
vocadb.ReleaseEventApi_GetNames({}, context)

Input

  • input object
    • query string: Event name query, for example "Voc@loid".
    • maxResults integer: Maximum number of search results.

Output

  • output array
    • items string

ReleaseEventApi_GetAlbums

Gets a list of albums for a specific event.

vocadb.ReleaseEventApi_GetAlbums({
  "eventId": 0
}, context)

Input

  • input object
    • eventId required integer: Release event ID.
    • fields string (values: None, AdditionalNames, Artists, Description, Discs, Identifiers, MainPicture, Names, PVs, ReleaseEvent, Tags, Tracks, WebLinks): List of optional album fields.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference.

Output

ReleaseEventApi_GetPublishedSongs

Gets a list of songs for a specific event.

vocadb.ReleaseEventApi_GetPublishedSongs({
  "eventId": 0
}, context)

Input

  • input object
    • eventId required integer: Event ID.
    • fields string (values: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks): List of optional song fields.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference.

Output

ReleaseEventApi_PostReport

Creates a new report.

vocadb.ReleaseEventApi_PostReport({
  "eventId": 0,
  "reportType": "",
  "notes": "",
  "versionNumber": 0
}, context)

Input

  • input object
    • eventId required integer: Event to be reported.
    • reportType required string (values: InvalidInfo, Duplicate, Inappropriate, Other): Report type.
    • notes required string: Notes. Optional.
    • versionNumber required integer: Version to be reported. Optional.

Output

Output schema unknown

ReleaseEventApi_Delete

Deletes an event.

vocadb.ReleaseEventApi_Delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: ID of the event to be deleted.
    • notes string: Notes.
    • hardDelete boolean: If true, the entry is hard deleted. Hard deleted entries cannot be restored normally, but they will be moved to trash.

Output

Output schema unknown

ReleaseEventApi_GetOne

vocadb.ReleaseEventApi_GetOne({
  "id": 0
}, context)

Input

  • input object
    • id required integer
    • fields string (values: None, AdditionalNames, Artists, Description, MainPicture, Names, Series, SongList, Tags, Venue, WebLinks)
    • lang string (values: Default, Japanese, Romaji, English)

Output

ResourcesApi_GetList

Gets a number of resource sets for a specific culture.

vocadb.ResourcesApi_GetList({
  "cultureCode": "",
  "setNames": []
}, context)

Input

  • input object
    • cultureCode required string: Culture code, for example "en-US" or "fi-FI".
    • setNames required array: Names of resource sets to be returned. More than one value can be specified. For example "artistTypeNames"

Output

  • output object

SongListApi_Post

Creates a song list.

vocadb.SongListApi_Post({
  "list": {}
}, context)

Input

Output

  • output integer

SongListApi_DeleteComment

Normal users can delete their own comments, moderators can delete all comments. Requires login.

vocadb.SongListApi_DeleteComment({
  "commentId": 0
}, context)

Input

  • input object
    • commentId required integer: ID of the comment to be deleted.

Output

Output schema unknown

SongListApi_PostEditComment

Normal users can edit their own comments, moderators can edit all comments. Requires login.

vocadb.SongListApi_PostEditComment({
  "commentId": 0,
  "contract": {}
}, context)

Input

  • input object

Output

Output schema unknown

SongListApi_GetFeaturedLists

Gets a list of featured song lists.

vocadb.SongListApi_GetFeaturedLists({}, context)

Input

  • input object
    • query string: Song list name query (optional).
    • tagId array: Filter by one or more tag Ids (optional).
    • childTags boolean: Include child tags, if the tags being filtered by have any.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Match mode for list name (optional, defaults to Auto).
    • featuredCategory string (values: Nothing, Concerts, VocaloidRanking, Pools, Other): Filter by a specific featured category. If empty, all categories are returned.
    • start integer: First item to be retrieved (optional, defaults to 0).
    • maxResults integer: Maximum number of results to be loaded (optional, defaults to 10, maximum of 50).
    • getTotalCount boolean: Whether to load total number of items (optional, default to false).
    • sort string (values: None, Name, Date, CreateDate): List sort rule. Possible values are Nothing, Date, CreateDate, Name.
    • fields string (values: None, Description, Events, MainPicture, Tags): List of optional fields (optional).
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

SongListApi_GetFeaturedListNames

Gets a list of featuedd list names. Ideal for autocomplete boxes.

vocadb.SongListApi_GetFeaturedListNames({}, context)

Input

  • input object
    • query string: Text query.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Name match mode. Words is treated the same as Partial.
    • featuredCategory string (values: Nothing, Concerts, VocaloidRanking, Pools, Other): Filter by a specific featured category. If empty, all categories are returned.
    • maxResults integer: Maximum number of results.

Output

  • output array
    • items string

SongListApi_Delete

Deletes a song list.

vocadb.SongListApi_Delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: ID of the list to be deleted.
    • notes string: Notes.
    • hardDelete boolean: If true, the entry is hard deleted. Hard deleted entries cannot be restored normally, but they will be moved to trash.

Output

Output schema unknown

SongListApi_GetComments

Gets a list of comments for a song list.

vocadb.SongListApi_GetComments({
  "listId": 0
}, context)

Input

  • input object
    • listId required integer: ID of the list whose comments to load.

Output

SongListApi_PostNewComment

Posts a new comment.

vocadb.SongListApi_PostNewComment({
  "listId": 0,
  "contract": {}
}, context)

Input

  • input object
    • listId required integer: ID of the song list for which to create the comment.
    • contract required CommentForApiContract

Output

SongListApi_GetSongs

Gets a list of songs in a song list.

vocadb.SongListApi_GetSongs({
  "listId": 0
}, context)

Input

  • input object
    • listId required integer: ID of the song list.
    • query string: Song name query (optional).
    • songTypes string: Filtered song types (optional).
    • pvServices string (values: Nothing, NicoNicoDouga, Youtube, SoundCloud, Vimeo, Piapro, Bilibili, File, LocalFile, Creofuga, Bandcamp): Filter by one or more PV services (separated by commas). The song will pass the filter if it has a PV for any of the matched services.
    • tagId array: Filter by one or more tag Ids (optional).
    • artistId array: Filter by artist Id.
    • childVoicebanks boolean: Include child voicebanks, if the artist being filtered by has any.
    • advancedFilters array: List of advanced filters (optional).
    • start integer: First item to be retrieved (optional, defaults to 0).
    • maxResults integer: Maximum number of results to be loaded (optional, defaults to 10, maximum of 50).
    • getTotalCount boolean: Whether to load total number of items (optional, default to false).
    • sort string (values: None, Name, AdditionDate, PublishDate, FavoritedTimes, RatingScore, TagUsageCount): Song sort rule (optional, by default songs are sorted by song list order).
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Match mode for song name (optional, defaults to Auto).
    • fields string (values: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks): List of optional fields (optional). Possible values are Albums, Artists, Names, PVs, Tags, ThumbUrl, WebLinks.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

SongApi_GetList

Find songs.

vocadb.SongApi_GetList({}, context)

Input

  • input object
    • query string: Song name query (optional).
    • songTypes string: Filtered song types (optional).
    • afterDate string: Filter by songs published after this date (inclusive).
    • beforeDate string: Filter by songs published before this date (exclusive).
    • tagName array: Filter by one or more tag names (optional).
    • tagId array: Filter by one or more tag Ids (optional).
    • childTags boolean: Include child tags, if the tags being filtered by have any.
    • unifyTypesAndTags boolean: When searching by song type, search by associated tag as well, and vice versa.
    • artistId array: Filter by artist Id.
    • artistParticipationStatus string (values: Everything, OnlyMainAlbums, OnlyCollaborations): Filter by artist participation status. Only valid if artistId is specified.
    • childVoicebanks boolean: Include child voicebanks, if the artist being filtered by has any.
    • includeMembers boolean: Include members of groups. This applies if {artistId} is a group.
    • onlyWithPvs boolean: Whether to only include songs with at least one PV.
    • pvServices string (values: Nothing, NicoNicoDouga, Youtube, SoundCloud, Vimeo, Piapro, Bilibili, File, LocalFile, Creofuga, Bandcamp): Filter by one or more PV services (separated by commas). The song will pass the filter if it has a PV for any of the matched services.
    • since integer: Allow only entries that have been created at most this many hours ago. By default there is no filtering.
    • minScore integer: Minimum rating score. Optional.
    • userCollectionId integer: Filter by user's rated songs. By default there is no filtering.
    • releaseEventId integer: Filter by release event. By default there is no filtering.
    • parentSongId integer: Filter by parent song. By default there is no filtering.
    • status string (values: Draft, Finished, Approved, Locked): Filter by entry status (optional).
    • advancedFilters array: List of advanced filters (optional).
    • start integer: First item to be retrieved (optional, defaults to 0).
    • maxResults integer: Maximum number of results to be loaded (optional, defaults to 10, maximum of 50).
    • getTotalCount boolean: Whether to load total number of items (optional, default to false).
    • sort string (values: None, Name, AdditionDate, PublishDate, FavoritedTimes, RatingScore, TagUsageCount): Sort rule (optional, defaults to Name). Possible values are None, Name, AdditionDate, FavoritedTimes, RatingScore.
    • preferAccurateMatches boolean: Whether the search should prefer accurate matches.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Match mode for song name (optional, defaults to Exact).
    • fields string (values: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks): List of optional fields (optional). Possible values are Albums, Artists, Names, PVs, Tags, ThumbUrl, WebLinks.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

SongApi_GetByPV

Gets a song by PV.

vocadb.SongApi_GetByPV({
  "pvService": "",
  "pvId": ""
}, context)

Input

  • input object
    • pvService required string (values: NicoNicoDouga, Youtube, SoundCloud, Vimeo, Piapro, Bilibili, File, LocalFile, Creofuga, Bandcamp): PV service (required). Possible values are NicoNicoDouga, Youtube, SoundCloud, Vimeo, Piapro, Bilibili.
    • pvId required string: PV Id (required). For example sm123456.
    • fields string (values: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks): List of optional fields (optional). Possible values are Albums, Artists, Names, PVs, Tags, ThumbUrl, WebLinks.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

SongApi_DeleteComment

Normal users can delete their own comments, moderators can delete all comments. Requires login.

vocadb.SongApi_DeleteComment({
  "commentId": 0
}, context)

Input

  • input object
    • commentId required integer: ID of the comment to be deleted.

Output

Output schema unknown

SongApi_PostEditComment

Normal users can edit their own comments, moderators can edit all comments. Requires login.

vocadb.SongApi_PostEditComment({
  "commentId": 0,
  "contract": {}
}, context)

Input

  • input object

Output

Output schema unknown

SongApi_GetHighlightedSongs

Output is cached for 1 hour.

vocadb.SongApi_GetHighlightedSongs({}, context)

Input

  • input object
    • languagePreference string (values: Default, Japanese, Romaji, English)
    • fields string (values: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks)

Output

SongApi_GetLyrics

Output is cached. Specify song version as parameter to refresh.

vocadb.SongApi_GetLyrics({
  "lyricsId": 0
}, context)

Input

  • input object
    • lyricsId required integer: Lyrics ID.

Output

SongApi_GetNames

Gets a list of song names. Ideal for autocomplete boxes.

vocadb.SongApi_GetNames({}, context)

Input

  • input object
    • query string: Text query.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Name match mode.
    • maxResults integer: Maximum number of results.

Output

  • output array
    • items string

SongApi_GetTopSongs

Gets top rated songs.

vocadb.SongApi_GetTopSongs({}, context)

Input

  • input object
    • durationHours integer: Duration in hours from which to get songs.
    • startDate string: Lower bound of the date. Optional.
    • filterBy string (values: CreateDate, PublishDate, Popularity): Filtering mode.
    • vocalist string (values: Nothing, Vocaloid, UTAU, CeVIO): Vocalist selection.
    • maxResults integer: Maximum number of results to be loaded (optional).
    • fields string (values: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks): Optional song fields to load.
    • languagePreference string (values: Default, Japanese, Romaji, English): Language preference.

Output

SongApi_Delete

Deletes a song.

vocadb.SongApi_Delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: ID of the song to be deleted.
    • notes string: Notes.

Output

Output schema unknown

SongApi_GetById

Gets a song by Id.

vocadb.SongApi_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Song Id (required).
    • fields string (values: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks): List of optional fields (optional).
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

SongApi_GetComments

Pagination and sorting might be added later.

vocadb.SongApi_GetComments({
  "id": 0
}, context)

Input

  • input object
    • id required integer: ID of the song whose comments to load.

Output

SongApi_PostNewComment

Posts a new comment.

vocadb.SongApi_PostNewComment({
  "id": 0,
  "contract": {}
}, context)

Input

  • input object
    • id required integer: ID of the song for which to create the comment.
    • contract required CommentForApiContract

Output

SongApi_GetDerived

Pagination and sorting might be added later.

vocadb.SongApi_GetDerived({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Song Id (required).
    • fields string (values: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks): List of optional fields (optional).
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

SongApi_GetRatings

The result includes ratings and user information. For users who have requested not to make their ratings public, the user will be empty.

vocadb.SongApi_GetRatings({
  "id": 0,
  "userFields": ""
}, context)

Input

  • input object
    • id required integer: Song ID.
    • userFields required string (values: None, KnownLanguages, MainPicture, OldUsernames): Optional fields for the users.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference.

Output

SongApi_PostRating

If the user has already rated the song, any previous rating is replaced. Authorization cookie must be included. This API supports CORS.

vocadb.SongApi_PostRating({
  "id": 0,
  "rating": {}
}, context)

Input

  • input object

Output

Output schema unknown

SongApi_GetRelated

Gets related songs.

vocadb.SongApi_GetRelated({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Song whose related songs are to be queried.
    • fields string (values: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks): Optional song fields.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference.

Output

TagApi_GetList

Find tags.

vocadb.TagApi_GetList({}, context)

Input

  • input object
    • query string: Tag name query (optional).
    • allowChildren boolean: Whether to allow child tags. If this is false, only root tags (that aren't children of any other tag) will be included.
    • categoryName string: Filter tags by category (optional). If specified, this must be an exact match (case insensitive).
    • start integer: First item to be retrieved (optional, defaults to 0).
    • maxResults integer: Maximum number of results to be loaded (optional, defaults to 10, maximum of 30).
    • getTotalCount boolean: Whether to load total number of items (optional, default to false).
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Match mode for song name (optional, defaults to Exact).
    • sort string (values: Nothing, Name, AdditionDate, UsageCount): Sort rule (optional, by default tags are sorted by name).Possible values are Name and UsageCount.
    • preferAccurateMatches boolean: Whether the search should prefer accurate matches.
    • fields string (values: None, AdditionalNames, AliasedTo, Description, MainPicture, Names, Parent, RelatedTags, TranslatedDescription, WebLinks): List of optional fields (optional).
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).
    • target string (values: Nothing, Album, Artist, AlbumArtist, Event, Song, AlbumSong, ArtistSong, All)

Output

TagApi_PostNewTag

Creates a new tag.

vocadb.TagApi_PostNewTag({
  "name": ""
}, context)

Input

  • input object
    • name required string: Tag English name. Tag names must be unique.

Output

TagApi_GetByName

DEPRECATED. Gets a tag by name.

vocadb.TagApi_GetByName({
  "name": ""
}, context)

Input

  • input object
    • name required string: Tag name (required).
    • fields string (values: None, AdditionalNames, AliasedTo, Description, MainPicture, Names, Parent, RelatedTags, TranslatedDescription, WebLinks): List of optional fields (optional).
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

TagApi_GetCategoryNamesList

Gets a list of tag category names.

vocadb.TagApi_GetCategoryNamesList({}, context)

Input

  • input object
    • query string
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words)

Output

  • output array
    • items string

TagApi_DeleteComment

Deletes a comment. Normal users can delete their own comments, moderators can delete all comments. Requires login.

vocadb.TagApi_DeleteComment({
  "commentId": 0
}, context)

Input

  • input object
    • commentId required integer: ID of the comment to be deleted.

Output

Output schema unknown

TagApi_PostEditComment

Updates a comment. Normal users can edit their own comments, moderators can edit all comments. Requires login.

vocadb.TagApi_PostEditComment({
  "commentId": 0,
  "contract": {}
}, context)

Input

  • input object

Output

Output schema unknown

TagApi_GetNames

Find tag names by a part of name.

        Matching is done anywhere from the name.
vocadb.TagApi_GetNames({}, context)

Input

  • input object
    • query string: Tag name query, for example "rock".
    • allowAliases boolean: Whether to find tags that are aliases of other tags as well.
    • maxResults integer: Maximum number of search results.

Output

  • output array
    • items string

TagApi_GetTopTags

Gets the most common tags in a category.

vocadb.TagApi_GetTopTags({}, context)

Input

  • input object
    • categoryName string: Tag category, for example "Genres". Optional - if not specified, no filtering is done.
    • entryType string (values: Undefined, Album, Artist, DiscussionTopic, PV, ReleaseEvent, ReleaseEventSeries, Song, SongList, Tag, User, Venue): Tag usage entry type. Optional - if not specified, all entry types are included.
    • maxResults integer: Maximum number of tags to return.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

TagApi_Delete

Deletes a tag.

vocadb.TagApi_Delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: ID of the tag to be deleted.
    • notes string: Notes (optional).
    • hardDelete boolean: If true, the entry is hard deleted. Hard deleted entries cannot be restored normally, but they will be moved to trash.

Output

Output schema unknown

TagApi_GetById

Gets a tag by ID.

vocadb.TagApi_GetById({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Tag ID (required).
    • fields string (values: None, AdditionalNames, AliasedTo, Description, MainPicture, Names, Parent, RelatedTags, TranslatedDescription, WebLinks): List of optional fields (optional).
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

TagApi_GetChildTags

Gets a list of child tags for a tag. Only direct children will be included.

vocadb.TagApi_GetChildTags({
  "tagId": 0
}, context)

Input

  • input object
    • tagId required integer: ID of the tag whose children to load.
    • fields string (values: None, AdditionalNames, AliasedTo, Description, MainPicture, Names, Parent, RelatedTags, TranslatedDescription, WebLinks): List of optional fields (optional).
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

TagApi_GetComments

Gets a list of comments for a tag. Note: pagination and sorting might be added later.

vocadb.TagApi_GetComments({
  "tagId": 0
}, context)

Input

  • input object
    • tagId required integer: ID of the tag whose comments to load.

Output

TagApi_PostNewComment

Posts a new comment.

vocadb.TagApi_PostNewComment({
  "tagId": 0,
  "contract": {}
}, context)

Input

  • input object
    • tagId required integer: ID of the tag for which to create the comment.
    • contract required CommentForApiContract

Output

TagApi_PostReport

Creates a new report.

vocadb.TagApi_PostReport({
  "tagId": 0,
  "reportType": "",
  "notes": "",
  "versionNumber": 0
}, context)

Input

  • input object
    • tagId required integer: Tag to be reported.
    • reportType required string (values: InvalidInfo, Duplicate, Inappropriate, Other): Report type.
    • notes required string: Notes. Optional.
    • versionNumber required integer: Version to be reported. Optional.

Output

Output schema unknown

UserApi_GetList

Gets a list of users.

vocadb.UserApi_GetList({}, context)

Input

  • input object
    • query string: User name query (optional).
    • groups string (values: Nothing, Limited, Regular, Trusted, Moderator, Admin): Filter by user group. Only one value supported for now. Optional.
    • joinDateAfter string: Filter by users who joined after this date (inclusive).
    • joinDateBefore string: Filter by users who joined before this date (exclusive).
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Name match mode.
    • start integer: Index of the first entry to be loaded.
    • maxResults integer: Maximum number of results to be loaded.
    • getTotalCount boolean: Whether to get total number of results.
    • sort string (values: RegisterDate, Name, Group): Sort rule.
    • includeDisabled boolean: Whether to include disabled user accounts.
    • onlyVerified boolean: Whether to only include verified artists.
    • knowsLanguage string: Filter by known language (optional). This is the ISO 639-1 language code, for example "en" or "zh".
    • fields string (values: None, KnownLanguages, MainPicture, OldUsernames): Optional fields. Possible values are None and MainPicture. Optional.

Output

UserApi_GetCurrent

Requires login information. This API supports CORS, and is restricted to specific origins.

vocadb.UserApi_GetCurrent({}, context)

Input

  • input object
    • fields string (values: None, KnownLanguages, MainPicture, OldUsernames): Optional fields.

Output

UserApi_PostAlbumStatus

If the user has already rated the album, any previous rating is replaced. Authorization cookie must be included.

vocadb.UserApi_PostAlbumStatus({
  "albumId": 0,
  "collectionStatus": "",
  "mediaType": "",
  "rating": 0
}, context)

Input

  • input object
    • albumId required integer: ID of the album to be rated.
    • collectionStatus required string (values: Nothing, Wishlisted, Ordered, Owned): Collection status. Possible values are Nothing, Wishlisted, Ordered and Owned.
    • mediaType required string (values: PhysicalDisc, DigitalDownload, Other): Album media type. Possible values are PhysicalDisc, DigitalDownload and Other.
    • rating required integer: Rating to be given. Possible values are between 0 and 5.

Output

  • output string

UserApi_DeleteFollowedTag

vocadb.UserApi_DeleteFollowedTag({
  "tagId": 0
}, context)

Input

  • input object
    • tagId required integer

Output

Output schema unknown

UserApi_PostFollowedTag

vocadb.UserApi_PostFollowedTag({
  "tagId": 0
}, context)

Input

  • input object
    • tagId required integer

Output

Output schema unknown

UserApi_GetSongRatingForCurrent

Requires authentication.

vocadb.UserApi_GetSongRatingForCurrent({
  "songId": 0
}, context)

Input

  • input object
    • songId required integer: ID of the song whose rating is to be checked.

Output

  • output string (values: Nothing, Dislike, Like, Favorite)

UserApi_PostRefreshEntryEdit

Refresh entry edit status, indicating that the current user is still editing that entry.

vocadb.UserApi_PostRefreshEntryEdit({
  "entryType": "",
  "entryId": 0
}, context)

Input

  • input object
    • entryType required string (values: Undefined, Album, Artist, DiscussionTopic, PV, ReleaseEvent, ReleaseEventSeries, Song, SongList, Tag, User, Venue): Type of entry.
    • entryId required integer: Entry ID.

Output

Output schema unknown

UserApi_PostSongTags

This can only be used to add tags - existing tags will not be removed. Nothing will be done for tags that are already applied by the current user for the song. Authorization cookie is required.

vocadb.UserApi_PostSongTags({
  "songId": 0,
  "tags": []
}, context)

Input

  • input object
    • songId required integer: ID of the song to be tagged.
    • tags required array

Output

Output schema unknown

UserApi_GetMessage

The message will be marked as read. User can only load messages from their own inbox.

vocadb.UserApi_GetMessage({
  "messageId": 0
}, context)

Input

  • input object
    • messageId required integer: ID of the message.

Output

UserApi_GetNames

Gets a list of user names. Ideal for autocomplete boxes.

vocadb.UserApi_GetNames({}, context)

Input

  • input object
    • query string: Text query.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Name match mode. Words is treated the same as Partial.
    • maxResults integer: Maximum number of results.
    • includeDisabled boolean: Whether to include disabled user accounts. If false, disabled accounts are excluded.

Output

  • output array
    • items string

UserApi_DeleteProfileComment

Normal users can delete their own comments, moderators can delete all comments. Requires login.

vocadb.UserApi_DeleteProfileComment({
  "commentId": 0
}, context)

Input

  • input object
    • commentId required integer: ID of the comment to be deleted.

Output

Output schema unknown

UserApi_PostEditComment

Normal users can edit their own comments, moderators can edit all comments. Requires login.

vocadb.UserApi_PostEditComment({
  "commentId": 0,
  "contract": {}
}, context)

Input

  • input object

Output

Output schema unknown

UserApi_GetOne

Gets user by ID.

vocadb.UserApi_GetOne({
  "id": 0
}, context)

Input

  • input object
    • id required integer: User ID.
    • fields string (values: None, KnownLanguages, MainPicture, OldUsernames): Optional fields.

Output

UserApi_GetAlbumCollection

This includes albums that have been rated by the user as well as albums that the user has bought or wishlisted. Note that the user might have set his album ownership status and media type as private, in which case those properties are not included.

vocadb.UserApi_GetAlbumCollection({
  "id": 0
}, context)

Input

  • input object
    • id required integer: ID of the user whose albums are to be browsed.
    • query string: Album name query (optional).
    • tagId integer: Filter by tag Id (optional).
    • tag string: Filter by tag (optional).
    • artistId integer: Filter by album artist (optional).
    • purchaseStatuses string (values: Nothing, Wishlisted, Ordered, Owned, All): Filter by a comma-separated list of purchase statuses (optional). Possible values are Nothing, Wishlisted, Ordered, Owned, and all combinations of these.
    • releaseEventId integer: Filter by release event. Optional.
    • albumTypes string (values: Unknown, Album, Single, EP, SplitAlbum, Compilation, Video, Artbook, Game, Fanmade, Instrumental, Other): Filter by album type (optional).
    • advancedFilters array: List of advanced filters (optional).
    • start integer: First item to be retrieved (optional, defaults to 0).
    • maxResults integer: Maximum number of results to be loaded (optional, defaults to 10, maximum of 50).
    • getTotalCount boolean: Whether to load total number of items (optional, default to false).
    • sort string (values: None, Name, ReleaseDate, ReleaseDateWithNulls, AdditionDate, RatingAverage, RatingTotal, NameThenReleaseDate, CollectionCount): Sort rule (optional, defaults to Name). Possible values are None, Name, ReleaseDate, AdditionDate, RatingAverage, RatingTotal, CollectionCount.
    • nameMatchMode string (values: Auto, Partial, StartsWith, Exact, Words): Match mode for album name (optional, defaults to Auto).
    • fields string (values: None, AdditionalNames, Artists, Description, Discs, Identifiers, MainPicture, Names, PVs, ReleaseEvent, Tags, Tracks, WebLinks): List of optional fields (optional). Possible values are Artists, MainPicture, Names, PVs, Tags, WebLinks.
    • lang string (values: Default, Japanese, Romaji, English): Content language preference (optional).

Output

UserApi_GetEvents

Gets a list of events a user has subscribed to.

vocadb.UserApi_GetEvents({
  "id": 0,
  "relationshipType": ""
}, context)

Input

  • input object
    • id required integer: User ID.
    • relationshipType required string (values: Interested, Attending): Type of event subscription.

Output

UserApi_GetFo

datafire
@infinitebrahmanuniverse/nolb-_datafire_v@everything-registry/sub-chunk-222@zalastax/nolb-_datafire_v
5.0.0

5 years ago

4.0.0

7 years ago

3.0.0

7 years ago

2.0.0

8 years ago