Skip to content

ApplicationCharactersAPI.md

Latest commit

 

History

History
919 lines (580 loc) · 24.9 KB

ApplicationCharactersAPI.md

File metadata and controls

919 lines (580 loc) · 24.9 KB
Raw

\ApplicationCharactersAPI

All URIs are relative to https://localhost/api

Method HTTP request Description
CharacterListV1 Post /app/v1/character-list Returns all known characters from the parameter list.
CharactersBulkV1 Post /app/v1/characters Returns all characters from multiple player accounts identified by character IDs.
CharactersV1 Get /app/v1/characters/{characterId} Returns all characters of the player account to which the character ID belongs.
CorporationCharactersV1 Get /app/v1/corp-characters/{corporationId} Returns a list of all known characters from the corporation.
CorporationPlayersV1 Get /app/v1/corp-players/{corporationId} Returns a list of all players that have a character in the corporation.
IncomingCharactersV1 Get /app/v1/incoming-characters/{characterId} Returns all characters that were moved from another account to the player account to which the ID belongs.
MainV1 Get /app/v1/main/{cid} Returns the main character of the player account to which the character ID belongs.
MainV2 Get /app/v2/main/{cid} Returns the main character of the player account to which the character ID belongs.
PlayerCharactersV1 Get /app/v1/player-chars/{playerId} Returns all characters from the player account.
PlayerV1 Get /app/v1/player/{characterId} Returns the player account to which the character ID belongs.
PlayerWithCharactersV1 Get /app/v1/player-with-characters/{characterId} Returns the player account to which the character ID belongs with all characters.
PlayersV1 Post /app/v1/players Returns player accounts identified by character IDs. Can contain the same player several times.
RemovedCharactersV1 Get /app/v1/removed-characters/{characterId} Returns all characters that were removed from the player account to which the character ID belongs.

CharacterListV1

[]Character CharacterListV1(ctx).RequestBody(requestBody).Execute()

Returns all known characters from the parameter list.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	requestBody := []int32{int32(123)} // []int32 | Array with EVE character IDs.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.CharacterListV1(context.Background()).RequestBody(requestBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.CharacterListV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CharacterListV1`: []Character
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.CharacterListV1`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCharacterListV1Request struct via the builder pattern

Name Type Description Notes
requestBody []int32 Array with EVE character IDs.

Return type

[]Character

Authorization

BearerAuth

HTTP request headers

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

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

CharactersBulkV1

[][]int32 CharactersBulkV1(ctx).RequestBody(requestBody).Execute()

Returns all characters from multiple player accounts identified by character IDs.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	requestBody := []int32{int32(123)} // []int32 | EVE character IDs array.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.CharactersBulkV1(context.Background()).RequestBody(requestBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.CharactersBulkV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CharactersBulkV1`: [][]int32
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.CharactersBulkV1`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCharactersBulkV1Request struct via the builder pattern

Name Type Description Notes
requestBody []int32 EVE character IDs array.

Return type

[][]int32

Authorization

BearerAuth

HTTP request headers

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

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

CharactersV1

[]Character CharactersV1(ctx, characterId).Execute()

Returns all characters of the player account to which the character ID belongs.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	characterId := int32(56) // int32 | EVE character ID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.CharactersV1(context.Background(), characterId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.CharactersV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CharactersV1`: []Character
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.CharactersV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
characterId int32 EVE character ID.

Other Parameters

Other parameters are passed through a pointer to a apiCharactersV1Request struct via the builder pattern

Name Type Description Notes

Return type

[]Character

Authorization

BearerAuth

HTTP request headers

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

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

CorporationCharactersV1

[]Character CorporationCharactersV1(ctx, corporationId).Execute()

Returns a list of all known characters from the corporation.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	corporationId := int32(56) // int32 | EVE corporation ID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.CorporationCharactersV1(context.Background(), corporationId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.CorporationCharactersV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CorporationCharactersV1`: []Character
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.CorporationCharactersV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
corporationId int32 EVE corporation ID.

Other Parameters

Other parameters are passed through a pointer to a apiCorporationCharactersV1Request struct via the builder pattern

Name Type Description Notes

Return type

[]Character

Authorization

BearerAuth

HTTP request headers

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

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

CorporationPlayersV1

[]Player CorporationPlayersV1(ctx, corporationId).Execute()

Returns a list of all players that have a character in the corporation.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	corporationId := int32(56) // int32 | EVE corporation ID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.CorporationPlayersV1(context.Background(), corporationId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.CorporationPlayersV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CorporationPlayersV1`: []Player
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.CorporationPlayersV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
corporationId int32 EVE corporation ID.

Other Parameters

Other parameters are passed through a pointer to a apiCorporationPlayersV1Request struct via the builder pattern

Name Type Description Notes

Return type

[]Player

Authorization

BearerAuth

HTTP request headers

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

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

IncomingCharactersV1

