net.troja.eve.esi.api

Class ContractsApi

java.lang.Object

net.troja.eve.esi.api.ContractsApi

public class ContractsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ContractsApi()
ContractsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
List<CharacterContractsResponse>	getCharactersCharacterIdContracts(Integer characterId, String datasource, String ifNoneMatch, Integer page, String token) Get contracts Returns contracts available to a character, only if the character is issuer, acceptor or assignee.
List<CharacterContractsBidsResponse>	getCharactersCharacterIdContractsContractIdBids(Integer characterId, Integer contractId, String datasource, String ifNoneMatch, String token) Get contract bids Lists bids on a particular auction contract --- This route is cached for up to 300 seconds SSO Scope: esi-contracts.read_character_contracts.v1
List<CharacterContractsItemsResponse>	getCharactersCharacterIdContractsContractIdItems(Integer characterId, Integer contractId, String datasource, String ifNoneMatch, String token) Get contract items Lists items of a particular contract --- This route is cached for up to 3600 seconds SSO Scope: esi-contracts.read_corporation_contracts.v1 SSO Scope: esi-contracts.read_character_contracts.v1
List<PublicContractsBidsResponse>	getContractsPublicBidsContractId(Integer contractId, String datasource, String ifNoneMatch, Integer page) Get public contract bids Lists bids on a public auction contract --- This route is cached for up to 300 seconds
List<PublicContractsItemsResponse>	getContractsPublicItemsContractId(Integer contractId, String datasource, String ifNoneMatch, Integer page) Get public contract items Lists items of a public contract --- This route is cached for up to 3600 seconds
List<PublicContractsResponse>	getContractsPublicRegionId(Integer regionId, String datasource, String ifNoneMatch, Integer page) Get public contracts Returns a paginated list of all public contracts in the given region --- This route is cached for up to 1800 seconds
List<CorporationContractsResponse>	getCorporationsCorporationIdContracts(Integer corporationId, String datasource, String ifNoneMatch, Integer page, String token) Get corporation contracts Returns contracts available to a corporation, only if the corporation is issuer, acceptor or assignee.
List<CorporationContractsBidsResponse>	getCorporationsCorporationIdContractsContractIdBids(Integer contractId, Integer corporationId, String datasource, String ifNoneMatch, Integer page, String token) Get corporation contract bids Lists bids on a particular auction contract --- This route is cached for up to 3600 seconds SSO Scope: esi-contracts.read_corporation_contracts.v1
List<CorporationContractsItemsResponse>	getCorporationsCorporationIdContractsContractIdItems(Integer contractId, Integer corporationId, String datasource, String ifNoneMatch, String token) Get corporation contract items Lists items of a particular contract --- This route is cached for up to 3600 seconds SSO Scope: esi-contracts.read_corporation_contracts.v1 SSO Scope: esi-contracts.read_character_contracts.v1
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContractsApi

public ContractsApi()

ContractsApi

public ContractsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCharactersCharacterIdContracts

public List<CharacterContractsResponse> getCharactersCharacterIdContracts(Integer characterId,
                                                                          String datasource,
                                                                          String ifNoneMatch,
                                                                          Integer page,
                                                                          String token)
                                                                   throws ApiException

Get contracts Returns contracts available to a character, only if the character is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is \"in_progress\". --- This route is cached for up to 300 seconds

Parameters:

characterId - An EVE character ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

page - Which page of results to return (optional, default to 1)

token - Access token to use if unable to set a header (optional)

Returns:

List<CharacterContractsResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdContractsContractIdBids

public List<CharacterContractsBidsResponse> getCharactersCharacterIdContractsContractIdBids(Integer characterId,
                                                                                            Integer contractId,
                                                                                            String datasource,
                                                                                            String ifNoneMatch,
                                                                                            String token)
                                                                                     throws ApiException

Get contract bids Lists bids on a particular auction contract --- This route is cached for up to 300 seconds SSO Scope: esi-contracts.read_character_contracts.v1

Parameters:

characterId - An EVE character ID (required)

