Skip to content

Latest commit

 

History

History
221 lines (169 loc) · 8.57 KB

LocationApi.md

File metadata and controls

221 lines (169 loc) · 8.57 KB

ESIClient.Dotcore.Api.LocationApi

All URIs are relative to https://esi.evetech.net

Method HTTP request Description
GetCharactersCharacterIdLocation GET /v1/characters/{character_id}/location/ Get character location
GetCharactersCharacterIdOnline GET /v2/characters/{character_id}/online/ Get character online
GetCharactersCharacterIdShip GET /v1/characters/{character_id}/ship/ Get current ship

GetCharactersCharacterIdLocation

GetCharactersCharacterIdLocationOk GetCharactersCharacterIdLocation (int? characterId, string datasource = null, string ifNoneMatch = null, string token = null)

Get character location

Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable - -- This route is cached for up to 5 seconds

Example

using System;
using System.Diagnostics;
using ESIClient.Dotcore.Api;
using ESIClient.Dotcore.Client;
using ESIClient.Dotcore.Model;

namespace Example
{
    public class GetCharactersCharacterIdLocationExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: evesso
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new LocationApi();
            var characterId = 56;  // int? | An EVE character ID
            var datasource = datasource_example;  // string | The server name you would like data from (optional)  (default to tranquility)
            var ifNoneMatch = ifNoneMatch_example;  // string | ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) 
            var token = token_example;  // string | Access token to use if unable to set a header (optional) 

            try
            {
                // Get character location
                GetCharactersCharacterIdLocationOk result = apiInstance.GetCharactersCharacterIdLocation(characterId, datasource, ifNoneMatch, token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LocationApi.GetCharactersCharacterIdLocation: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
characterId int? An EVE character ID
datasource string The server name you would like data from [optional] [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token string Access token to use if unable to set a header [optional]

Return type

GetCharactersCharacterIdLocationOk

Authorization

evesso

HTTP request headers

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

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

GetCharactersCharacterIdOnline

GetCharactersCharacterIdOnlineOk GetCharactersCharacterIdOnline (int? characterId, string datasource = null, string ifNoneMatch = null, string token = null)

Get character online

Checks if the character is currently online - -- This route is cached for up to 60 seconds

Example

using System;
using System.Diagnostics;
using ESIClient.Dotcore.Api;
using ESIClient.Dotcore.Client;
using ESIClient.Dotcore.Model;

namespace Example
{
    public class GetCharactersCharacterIdOnlineExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: evesso
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new LocationApi();
            var characterId = 56;  // int? | An EVE character ID
            var datasource = datasource_example;  // string | The server name you would like data from (optional)  (default to tranquility)
            var ifNoneMatch = ifNoneMatch_example;  // string | ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) 
            var token = token_example;  // string | Access token to use if unable to set a header (optional) 

            try
            {
                // Get character online
                GetCharactersCharacterIdOnlineOk result = apiInstance.GetCharactersCharacterIdOnline(characterId, datasource, ifNoneMatch, token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LocationApi.GetCharactersCharacterIdOnline: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
characterId int? An EVE character ID
datasource string The server name you would like data from [optional] [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token string Access token to use if unable to set a header [optional]

Return type

GetCharactersCharacterIdOnlineOk

Authorization

evesso

HTTP request headers

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

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

GetCharactersCharacterIdShip

GetCharactersCharacterIdShipOk GetCharactersCharacterIdShip (int? characterId, string datasource = null, string ifNoneMatch = null, string token = null)

Get current ship

Get the current ship type, name and id - -- This route is cached for up to 5 seconds

Example

using System;
using System.Diagnostics;
using ESIClient.Dotcore.Api;
using ESIClient.Dotcore.Client;
using ESIClient.Dotcore.Model;

namespace Example
{
    public class GetCharactersCharacterIdShipExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: evesso
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new LocationApi();
            var characterId = 56;  // int? | An EVE character ID
            var datasource = datasource_example;  // string | The server name you would like data from (optional)  (default to tranquility)
            var ifNoneMatch = ifNoneMatch_example;  // string | ETag from a previous request. A 304 will be returned if this matches the current ETag (optional) 
            var token = token_example;  // string | Access token to use if unable to set a header (optional) 

            try
            {
                // Get current ship
                GetCharactersCharacterIdShipOk result = apiInstance.GetCharactersCharacterIdShip(characterId, datasource, ifNoneMatch, token);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LocationApi.GetCharactersCharacterIdShip: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
characterId int? An EVE character ID
datasource string The server name you would like data from [optional] [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag [optional]
token string Access token to use if unable to set a header [optional]

Return type

GetCharactersCharacterIdShipOk

Authorization

evesso

HTTP request headers

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

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