AlbumApi

All URIs are relative to http://localhost

Method	HTTP request	Description
apiAlbumsCommentsCommentIdDelete	DELETE /api/albums/comments/{commentId}
apiAlbumsCommentsCommentIdPost	POST /api/albums/comments/{commentId}
apiAlbumsGet	GET /api/albums
apiAlbumsIdCommentsGet	GET /api/albums/{id}/comments
apiAlbumsIdCommentsPost	POST /api/albums/{id}/comments
apiAlbumsIdDelete	DELETE /api/albums/{id}
apiAlbumsIdGet	GET /api/albums/{id}
apiAlbumsIdRelatedGet	GET /api/albums/{id}/related
apiAlbumsIdReviewsGet	GET /api/albums/{id}/reviews
apiAlbumsIdReviewsPost	POST /api/albums/{id}/reviews
apiAlbumsIdReviewsReviewIdDelete	DELETE /api/albums/{id}/reviews/{reviewId}
apiAlbumsIdTracksFieldsGet	GET /api/albums/{id}/tracks/fields
apiAlbumsIdTracksGet	GET /api/albums/{id}/tracks
apiAlbumsIdUserCollectionsGet	GET /api/albums/{id}/user-collections
apiAlbumsNamesGet	GET /api/albums/names
apiAlbumsNewGet	GET /api/albums/new
apiAlbumsTopGet	GET /api/albums/top

apiAlbumsCommentsCommentIdDelete

