Skip to content

Latest commit

 

History

History
146 lines (103 loc) · 4.5 KB

PvApi.md

File metadata and controls

146 lines (103 loc) · 4.5 KB
Raw

PvApi

All URIs are relative to http://localhost

Method HTTP request Description
apiPvsForSongsGet GET /api/pvs/for-songs
apiPvsThumbnailGet GET /api/pvs/thumbnail

apiPvsForSongsGet

PVForSongContractPartialFindResult apiPvsForSongsGet(name, author, service, maxResults, getTotalCount, 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.PvApi;

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

        PvApi apiInstance = new PvApi(defaultClient);
        String name = "name_example"; // String | 
        String author = "author_example"; // String | 
        PVService service = PVService.fromValue("NicoNicoDouga"); // PVService | 
        Integer maxResults = 10; // Integer | 
        Boolean getTotalCount = false; // Boolean | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        try {
            PVForSongContractPartialFindResult result = apiInstance.apiPvsForSongsGet(name, author, service, maxResults, getTotalCount, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PvApi#apiPvsForSongsGet");
            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
name String [optional]
author String [optional]
service PVService [optional] [enum: NicoNicoDouga, Youtube, SoundCloud, Vimeo, Piapro, Bilibili, File, LocalFile, Creofuga, Bandcamp]
maxResults Integer [optional] [default to 10]
getTotalCount Boolean [optional] [default to false]
lang ContentLanguagePreference [optional] [enum: Default, Japanese, Romaji, English]

Return type

PVForSongContractPartialFindResult

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 -

apiPvsThumbnailGet

apiPvsThumbnailGet(pvUrl)

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.PvApi;

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

        PvApi apiInstance = new PvApi(defaultClient);
        String pvUrl = "pvUrl_example"; // String | 
        try {
            apiInstance.apiPvsThumbnailGet(pvUrl);
        } catch (ApiException e) {
            System.err.println("Exception when calling PvApi#apiPvsThumbnailGet");
            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
pvUrl String [optional]

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 -