Skip to content

Latest commit

 

History

History
183 lines (131 loc) · 8.93 KB

ContractsApi.md

File metadata and controls

183 lines (131 loc) · 8.93 KB
Raw

Swagger\Client\ContractsApi

All URIs are relative to https://esi.tech.ccp.is/latest

Method HTTP request Description
getCharactersCharacterIdContracts GET /characters/{character_id}/contracts/ Get contracts
getCharactersCharacterIdContractsContractIdBids GET /characters/{character_id}/contracts/{contract_id}/bids/ Get contract bids
getCharactersCharacterIdContractsContractIdItems GET /characters/{character_id}/contracts/{contract_id}/items/ Get contract items

getCharactersCharacterIdContracts

\Swagger\Client\Model\GetCharactersCharacterIdContracts200Ok[] getCharactersCharacterIdContracts($character_id, $datasource, $token, $user_agent, $x_user_agent)

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". --- Alternate route: /v1/characters/{character_id}/contracts/ Alternate route: /legacy/characters/{character_id}/contracts/ Alternate route: /dev/characters/{character_id}/contracts/ --- This route is cached for up to 300 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ContractsApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 56; // int | An EVE character ID
$datasource = "tranquility"; // string | The server name you would like data from
$token = "token_example"; // string | Access token to use if unable to set a header
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdContracts($character_id, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getCharactersCharacterIdContracts: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
character_id int An EVE character ID
datasource string The server name you would like data from [optional] [default to tranquility]
token string Access token to use if unable to set a header [optional]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdContracts200Ok[]

Authorization

evesso

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCharactersCharacterIdContractsContractIdBids

\Swagger\Client\Model\GetCharactersCharacterIdContractsContractIdBids200Ok[] getCharactersCharacterIdContractsContractIdBids($character_id, $contract_id, $datasource, $token, $user_agent, $x_user_agent)

Get contract bids

Lists bids on a particular auction contract --- Alternate route: /v1/characters/{character_id}/contracts/{contract_id}/bids/ Alternate route: /legacy/characters/{character_id}/contracts/{contract_id}/bids/ Alternate route: /dev/characters/{character_id}/contracts/{contract_id}/bids/ --- This route is cached for up to 300 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ContractsApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 56; // int | An EVE character ID
$contract_id = 56; // int | ID of a contract
$datasource = "tranquility"; // string | The server name you would like data from
$token = "token_example"; // string | Access token to use if unable to set a header
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdContractsContractIdBids($character_id, $contract_id, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getCharactersCharacterIdContractsContractIdBids: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
character_id int An EVE character ID
contract_id int ID of a contract
datasource string The server name you would like data from [optional] [default to tranquility]
token string Access token to use if unable to set a header [optional]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdContractsContractIdBids200Ok[]

Authorization

evesso

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCharactersCharacterIdContractsContractIdItems

\Swagger\Client\Model\GetCharactersCharacterIdContractsContractIdItems200Ok[] getCharactersCharacterIdContractsContractIdItems($character_id, $contract_id, $datasource, $token, $user_agent, $x_user_agent)

Get contract items

Lists Items and details of a particular contract --- Alternate route: /v1/characters/{character_id}/contracts/{contract_id}/items/ Alternate route: /legacy/characters/{character_id}/contracts/{contract_id}/items/ Alternate route: /dev/characters/{character_id}/contracts/{contract_id}/items/ --- This route is cached for up to 3600 seconds

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: evesso
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\ContractsApi(new \Http\Adapter\Guzzle6\Client());
$character_id = 56; // int | An EVE character ID
$contract_id = 56; // int | ID of a contract
$datasource = "tranquility"; // string | The server name you would like data from
$token = "token_example"; // string | Access token to use if unable to set a header
$user_agent = "user_agent_example"; // string | Client identifier, takes precedence over headers
$x_user_agent = "x_user_agent_example"; // string | Client identifier, takes precedence over User-Agent

try {
    $result = $api_instance->getCharactersCharacterIdContractsContractIdItems($character_id, $contract_id, $datasource, $token, $user_agent, $x_user_agent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContractsApi->getCharactersCharacterIdContractsContractIdItems: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
character_id int An EVE character ID
contract_id int ID of a contract
datasource string The server name you would like data from [optional] [default to tranquility]
token string Access token to use if unable to set a header [optional]
user_agent string Client identifier, takes precedence over headers [optional]
x_user_agent string Client identifier, takes precedence over User-Agent [optional]

Return type

\Swagger\Client\Model\GetCharactersCharacterIdContractsContractIdItems200Ok[]

Authorization

evesso

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]