contractId - ID of a contract (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

Returns:

List<CharacterContractsBidsResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdContractsContractIdItems

public List<CharacterContractsItemsResponse> getCharactersCharacterIdContractsContractIdItems(Integer characterId,
                                                                                              Integer contractId,
                                                                                              String datasource,
                                                                                              String ifNoneMatch,
                                                                                              String token)
                                                                                       throws ApiException

Get contract items Lists items of a particular contract --- This route is cached for up to 3600 seconds SSO Scope: esi-contracts.read_corporation_contracts.v1 SSO Scope: esi-contracts.read_character_contracts.v1

Parameters:

characterId - An EVE character ID (required)

contractId - ID of a contract (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

Returns:

List<CharacterContractsItemsResponse>

Throws:

ApiException - if fails to make API call

getContractsPublicBidsContractId

public List<PublicContractsBidsResponse> getContractsPublicBidsContractId(Integer contractId,
                                                                          String datasource,
                                                                          String ifNoneMatch,
                                                                          Integer page)
                                                                   throws ApiException

Get public contract bids Lists bids on a public auction contract --- This route is cached for up to 300 seconds

Parameters:

contractId - ID of a contract (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

page - Which page of results to return (optional, default to 1)

Returns:

List<PublicContractsBidsResponse>

Throws:

ApiException - if fails to make API call

getContractsPublicItemsContractId

public List<PublicContractsItemsResponse> getContractsPublicItemsContractId(Integer contractId,
                                                                            String datasource,
                                                                            String ifNoneMatch,
                                                                            Integer page)
                                                                     throws ApiException

Get public contract items Lists items of a public contract --- This route is cached for up to 3600 seconds

Parameters:

contractId - ID of a contract (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

page - Which page of results to return (optional, default to 1)

Returns:

List<PublicContractsItemsResponse>

Throws:

ApiException - if fails to make API call

getContractsPublicRegionId

public List<PublicContractsResponse> getContractsPublicRegionId(Integer regionId,
                                                                String datasource,
                                                                String ifNoneMatch,
                                                                Integer page)
                                                         throws ApiException

Get public contracts Returns a paginated list of all public contracts in the given region --- This route is cached for up to 1800 seconds

Parameters:

regionId - An EVE region id (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

page - Which page of results to return (optional, default to 1)

Returns:

List<PublicContractsResponse>

Throws:

ApiException - if fails to make API call

getCorporationsCorporationIdContracts

public List<CorporationContractsResponse> getCorporationsCorporationIdContracts(Integer corporationId,
                                                                                String datasource,
                                                                                String ifNoneMatch,
                                                                                Integer page,
                                                                                String token)
                                                                         throws ApiException

Get corporation contracts Returns contracts available to a corporation, only if the corporation is issuer, acceptor or assignee. Only returns contracts no older than 30 days, or if the status is \"in_progress\". --- This route is cached for up to 300 seconds

Parameters:

corporationId - An EVE corporation ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

page - Which page of results to return (optional, default to 1)

token - Access token to use if unable to set a header (optional)

Returns:

List<CorporationContractsResponse>

Throws:

ApiException - if fails to make API call

getCorporationsCorporationIdContractsContractIdBids

public List<CorporationContractsBidsResponse> getCorporationsCorporationIdContractsContractIdBids(Integer contractId,
                                                                                                  Integer corporationId,
                                                                                                  String datasource,
                                                                                                  String ifNoneMatch,
                                                                                                  Integer page,
                                                                                                  String token)
                                                                                           throws ApiException

Get corporation contract bids Lists bids on a particular auction contract --- This route is cached for up to 3600 seconds SSO Scope: esi-contracts.read_corporation_contracts.v1

Parameters:

contractId - ID of a contract (required)

corporationId - An EVE corporation ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

page - Which page of results to return (optional, default to 1)

token - Access token to use if unable to set a header (optional)

Returns:

List<CorporationContractsBidsResponse>

Throws:

ApiException - if fails to make API call

getCorporationsCorporationIdContractsContractIdItems

public List<CorporationContractsItemsResponse> getCorporationsCorporationIdContractsContractIdItems(Integer contractId,
                                                                                                    Integer corporationId,
                                                                                                    String datasource,
                                                                                                    String ifNoneMatch,
                                                                                                    String token)
                                                                                             throws ApiException

Get corporation contract items Lists items of a particular contract --- This route is cached for up to 3600 seconds SSO Scope: esi-contracts.read_corporation_contracts.v1 SSO Scope: esi-contracts.read_character_contracts.v1

Parameters:

contractId - ID of a contract (required)

corporationId - An EVE corporation ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

Returns:

List<CorporationContractsItemsResponse>

Throws:

ApiException - if fails to make API call