[]RemovedCharacter IncomingCharactersV1(ctx, characterId).Execute()

Returns all characters that were moved from another account to the player account to which the ID belongs.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	characterId := int32(56) // int32 | EVE character ID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.IncomingCharactersV1(context.Background(), characterId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.IncomingCharactersV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `IncomingCharactersV1`: []RemovedCharacter
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.IncomingCharactersV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
characterId int32 EVE character ID.

Other Parameters

Other parameters are passed through a pointer to a apiIncomingCharactersV1Request struct via the builder pattern

Name Type Description Notes

Return type

[]RemovedCharacter

Authorization

BearerAuth

HTTP request headers

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

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

MainV1

Character MainV1(ctx, cid).Execute()

Returns the main character of the player account to which the character ID belongs.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	cid := int32(56) // int32 | EVE character ID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.MainV1(context.Background(), cid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.MainV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `MainV1`: Character
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.MainV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cid int32 EVE character ID.

Other Parameters

Other parameters are passed through a pointer to a apiMainV1Request struct via the builder pattern

Name Type Description Notes

Return type

Character

Authorization

BearerAuth

HTTP request headers

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

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

MainV2

Character MainV2(ctx, cid).Execute()

Returns the main character of the player account to which the character ID belongs.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	cid := int32(56) // int32 | EVE character ID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.MainV2(context.Background(), cid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.MainV2``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `MainV2`: Character
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.MainV2`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
cid int32 EVE character ID.

Other Parameters

Other parameters are passed through a pointer to a apiMainV2Request struct via the builder pattern

Name Type Description Notes

Return type

Character

Authorization

BearerAuth

HTTP request headers

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

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

PlayerCharactersV1

[]Character PlayerCharactersV1(ctx, playerId).Execute()

Returns all characters from the player account.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	playerId := int32(56) // int32 | Player ID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.PlayerCharactersV1(context.Background(), playerId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.PlayerCharactersV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PlayerCharactersV1`: []Character
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.PlayerCharactersV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
playerId int32 Player ID.

Other Parameters

Other parameters are passed through a pointer to a apiPlayerCharactersV1Request struct via the builder pattern

Name Type Description Notes

Return type

[]Character

Authorization

BearerAuth

HTTP request headers

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

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

PlayerV1

Player PlayerV1(ctx, characterId).Execute()

Returns the player account to which the character ID belongs.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	characterId := int32(56) // int32 | EVE character ID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.PlayerV1(context.Background(), characterId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.PlayerV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PlayerV1`: Player
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.PlayerV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
characterId int32 EVE character ID.

Other Parameters

Other parameters are passed through a pointer to a apiPlayerV1Request struct via the builder pattern

Name Type Description Notes

Return type

Player

Authorization

BearerAuth

HTTP request headers

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

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

PlayerWithCharactersV1

Player PlayerWithCharactersV1(ctx, characterId).Execute()

Returns the player account to which the character ID belongs with all characters.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	characterId := int32(56) // int32 | EVE character ID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.PlayerWithCharactersV1(context.Background(), characterId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.PlayerWithCharactersV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PlayerWithCharactersV1`: Player
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.PlayerWithCharactersV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
characterId int32 EVE character ID.

Other Parameters

Other parameters are passed through a pointer to a apiPlayerWithCharactersV1Request struct via the builder pattern

Name Type Description Notes

Return type

Player

Authorization

BearerAuth

HTTP request headers

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

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

PlayersV1

[]PlayerWithCharcterId PlayersV1(ctx).RequestBody(requestBody).Execute()

Returns player accounts identified by character IDs. Can contain the same player several times.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	requestBody := []int32{int32(123)} // []int32 | EVE character IDs array.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.PlayersV1(context.Background()).RequestBody(requestBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.PlayersV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PlayersV1`: []PlayerWithCharcterId
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.PlayersV1`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPlayersV1Request struct via the builder pattern

Name Type Description Notes
requestBody []int32 EVE character IDs array.

Return type

[]PlayerWithCharcterId

Authorization

BearerAuth

HTTP request headers

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

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

RemovedCharactersV1

[]RemovedCharacter RemovedCharactersV1(ctx, characterId).Execute()

Returns all characters that were removed from the player account to which the character ID belongs.

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/bravecollective/neucore-api-go"
)

func main() {
	characterId := int32(56) // int32 | EVE character ID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ApplicationCharactersAPI.RemovedCharactersV1(context.Background(), characterId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationCharactersAPI.RemovedCharactersV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RemovedCharactersV1`: []RemovedCharacter
	fmt.Fprintf(os.Stdout, "Response from `ApplicationCharactersAPI.RemovedCharactersV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
characterId int32 EVE character ID.

Other Parameters

Other parameters are passed through a pointer to a apiRemovedCharactersV1Request struct via the builder pattern

Name Type Description Notes

Return type

[]RemovedCharacter

Authorization

BearerAuth

HTTP request headers

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

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