Skip to content

Latest commit

 

History

History
779 lines (493 loc) · 20.1 KB

File metadata and controls

779 lines (493 loc) · 20.1 KB

\ApplicationGroupsAPI

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

Method HTTP request Description
AllianceGroupsBulkV1 Post /app/v1/alliance-groups Return groups of multiple alliances.
AllianceGroupsV1 Get /app/v1/alliance-groups/{aid} Return groups of the alliance.
AllianceGroupsV2 Get /app/v2/alliance-groups/{aid} Return groups of the alliance.
CorpGroupsBulkV1 Post /app/v1/corp-groups Return groups of multiple corporations.
CorpGroupsV1 Get /app/v1/corp-groups/{cid} Return groups of the corporation.
CorpGroupsV2 Get /app/v2/corp-groups/{cid} Return groups of the corporation.
GroupMembersV1 Get /app/v1/group-members/{groupId} Returns the main character IDs from all group members.
GroupsBulkV1 Post /app/v1/groups Return groups of multiple players, identified by one of their character IDs.
GroupsV1 Get /app/v1/groups/{cid} Return groups of the character's player account.
GroupsV2 Get /app/v2/groups/{cid} Return groups of the character's player account.
GroupsWithFallbackV1 Get /app/v1/groups-with-fallback Returns groups from the character's account, if available, or the corporation and alliance.

AllianceGroupsBulkV1

[]Alliance AllianceGroupsBulkV1(ctx).RequestBody(requestBody).Execute()

Return groups of multiple alliances.

Example

package main

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

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

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

Path Parameters

Other Parameters

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

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

Return type

[]Alliance

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]

AllianceGroupsV1

[]Group AllianceGroupsV1(ctx, aid).Execute()

Return groups of the alliance.

Example

package main

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

func main() {
	aid := int32(56) // int32 | EVE alliance ID.

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

[]Group

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]

AllianceGroupsV2

[]Group AllianceGroupsV2(ctx, aid).Execute()

Return groups of the alliance.

Example

package main

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

func main() {
	aid := int32(56) // int32 | EVE alliance ID.

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

[]Group

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]

CorpGroupsBulkV1

[]Corporation CorpGroupsBulkV1(ctx).RequestBody(requestBody).Execute()

Return groups of multiple corporations.

Example

package main

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

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

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

Path Parameters

Other Parameters

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

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

Return type

[]Corporation

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]

CorpGroupsV1

[]Group CorpGroupsV1(ctx, cid).Execute()

Return groups of the corporation.

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

[]Group

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]

CorpGroupsV2

[]Group CorpGroupsV2(ctx, cid).Execute()

Return groups of the corporation.

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

[]Group

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]

GroupMembersV1

[]int32 GroupMembersV1(ctx, groupId).Corporation(corporation).Execute()

Returns the main character IDs from all group members.

Example

package main

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

func main() {
	groupId := int32(56) // int32 | Group ID.
	corporation := int32(56) // int32 | Limit to characters that are a member of this corporation. (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

corporation | int32 | Limit to characters that are a member of this corporation. |

Return type

[]int32

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]

GroupsBulkV1

[]CharacterGroups GroupsBulkV1(ctx).RequestBody(requestBody).Execute()

Return groups of multiple players, identified by one of their 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.ApplicationGroupsAPI.GroupsBulkV1(context.Background()).RequestBody(requestBody).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationGroupsAPI.GroupsBulkV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GroupsBulkV1`: []CharacterGroups
	fmt.Fprintf(os.Stdout, "Response from `ApplicationGroupsAPI.GroupsBulkV1`: %v\n", resp)
}

Path Parameters

Other Parameters

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

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

Return type

[]CharacterGroups

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]

GroupsV1

[]Group GroupsV1(ctx, cid).Execute()

Return groups of the character's player account.

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.ApplicationGroupsAPI.GroupsV1(context.Background(), cid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationGroupsAPI.GroupsV1``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GroupsV1`: []Group
	fmt.Fprintf(os.Stdout, "Response from `ApplicationGroupsAPI.GroupsV1`: %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 apiGroupsV1Request struct via the builder pattern

Name Type Description Notes

Return type

[]Group

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]

GroupsV2

[]Group GroupsV2(ctx, cid).Execute()

Return groups of the character's player account.

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.ApplicationGroupsAPI.GroupsV2(context.Background(), cid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ApplicationGroupsAPI.GroupsV2``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GroupsV2`: []Group
	fmt.Fprintf(os.Stdout, "Response from `ApplicationGroupsAPI.GroupsV2`: %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 apiGroupsV2Request struct via the builder pattern

Name Type Description Notes

Return type

[]Group

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]

GroupsWithFallbackV1

[]Group GroupsWithFallbackV1(ctx).Character(character).Corporation(corporation).Alliance(alliance).Execute()

Returns groups from the character's account, if available, or the corporation and alliance.

Example

package main

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

func main() {
	character := int32(56) // int32 | EVE character ID.
	corporation := int32(56) // int32 | EVE corporation ID.
	alliance := int32(56) // int32 | EVE alliance ID. (optional)

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

Path Parameters

Other Parameters

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

Name Type Description Notes
character int32 EVE character ID.
corporation int32 EVE corporation ID.
alliance int32 EVE alliance ID.

Return type

[]Group

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]