Skip to content

Latest commit

 

History

History
400 lines (279 loc) · 18.2 KB

ContactsApi.md

File metadata and controls

400 lines (279 loc) · 18.2 KB

\ContactsApi

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

Method HTTP request Description
DeleteCharactersCharacterIdContacts Delete /v2/characters/{character_id}/contacts/ Delete contacts
GetAlliancesAllianceIdContacts Get /v1/alliances/{alliance_id}/contacts/ Get alliance contacts
GetAlliancesAllianceIdContactsLabels Get /v1/alliances/{alliance_id}/contacts/labels/ Get alliance contact labels
GetCharactersCharacterIdContacts Get /v1/characters/{character_id}/contacts/ Get contacts
GetCharactersCharacterIdContactsLabels Get /v1/characters/{character_id}/contacts/labels/ Get contact labels
GetCorporationsCorporationIdContacts Get /v1/corporations/{corporation_id}/contacts/ Get corporation contacts
GetCorporationsCorporationIdContactsLabels Get /v1/corporations/{corporation_id}/contacts/labels/ Get corporation contact labels
PostCharactersCharacterIdContacts Post /v1/characters/{character_id}/contacts/ Add contacts
PutCharactersCharacterIdContacts Put /v1/characters/{character_id}/contacts/ Edit contacts

DeleteCharactersCharacterIdContacts

DeleteCharactersCharacterIdContacts(ctx, characterId, contactIds, optional) Delete contacts

Bulk delete contacts ---

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
contactIds []int32 A list of contacts to delete
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
contactIds []int32 A list of contacts to delete
datasource string The server name you would like data from [default to tranquility]
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

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]

GetAlliancesAllianceIdContacts

[]GetAlliancesAllianceIdContacts200Ok GetAlliancesAllianceIdContacts(ctx, allianceId, optional) Get alliance contacts

Return contacts of an alliance --- This route is cached for up to 300 seconds --- This route has an available update

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
allianceId int32 An EVE alliance ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
allianceId int32 An EVE alliance ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
page int32 Which page of results to return [default to 1]
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

[]GetAlliancesAllianceIdContacts200Ok

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]

GetAlliancesAllianceIdContactsLabels

[]GetAlliancesAllianceIdContactsLabels200Ok GetAlliancesAllianceIdContactsLabels(ctx, allianceId, optional) Get alliance contact labels

Return custom labels for an alliance's contacts --- This route is cached for up to 300 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
allianceId int32 An EVE alliance ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
allianceId int32 An EVE alliance ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

[]GetAlliancesAllianceIdContactsLabels200Ok

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]

GetCharactersCharacterIdContacts

[]GetCharactersCharacterIdContacts200Ok GetCharactersCharacterIdContacts(ctx, characterId, optional) Get contacts

Return contacts of a character --- This route is cached for up to 300 seconds --- This route has an available update

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
page int32 Which page of results to return [default to 1]
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

[]GetCharactersCharacterIdContacts200Ok

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]

GetCharactersCharacterIdContactsLabels

[]GetCharactersCharacterIdContactsLabels200Ok GetCharactersCharacterIdContactsLabels(ctx, characterId, optional) Get contact labels

Return custom labels for a character's contacts --- This route is cached for up to 300 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

[]GetCharactersCharacterIdContactsLabels200Ok

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]

GetCorporationsCorporationIdContacts

[]GetCorporationsCorporationIdContacts200Ok GetCorporationsCorporationIdContacts(ctx, corporationId, optional) Get corporation contacts

Return contacts of a corporation --- This route is cached for up to 300 seconds --- This route has an available update

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
corporationId int32 An EVE corporation ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
corporationId int32 An EVE corporation ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
page int32 Which page of results to return [default to 1]
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

[]GetCorporationsCorporationIdContacts200Ok

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]

GetCorporationsCorporationIdContactsLabels

[]GetCorporationsCorporationIdContactsLabels200Ok GetCorporationsCorporationIdContactsLabels(ctx, corporationId, optional) Get corporation contact labels

Return custom labels for a corporation's contacts --- This route is cached for up to 300 seconds

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
corporationId int32 An EVE corporation ID
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
corporationId int32 An EVE corporation ID
datasource string The server name you would like data from [default to tranquility]
ifNoneMatch string ETag from a previous request. A 304 will be returned if this matches the current ETag
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

[]GetCorporationsCorporationIdContactsLabels200Ok

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]

PostCharactersCharacterIdContacts

[]int32 PostCharactersCharacterIdContacts(ctx, characterId, contactIds, standing, optional) Add contacts

Bulk add contacts with same settings --- This route has an available update

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
contactIds []int32 A list of contacts
standing float32 Standing for the contact
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
contactIds []int32 A list of contacts
standing float32 Standing for the contact
datasource string The server name you would like data from [default to tranquility]
labelId int64 Add a custom label to the new contact [default to 0]
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
watched bool Whether the contact should be watched, note this is only effective on characters [default to false]
xUserAgent string Client identifier, takes precedence over User-Agent

Return type

[]int32

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]

PutCharactersCharacterIdContacts

PutCharactersCharacterIdContacts(ctx, characterId, contactIds, standing, optional) Edit contacts

Bulk edit contacts with same settings --- This route has an available update

Required Parameters

Name Type Description Notes
ctx context.Context pass through context (authentication, logging, tracing)
characterId int32 An EVE character ID
contactIds []int32 A list of contacts
standing float32 Standing for the contact
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
characterId int32 An EVE character ID
contactIds []int32 A list of contacts
standing float32 Standing for the contact
datasource string The server name you would like data from [default to tranquility]
labelId int64 Add a custom label to the contact, use 0 for clearing label [default to 0]
token string Access token to use if unable to set a header
userAgent string Client identifier, takes precedence over headers
watched bool Whether the contact should be watched, note this is only effective on characters [default to false]
xUserAgent string Client identifier, takes precedence over User-Agent

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]