Skip to content

Latest commit

 

History

History
522 lines (379 loc) · 19.1 KB

ReleaseEventApi.md

File metadata and controls

522 lines (379 loc) · 19.1 KB
Raw

ReleaseEventApi

All URIs are relative to http://localhost

Method HTTP request Description
apiReleaseEventsEventIdAlbumsGet GET /api/releaseEvents/{eventId}/albums
apiReleaseEventsEventIdPublishedSongsGet GET /api/releaseEvents/{eventId}/published-songs
apiReleaseEventsEventIdReportsPost POST /api/releaseEvents/{eventId}/reports
apiReleaseEventsGet GET /api/releaseEvents
apiReleaseEventsIdDelete DELETE /api/releaseEvents/{id}
apiReleaseEventsIdGet GET /api/releaseEvents/{id}
apiReleaseEventsNamesGet GET /api/releaseEvents/names

apiReleaseEventsEventIdAlbumsGet

List<AlbumForApiContract> apiReleaseEventsEventIdAlbumsGet(eventId, 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.ReleaseEventApi;

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

        ReleaseEventApi apiInstance = new ReleaseEventApi(defaultClient);
        Integer eventId = 56; // Integer | 
        AlbumOptionalFields fields = AlbumOptionalFields.fromValue("None"); // AlbumOptionalFields | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        try {
            List<AlbumForApiContract> result = apiInstance.apiReleaseEventsEventIdAlbumsGet(eventId, fields, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReleaseEventApi#apiReleaseEventsEventIdAlbumsGet");
            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
eventId 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

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 -

apiReleaseEventsEventIdPublishedSongsGet

List<SongForApiContract> apiReleaseEventsEventIdPublishedSongsGet(eventId, 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.ReleaseEventApi;

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

        ReleaseEventApi apiInstance = new ReleaseEventApi(defaultClient);
        Integer eventId = 56; // Integer | 
        SongOptionalFields fields = SongOptionalFields.fromValue("None"); // SongOptionalFields | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        try {
            List<SongForApiContract> result = apiInstance.apiReleaseEventsEventIdPublishedSongsGet(eventId, fields, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReleaseEventApi#apiReleaseEventsEventIdPublishedSongsGet");
            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
eventId 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<SongForApiContract>

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 -

apiReleaseEventsEventIdReportsPost

apiReleaseEventsEventIdReportsPost(eventId, reportType, notes, versionNumber)

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

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

        ReleaseEventApi apiInstance = new ReleaseEventApi(defaultClient);
        Integer eventId = 56; // Integer | 
        EventReportType reportType = EventReportType.fromValue("InvalidInfo"); // EventReportType | 
        String notes = "notes_example"; // String | 
        Integer versionNumber = 56; // Integer | 
        try {
            apiInstance.apiReleaseEventsEventIdReportsPost(eventId, reportType, notes, versionNumber);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReleaseEventApi#apiReleaseEventsEventIdReportsPost");
            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
eventId Integer
reportType EventReportType [optional] [enum: InvalidInfo, Duplicate, Inappropriate, Other]
notes String [optional]
versionNumber Integer [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 -

apiReleaseEventsGet

ReleaseEventForApiContractPartialFindResult apiReleaseEventsGet(query, nameMatchMode, seriesId, afterDate, beforeDate, category, userCollectionId, tagId, childTags, artistId, childVoicebanks, includeMembers, status, start, maxResults, getTotalCount, sort, fields, lang, sortDirection)

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

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

        ReleaseEventApi apiInstance = new ReleaseEventApi(defaultClient);
        String query = ""; // String | 
        NameMatchMode nameMatchMode = NameMatchMode.fromValue("Auto"); // NameMatchMode | 
        Integer seriesId = 0; // Integer | 
        LocalDateTime afterDate = new LocalDateTime(); // LocalDateTime | 
        LocalDateTime beforeDate = new LocalDateTime(); // LocalDateTime | 
        EventCategory category = EventCategory.fromValue("Unspecified"); // EventCategory | 
        Integer userCollectionId = 56; // Integer | 
        List<Integer> tagId = Arrays.asList(); // List<Integer> | 
        Boolean childTags = false; // Boolean | 
        List<Integer> artistId = Arrays.asList(); // List<Integer> | 
        Boolean childVoicebanks = false; // Boolean | 
        Boolean includeMembers = false; // Boolean | 
        EntryStatus status = EntryStatus.fromValue("Draft"); // EntryStatus | 
        Integer start = 0; // Integer | 
        Integer maxResults = 10; // Integer | 
        Boolean getTotalCount = false; // Boolean | 
        EventSortRule sort = EventSortRule.fromValue("None"); // EventSortRule | 
        ReleaseEventOptionalFields fields = ReleaseEventOptionalFields.fromValue("None"); // ReleaseEventOptionalFields | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        SortDirection sortDirection = SortDirection.fromValue("Ascending"); // SortDirection | 
        try {
            ReleaseEventForApiContractPartialFindResult result = apiInstance.apiReleaseEventsGet(query, nameMatchMode, seriesId, afterDate, beforeDate, category, userCollectionId, tagId, childTags, artistId, childVoicebanks, includeMembers, status, start, maxResults, getTotalCount, sort, fields, lang, sortDirection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReleaseEventApi#apiReleaseEventsGet");
            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
query String [optional] [default to ]
nameMatchMode NameMatchMode [optional] [enum: Auto, Partial, StartsWith, Exact, Words]
seriesId Integer [optional] [default to 0]
afterDate LocalDateTime [optional]
beforeDate LocalDateTime [optional]
category EventCategory [optional] [enum: Unspecified, AlbumRelease, Anniversary, Club, Concert, Contest, Convention, Other, Festival]
userCollectionId Integer [optional]
tagId List<Integer> [optional]
childTags Boolean [optional] [default to false]
artistId List<Integer> [optional]
childVoicebanks Boolean [optional] [default to false]
includeMembers Boolean [optional] [default to false]
status EntryStatus [optional] [enum: Draft, Finished, Approved, Locked]
start Integer [optional] [default to 0]
maxResults Integer [optional] [default to 10]
getTotalCount Boolean [optional] [default to false]
sort EventSortRule [optional] [enum: None, Name, Date, AdditionDate, SeriesName, VenueName]
fields ReleaseEventOptionalFields [optional] [enum: None, AdditionalNames, Artists, Description, MainPicture, Names, Series, SongList, Tags, Venue, WebLinks, PVs]
lang ContentLanguagePreference [optional] [enum: Default, Japanese, Romaji, English]
sortDirection SortDirection [optional] [enum: Ascending, Descending]

Return type

ReleaseEventForApiContractPartialFindResult

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 -

apiReleaseEventsIdDelete

apiReleaseEventsIdDelete(id, notes, hardDelete)

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

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

        ReleaseEventApi apiInstance = new ReleaseEventApi(defaultClient);
        Integer id = 56; // Integer | 
        String notes = ""; // String | 
        Boolean hardDelete = false; // Boolean | 
        try {
            apiInstance.apiReleaseEventsIdDelete(id, notes, hardDelete);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReleaseEventApi#apiReleaseEventsIdDelete");
            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 ]
hardDelete Boolean [optional] [default to false]

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 -

apiReleaseEventsIdGet

ReleaseEventForApiContract apiReleaseEventsIdGet(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.ReleaseEventApi;

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

        ReleaseEventApi apiInstance = new ReleaseEventApi(defaultClient);
        Integer id = 56; // Integer | 
        ReleaseEventOptionalFields fields = ReleaseEventOptionalFields.fromValue("None"); // ReleaseEventOptionalFields | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        try {
            ReleaseEventForApiContract result = apiInstance.apiReleaseEventsIdGet(id, fields, lang);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReleaseEventApi#apiReleaseEventsIdGet");
            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
fields ReleaseEventOptionalFields [optional] [enum: None, AdditionalNames, Artists, Description, MainPicture, Names, Series, SongList, Tags, Venue, WebLinks, PVs]
lang ContentLanguagePreference [optional] [enum: Default, Japanese, Romaji, English]

Return type

ReleaseEventForApiContract

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 -

apiReleaseEventsNamesGet

List<String> apiReleaseEventsNamesGet(query, 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.ReleaseEventApi;

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

        ReleaseEventApi apiInstance = new ReleaseEventApi(defaultClient);
        String query = ""; // String | 
        Integer maxResults = 10; // Integer | 
        try {
            List<String> result = apiInstance.apiReleaseEventsNamesGet(query, maxResults);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReleaseEventApi#apiReleaseEventsNamesGet");
            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
query String [optional] [default to ]
maxResults Integer [optional] [default to 10]

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 -