Skip to content

Latest commit

 

History

History
323 lines (193 loc) · 14.6 KB

ContactsApi.md

File metadata and controls

323 lines (193 loc) · 14.6 KB

\ContactsApi

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

Method HTTP request Description
delete_characters_character_id_contacts DELETE /characters/{character_id}/contacts/ Delete contacts
get_alliances_alliance_id_contacts GET /alliances/{alliance_id}/contacts/ Get alliance contacts
get_alliances_alliance_id_contacts_labels GET /alliances/{alliance_id}/contacts/labels/ Get alliance contact labels
get_characters_character_id_contacts GET /characters/{character_id}/contacts/ Get contacts
get_characters_character_id_contacts_labels GET /characters/{character_id}/contacts/labels/ Get contact labels
get_corporations_corporation_id_contacts GET /corporations/{corporation_id}/contacts/ Get corporation contacts
get_corporations_corporation_id_contacts_labels GET /corporations/{corporation_id}/contacts/labels/ Get corporation contact labels
post_characters_character_id_contacts POST /characters/{character_id}/contacts/ Add contacts
put_characters_character_id_contacts PUT /characters/{character_id}/contacts/ Edit contacts

delete_characters_character_id_contacts

delete_characters_character_id_contacts(character_id, contact_ids, datasource, token) Delete contacts

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

Parameters

Name Type Description Required Notes
character_id i32 An EVE character ID [required]
contact_ids Vec A list of contacts to delete [required]
datasource Option<String> The server name you would like data from [default to tranquility]
token Option<String> Access token to use if unable to set a header

Return type

(empty response body)

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]

get_alliances_alliance_id_contacts

Veccrate::models::GetAlliancesAllianceIdContacts200Ok get_alliances_alliance_id_contacts(alliance_id, datasource, if_none_match, page, token) 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

Parameters

Name Type Description Required Notes
alliance_id i32 An EVE alliance ID [required]
datasource Option<String> The server name you would like data from [default to tranquility]
if_none_match Option<String> ETag from a previous request. A 304 will be returned if this matches the current ETag
page Option<i32> Which page of results to return [default to 1]
token Option<String> Access token to use if unable to set a header

Return type

Veccrate::models::GetAlliancesAllianceIdContacts200Ok

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]

get_alliances_alliance_id_contacts_labels

Veccrate::models::GetAlliancesAllianceIdContactsLabels200Ok get_alliances_alliance_id_contacts_labels(alliance_id, datasource, if_none_match, token) 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

Parameters

Name Type Description Required Notes
alliance_id i32 An EVE alliance ID [required]
datasource Option<String> The server name you would like data from [default to tranquility]
if_none_match Option<String> ETag from a previous request. A 304 will be returned if this matches the current ETag
token Option<String> Access token to use if unable to set a header

Return type

Veccrate::models::GetAlliancesAllianceIdContactsLabels200Ok

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]

get_characters_character_id_contacts

Veccrate::models::GetCharactersCharacterIdContacts200Ok get_characters_character_id_contacts(character_id, datasource, if_none_match, page, token) 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

Parameters

Name Type Description Required Notes
character_id i32 An EVE character ID [required]
datasource Option<String> The server name you would like data from [default to tranquility]
if_none_match Option<String> ETag from a previous request. A 304 will be returned if this matches the current ETag
page Option<i32> Which page of results to return [default to 1]
token Option<String> Access token to use if unable to set a header

Return type

Veccrate::models::GetCharactersCharacterIdContacts200Ok

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]

get_characters_character_id_contacts_labels

Veccrate::models::GetCharactersCharacterIdContactsLabels200Ok get_characters_character_id_contacts_labels(character_id, datasource, if_none_match, token) 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

Parameters

Name Type Description Required Notes
character_id i32 An EVE character ID [required]
datasource Option<String> The server name you would like data from [default to tranquility]
if_none_match Option<String> ETag from a previous request. A 304 will be returned if this matches the current ETag
token Option<String> Access token to use if unable to set a header

Return type

Veccrate::models::GetCharactersCharacterIdContactsLabels200Ok

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]

get_corporations_corporation_id_contacts

Veccrate::models::GetCorporationsCorporationIdContacts200Ok get_corporations_corporation_id_contacts(corporation_id, datasource, if_none_match, page, token) 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

Parameters

Name Type Description Required Notes
corporation_id i32 An EVE corporation ID [required]
datasource Option<String> The server name you would like data from [default to tranquility]
if_none_match Option<String> ETag from a previous request. A 304 will be returned if this matches the current ETag
page Option<i32> Which page of results to return [default to 1]
token Option<String> Access token to use if unable to set a header

Return type

Veccrate::models::GetCorporationsCorporationIdContacts200Ok

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]

get_corporations_corporation_id_contacts_labels

Veccrate::models::GetCorporationsCorporationIdContactsLabels200Ok get_corporations_corporation_id_contacts_labels(corporation_id, datasource, if_none_match, token) 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

Parameters

Name Type Description Required Notes
corporation_id i32 An EVE corporation ID [required]
datasource Option<String> The server name you would like data from [default to tranquility]
if_none_match Option<String> ETag from a previous request. A 304 will be returned if this matches the current ETag
token Option<String> Access token to use if unable to set a header

Return type

Veccrate::models::GetCorporationsCorporationIdContactsLabels200Ok

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]

post_characters_character_id_contacts

Vec post_characters_character_id_contacts(character_id, standing, contact_ids, datasource, label_ids, token, watched) Add contacts

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

Parameters

Name Type Description Required Notes
character_id i32 An EVE character ID [required]
standing f32 Standing for the contact [required]
contact_ids Vec A list of contacts [required]
datasource Option<String> The server name you would like data from [default to tranquility]
label_ids Option<Vec> Add custom labels to the new contact
token Option<String> Access token to use if unable to set a header
watched Option<bool> Whether the contact should be watched, note this is only effective on characters [default to false]

Return type

Vec

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]

put_characters_character_id_contacts

put_characters_character_id_contacts(character_id, standing, contact_ids, datasource, label_ids, token, watched) Edit contacts

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

Parameters

Name Type Description Required Notes
character_id i32 An EVE character ID [required]
standing f32 Standing for the contact [required]
contact_ids Vec A list of contacts [required]
datasource Option<String> The server name you would like data from [default to tranquility]
label_ids Option<Vec> Add custom labels to the contact
token Option<String> Access token to use if unable to set a header
watched Option<bool> Whether the contact should be watched, note this is only effective on characters [default to false]

Return type

(empty response body)

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]