EveSwaggerInterface.ContactsApi

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

Method	HTTP request	Description
deleteCharactersCharacterIdContacts	DELETE /characters/{character_id}/contacts/	Delete contacts
getAlliancesAllianceIdContacts	GET /alliances/{alliance_id}/contacts/	Get alliance contacts
getAlliancesAllianceIdContactsLabels	GET /alliances/{alliance_id}/contacts/labels/	Get alliance contact labels
getCharactersCharacterIdContacts	GET /characters/{character_id}/contacts/	Get contacts
getCharactersCharacterIdContactsLabels	GET /characters/{character_id}/contacts/labels/	Get contact labels
getCorporationsCorporationIdContacts	GET /corporations/{corporation_id}/contacts/	Get corporation contacts
getCorporationsCorporationIdContactsLabels	GET /corporations/{corporation_id}/contacts/labels/	Get corporation contact labels
postCharactersCharacterIdContacts	POST /characters/{character_id}/contacts/	Add contacts
putCharactersCharacterIdContacts	PUT /characters/{character_id}/contacts/	Edit contacts

deleteCharactersCharacterIdContacts

deleteCharactersCharacterIdContacts(characterIdcontactIds, opts)

Delete contacts

Bulk delete contacts --- Alternate route: /dev/characters/{character_id}/contacts/ Alternate route: /v2/characters/{character_id}/contacts/

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.ContactsApi();

var characterId = 56; // Number | An EVE character ID

var contactIds = [3.4]; // [Number] | A list of contacts to delete

var opts = { 
  '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
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deleteCharactersCharacterIdContacts(characterIdcontactIds, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
contactIds	[Number]	A list of contacts to delete
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]

Return type

null (empty response body)

Authorization

evesso

HTTP request headers

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

getAlliancesAllianceIdContacts

[GetAlliancesAllianceIdContacts200Ok] getAlliancesAllianceIdContacts(allianceId, opts)

Get alliance contacts

Return contacts of an alliance --- Alternate route: /dev/alliances/{alliance_id}/contacts/ Alternate route: /v2/alliances/{alliance_id}/contacts/ --- This route is cached for up to 300 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.ContactsApi();

var allianceId = 56; // Number | An EVE alliance ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getAlliancesAllianceIdContacts(allianceId, opts, callback);

Parameters

Name	Type	Description	Notes
allianceId	Number	An EVE alliance 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]
page	Number	Which page of results to return	[optional] [default to 1]
token	String	Access token to use if unable to set a header	[optional]

Return type

[GetAlliancesAllianceIdContacts200Ok]

Authorization

evesso

HTTP request headers

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

getAlliancesAllianceIdContactsLabels

[GetAlliancesAllianceIdContactsLabels200Ok] getAlliancesAllianceIdContactsLabels(allianceId, opts)

Get alliance contact labels

Return custom labels for an alliance's contacts --- Alternate route: /dev/alliances/{alliance_id}/contacts/labels/ Alternate route: /legacy/alliances/{alliance_id}/contacts/labels/ Alternate route: /v1/alliances/{alliance_id}/contacts/labels/ --- This route is cached for up to 300 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.ContactsApi();

var allianceId = 56; // Number | An EVE alliance ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getAlliancesAllianceIdContactsLabels(allianceId, opts, callback);

Parameters

Name	Type	Description	Notes
allianceId	Number	An EVE alliance 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

[GetAlliancesAllianceIdContactsLabels200Ok]

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdContacts

[GetCharactersCharacterIdContacts200Ok] getCharactersCharacterIdContacts(characterId, opts)

Get contacts

Return contacts of a character --- Alternate route: /dev/characters/{character_id}/contacts/ Alternate route: /v2/characters/{character_id}/contacts/ --- This route is cached for up to 300 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.ContactsApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdContacts(characterId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	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]
page	Number	Which page of results to return	[optional] [default to 1]
token	String	Access token to use if unable to set a header	[optional]

Return type

[GetCharactersCharacterIdContacts200Ok]

Authorization

evesso

HTTP request headers

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

getCharactersCharacterIdContactsLabels

[GetCharactersCharacterIdContactsLabels200Ok] getCharactersCharacterIdContactsLabels(characterId, opts)

Get contact labels

Return custom labels for a character's contacts --- Alternate route: /dev/characters/{character_id}/contacts/labels/ Alternate route: /legacy/characters/{character_id}/contacts/labels/ Alternate route: /v1/characters/{character_id}/contacts/labels/ --- This route is cached for up to 300 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.ContactsApi();

var characterId = 56; // Number | An EVE character ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCharactersCharacterIdContactsLabels(characterId, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	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

[GetCharactersCharacterIdContactsLabels200Ok]

Authorization

evesso

HTTP request headers

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

getCorporationsCorporationIdContacts

[GetCorporationsCorporationIdContacts200Ok] getCorporationsCorporationIdContacts(corporationId, opts)

Get corporation contacts

Return contacts of a corporation --- Alternate route: /dev/corporations/{corporation_id}/contacts/ Alternate route: /v2/corporations/{corporation_id}/contacts/ --- This route is cached for up to 300 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.ContactsApi();

var corporationId = 56; // Number | An EVE corporation ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'page': 1 // Number | Which page of results to return
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCorporationsCorporationIdContacts(corporationId, opts, callback);

Parameters