apiAlbumsCommentsCommentIdDelete(commentId)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer commentId = 56; // Integer | 
        try {
            apiInstance.apiAlbumsCommentsCommentIdDelete(commentId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsCommentsCommentIdDelete");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
commentId	Integer

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsCommentsCommentIdPost

apiAlbumsCommentsCommentIdPost(commentId, commentForApiContract)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer commentId = 56; // Integer | 
        CommentForApiContract commentForApiContract = new CommentForApiContract(); // CommentForApiContract | 
        try {
            apiInstance.apiAlbumsCommentsCommentIdPost(commentId, commentForApiContract);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsCommentsCommentIdPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
commentId	Integer
commentForApiContract	CommentForApiContract		[optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsGet

AlbumForApiContractPartialFindResult apiAlbumsGet(query, discTypes, tagName, tagId, childTags, artistId, artistParticipationStatus, childVoicebanks, includeMembers, barcode, status, releaseDateAfter, releaseDateBefore, advancedFilters, start, maxResults, getTotalCount, sort, preferAccurateMatches, deleted, nameMatchMode, fields, lang)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        String query = ""; // String | 
        DiscType discTypes = DiscType.fromValue("Unknown"); // DiscType | 
        List<String> tagName = Arrays.asList(); // List<String> | 
        List<Integer> tagId = Arrays.asList(); // List<Integer> | 
        Boolean childTags = false; // Boolean | 
        List<Integer> artistId = Arrays.asList(); // List<Integer> | 
        ArtistAlbumParticipationStatus artistParticipationStatus = ArtistAlbumParticipationStatus.fromValue("Everything"); // ArtistAlbumParticipationStatus | 
        Boolean childVoicebanks = false; // Boolean | 
        Boolean includeMembers = false; // Boolean | 
        String barcode = "barcode_example"; // String | 
        EntryStatus status = EntryStatus.fromValue("Draft"); // EntryStatus | 
        LocalDateTime releaseDateAfter = new LocalDateTime(); // LocalDateTime | 
        LocalDateTime releaseDateBefore = new LocalDateTime(); // LocalDateTime | 
        List<AdvancedSearchFilterParams> advancedFilters = Arrays.asList(); // List<AdvancedSearchFilterParams> | 
        Integer start = 0; // Integer | 
        Integer maxResults = 10; // Integer | 
        Boolean getTotalCount = false; // Boolean | 
        AlbumSortRule sort = AlbumSortRule.fromValue("None"); // AlbumSortRule | 
        Boolean preferAccurateMatches = false; // Boolean | 
        Boolean deleted = false; // Boolean | 
        NameMatchMode nameMatchMode = NameMatchMode.fromValue("Auto"); // NameMatchMode | 
        AlbumOptionalFields fields = AlbumOptionalFields.fromValue("None"); // AlbumOptionalFields | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        try {
            AlbumForApiContractPartialFindResult result = apiInstance.apiAlbumsGet(query, discTypes, tagName, tagId, childTags, artistId, artistParticipationStatus, childVoicebanks, includeMembers, barcode, status, releaseDateAfter, releaseDateBefore, advancedFilters, start, maxResults, getTotalCount, sort, preferAccurateMatches, deleted, nameMatchMode, fields, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Notes
query	String	[optional] [default to ]
discTypes	DiscType	[optional] [enum: Unknown, Album, Single, EP, SplitAlbum, Compilation, Video, Artbook, Game, Fanmade, Instrumental, Other]
tagName	List<String>	[optional]
tagId	List<Integer>	[optional]
childTags	Boolean	[optional] [default to false]
artistId	List<Integer>	[optional]
artistParticipationStatus	ArtistAlbumParticipationStatus	[optional] [enum: Everything, OnlyMainAlbums, OnlyCollaborations]
childVoicebanks	Boolean	[optional] [default to false]
includeMembers	Boolean	[optional] [default to false]
barcode	String	[optional]
status	EntryStatus	[optional] [enum: Draft, Finished, Approved, Locked]
releaseDateAfter	LocalDateTime	[optional]
releaseDateBefore	LocalDateTime	[optional]
advancedFilters	List<AdvancedSearchFilterParams>	[optional]
start	Integer	[optional] [default to 0]
maxResults	Integer	[optional] [default to 10]
getTotalCount	Boolean	[optional] [default to false]
sort	AlbumSortRule	[optional] [enum: None, Name, ReleaseDate, ReleaseDateWithNulls, AdditionDate, RatingAverage, RatingTotal, NameThenReleaseDate, CollectionCount]
preferAccurateMatches	Boolean	[optional] [default to false]
deleted	Boolean	[optional] [default to false]
nameMatchMode	NameMatchMode	[optional] [enum: Auto, Partial, StartsWith, Exact, Words]
fields	AlbumOptionalFields	[optional] [enum: None, AdditionalNames, Artists, Description, Discs, Identifiers, MainPicture, Names, PVs, ReleaseEvent, Tags, Tracks, WebLinks]
lang	ContentLanguagePreference	[optional] [enum: Default, Japanese, Romaji, English]

Return type

AlbumForApiContractPartialFindResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsIdCommentsGet

List<CommentForApiContract> apiAlbumsIdCommentsGet(id)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer id = 56; // Integer | 
        try {
            List<CommentForApiContract> result = apiInstance.apiAlbumsIdCommentsGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsIdCommentsGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	Integer

Return type

List<CommentForApiContract>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsIdCommentsPost

CommentForApiContract apiAlbumsIdCommentsPost(id, commentForApiContract)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer id = 56; // Integer | 
        CommentForApiContract commentForApiContract = new CommentForApiContract(); // CommentForApiContract | 
        try {
            CommentForApiContract result = apiInstance.apiAlbumsIdCommentsPost(id, commentForApiContract);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsIdCommentsPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	Integer
commentForApiContract	CommentForApiContract		[optional]

Return type

CommentForApiContract

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsIdDelete

apiAlbumsIdDelete(id, notes)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer id = 56; // Integer | 
        String notes = ""; // String | 
        try {
            apiInstance.apiAlbumsIdDelete(id, notes);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsIdDelete");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	Integer
notes	String		[optional] [default to ]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsIdGet

AlbumForApiContract apiAlbumsIdGet(id, fields, songFields, lang)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer id = 56; // Integer | 
        AlbumOptionalFields fields = AlbumOptionalFields.fromValue("None"); // AlbumOptionalFields | 
        SongOptionalFields songFields = SongOptionalFields.fromValue("None"); // SongOptionalFields | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        try {
            AlbumForApiContract result = apiInstance.apiAlbumsIdGet(id, fields, songFields, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsIdGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Notes
id	Integer
fields	AlbumOptionalFields	[optional] [enum: None, AdditionalNames, Artists, Description, Discs, Identifiers, MainPicture, Names, PVs, ReleaseEvent, Tags, Tracks, WebLinks]
songFields	SongOptionalFields	[optional] [enum: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks, Bpm, CultureCodes]
lang	ContentLanguagePreference	[optional] [enum: Default, Japanese, Romaji, English]

Return type

AlbumForApiContract

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsIdRelatedGet

RelatedAlbumsContract apiAlbumsIdRelatedGet(id, fields, lang)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer id = 56; // Integer | 
        AlbumOptionalFields fields = AlbumOptionalFields.fromValue("None"); // AlbumOptionalFields | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        try {
            RelatedAlbumsContract result = apiInstance.apiAlbumsIdRelatedGet(id, fields, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsIdRelatedGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Notes
id	Integer
fields	AlbumOptionalFields	[optional] [enum: None, AdditionalNames, Artists, Description, Discs, Identifiers, MainPicture, Names, PVs, ReleaseEvent, Tags, Tracks, WebLinks]
lang	ContentLanguagePreference	[optional] [enum: Default, Japanese, Romaji, English]

Return type

RelatedAlbumsContract

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsIdReviewsGet

List<AlbumReviewContract> apiAlbumsIdReviewsGet(id, languageCode)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer id = 56; // Integer | 
        String languageCode = "languageCode_example"; // String | 
        try {
            List<AlbumReviewContract> result = apiInstance.apiAlbumsIdReviewsGet(id, languageCode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsIdReviewsGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	Integer
languageCode	String		[optional]

Return type

List<AlbumReviewContract>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsIdReviewsPost

AlbumReviewContract apiAlbumsIdReviewsPost(id, albumReviewContract)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer id = 56; // Integer | 
        AlbumReviewContract albumReviewContract = new AlbumReviewContract(); // AlbumReviewContract | 
        try {
            AlbumReviewContract result = apiInstance.apiAlbumsIdReviewsPost(id, albumReviewContract);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsIdReviewsPost");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	Integer
albumReviewContract	AlbumReviewContract		[optional]

Return type

AlbumReviewContract

Authorization

No authorization required

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsIdReviewsReviewIdDelete

apiAlbumsIdReviewsReviewIdDelete(reviewId, id)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer reviewId = 56; // Integer | 
        String id = "id_example"; // String | 
        try {
            apiInstance.apiAlbumsIdReviewsReviewIdDelete(reviewId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsIdReviewsReviewIdDelete");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
reviewId	Integer
id	String

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsIdTracksFieldsGet

List<Map<String, String>> apiAlbumsIdTracksFieldsGet(id, field, discNumber, lang)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer id = 56; // Integer | 
        List<String> field = Arrays.asList(); // List<String> | 
        Integer discNumber = 56; // Integer | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        try {
            List<Map<String, String>> result = apiInstance.apiAlbumsIdTracksFieldsGet(id, field, discNumber, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsIdTracksFieldsGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Notes
id	Integer
field	List<String>	[optional]
discNumber	Integer	[optional]
lang	ContentLanguagePreference	[optional] [enum: Default, Japanese, Romaji, English]

Return type

List<Map<String, String>>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsIdTracksGet

List<SongInAlbumForApiContract> apiAlbumsIdTracksGet(id, fields, lang)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer id = 56; // Integer | 
        SongOptionalFields fields = SongOptionalFields.fromValue("None"); // SongOptionalFields | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        try {
            List<SongInAlbumForApiContract> result = apiInstance.apiAlbumsIdTracksGet(id, fields, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsIdTracksGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Notes
id	Integer
fields	SongOptionalFields	[optional] [enum: None, AdditionalNames, Albums, Artists, Lyrics, MainPicture, Names, PVs, ReleaseEvent, Tags, ThumbUrl, WebLinks, Bpm, CultureCodes]
lang	ContentLanguagePreference	[optional] [enum: Default, Japanese, Romaji, English]

Return type

List<SongInAlbumForApiContract>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsIdUserCollectionsGet

List<AlbumForUserForApiContract> apiAlbumsIdUserCollectionsGet(id, languagePreference)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        Integer id = 56; // Integer | 
        ContentLanguagePreference languagePreference = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        try {
            List<AlbumForUserForApiContract> result = apiInstance.apiAlbumsIdUserCollectionsGet(id, languagePreference);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsIdUserCollectionsGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
id	Integer
languagePreference	ContentLanguagePreference		[optional] [enum: Default, Japanese, Romaji, English]

Return type

List<AlbumForUserForApiContract>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsNamesGet

List<String> apiAlbumsNamesGet(query, nameMatchMode, maxResults)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        String query = ""; // String | 
        NameMatchMode nameMatchMode = NameMatchMode.fromValue("Auto"); // NameMatchMode | 
        Integer maxResults = 15; // Integer | 
        try {
            List<String> result = apiInstance.apiAlbumsNamesGet(query, nameMatchMode, maxResults);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsNamesGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Notes
query	String	[optional] [default to ]
nameMatchMode	NameMatchMode	[optional] [enum: Auto, Partial, StartsWith, Exact, Words]
maxResults	Integer	[optional] [default to 15]

Return type

List<String>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsNewGet

List<AlbumForApiContract> apiAlbumsNewGet(languagePreference, fields)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        ContentLanguagePreference languagePreference = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        AlbumOptionalFields fields = AlbumOptionalFields.fromValue("None"); // AlbumOptionalFields | 
        try {
            List<AlbumForApiContract> result = apiInstance.apiAlbumsNewGet(languagePreference, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsNewGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
languagePreference	ContentLanguagePreference		[optional] [enum: Default, Japanese, Romaji, English]
fields	AlbumOptionalFields		[optional] [enum: None, AdditionalNames, Artists, Description, Discs, Identifiers, MainPicture, Names, PVs, ReleaseEvent, Tags, Tracks, WebLinks]

Return type

List<AlbumForApiContract>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

apiAlbumsTopGet

List<AlbumForApiContract> apiAlbumsTopGet(ignoreIds, languagePreference, fields)

Example

// Import classes:
import mikufan.cx.vocadbapiclient.client.ApiClient;
import mikufan.cx.vocadbapiclient.client.ApiException;
import mikufan.cx.vocadbapiclient.client.Configuration;
import mikufan.cx.vocadbapiclient.client.models.*;
import mikufan.cx.vocadbapiclient.api.AlbumApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");

        AlbumApi apiInstance = new AlbumApi(defaultClient);
        List<Integer> ignoreIds = Arrays.asList(); // List<Integer> | 
        ContentLanguagePreference languagePreference = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        AlbumOptionalFields fields = AlbumOptionalFields.fromValue("None"); // AlbumOptionalFields | 
        try {
            List<AlbumForApiContract> result = apiInstance.apiAlbumsTopGet(ignoreIds, languagePreference, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlbumApi#apiAlbumsTopGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Notes
ignoreIds	List<Integer>	[optional]
languagePreference	ContentLanguagePreference	[optional] [enum: Default, Japanese, Romaji, English]
fields	AlbumOptionalFields	[optional] [enum: None, AdditionalNames, Artists, Description, Discs, Identifiers, MainPicture, Names, PVs, ReleaseEvent, Tags, Tracks, WebLinks]

Return type

List<AlbumForApiContract>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

HTTP response details

Status code	Description	Response headers
200	Success	-

Files

AlbumApi.md

Latest commit

History

AlbumApi.md

File metadata and controls

AlbumApi

apiAlbumsCommentsCommentIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiAlbumsCommentsCommentIdPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiAlbumsGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiAlbumsIdCommentsGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiAlbumsIdCommentsPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiAlbumsIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiAlbumsIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiAlbumsIdRelatedGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiAlbumsIdReviewsGet

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiAlbumsIdReviewsPost

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

apiAlbumsIdReviewsReviewIdDelete

Example

Parameters