Name	Type	Description	Notes
corporationId	Number	An EVE corporation 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]
page	Number	Which page of results to return	[optional] [default to 1]
token	String	Access token to use if unable to set a header	[optional]

Return type

[GetCorporationsCorporationIdContacts200Ok]

Authorization

evesso

HTTP request headers

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

getCorporationsCorporationIdContactsLabels

[GetCorporationsCorporationIdContactsLabels200Ok] getCorporationsCorporationIdContactsLabels(corporationId, opts)

Get corporation contact labels

Return custom labels for a corporation's contacts --- Alternate route: /dev/corporations/{corporation_id}/contacts/labels/ Alternate route: /legacy/corporations/{corporation_id}/contacts/labels/ Alternate route: /v1/corporations/{corporation_id}/contacts/labels/ --- This route is cached for up to 300 seconds

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.ContactsApi();

var corporationId = 56; // Number | An EVE corporation ID

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'ifNoneMatch': "ifNoneMatch_example", // String | ETag from a previous request. A 304 will be returned if this matches the current ETag
  'token': "token_example" // String | Access token to use if unable to set a header
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.getCorporationsCorporationIdContactsLabels(corporationId, opts, callback);

Parameters

Name	Type	Description	Notes
corporationId	Number	An EVE corporation 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

[GetCorporationsCorporationIdContactsLabels200Ok]

Authorization

evesso

HTTP request headers

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

postCharactersCharacterIdContacts

['Number'] postCharactersCharacterIdContacts(characterIdcontactIds, standing, opts)

Add contacts

Bulk add contacts with same settings --- Alternate route: /dev/characters/{character_id}/contacts/ Alternate route: /v2/characters/{character_id}/contacts/

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.ContactsApi();

var characterId = 56; // Number | An EVE character ID

var contactIds = [new EveSwaggerInterface.[Number]()]; // [Number] | A list of contacts

var standing = 3.4; // Number | Standing for the contact

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'labelIds': [3.4], // [Number] | Add custom labels to the new contact
  'token': "token_example" // String | Access token to use if unable to set a header
  'watched': false // Boolean | Whether the contact should be watched, note this is only effective on characters
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.postCharactersCharacterIdContacts(characterIdcontactIds, standing, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
contactIds	[Number]	A list of contacts
standing	Number	Standing for the contact
datasource	String	The server name you would like data from	[optional] [default to tranquility]
labelIds	[Number]	Add custom labels to the new contact	[optional]
token	String	Access token to use if unable to set a header	[optional]
watched	Boolean	Whether the contact should be watched, note this is only effective on characters	[optional] [default to false]

Return type

['Number']

Authorization

evesso

HTTP request headers

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

putCharactersCharacterIdContacts

putCharactersCharacterIdContacts(characterIdcontactIds, standing, opts)

Edit contacts

Bulk edit contacts with same settings --- Alternate route: /dev/characters/{character_id}/contacts/ Alternate route: /v2/characters/{character_id}/contacts/

Example

var EveSwaggerInterface = require('eve_swagger_interface');
var defaultClient = EveSwaggerInterface.ApiClient.instance;

// Configure OAuth2 access token for authorization: evesso
var evesso = defaultClient.authentications['evesso'];
evesso.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new EveSwaggerInterface.ContactsApi();

var characterId = 56; // Number | An EVE character ID

var contactIds = [new EveSwaggerInterface.[Number]()]; // [Number] | A list of contacts

var standing = 3.4; // Number | Standing for the contact

var opts = { 
  'datasource': "tranquility", // String | The server name you would like data from
  'labelIds': [3.4], // [Number] | Add custom labels to the contact
  'token': "token_example" // String | Access token to use if unable to set a header
  'watched': false // Boolean | Whether the contact should be watched, note this is only effective on characters
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.putCharactersCharacterIdContacts(characterIdcontactIds, standing, opts, callback);

Parameters

Name	Type	Description	Notes
characterId	Number	An EVE character ID
contactIds	[Number]	A list of contacts
standing	Number	Standing for the contact
datasource	String	The server name you would like data from	[optional] [default to tranquility]
labelIds	[Number]	Add custom labels to the contact	[optional]
token	String	Access token to use if unable to set a header	[optional]
watched	Boolean	Whether the contact should be watched, note this is only effective on characters	[optional] [default to false]

Return type

null (empty response body)

Authorization

evesso

HTTP request headers

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

FilesExpand file tree

ContactsApi.md

Latest commit

History

ContactsApi.md

File metadata and controls

EveSwaggerInterface.ContactsApi

deleteCharactersCharacterIdContacts

Example

Parameters

Return type

Authorization

HTTP request headers

getAlliancesAllianceIdContacts

Example

Parameters

Return type

Authorization

HTTP request headers

getAlliancesAllianceIdContactsLabels

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdContacts

Example

Parameters

Return type

Authorization

HTTP request headers

getCharactersCharacterIdContactsLabels

Example

Parameters

Return type

Authorization

HTTP request headers

getCorporationsCorporationIdContacts

Example

Parameters

Return type

Authorization

HTTP request headers

getCorporationsCorporationIdContactsLabels

Example

Parameters

Return type

Authorization

HTTP request headers

postCharactersCharacterIdContacts

Example

Parameters

Return type

Authorization

HTTP request headers

putCharactersCharacterIdContacts

Example

Parameters

Return type

Authorization

HTTP request headers