locations

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 1, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

API Actor api for managing locations

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ItemLocation

type ItemLocation struct {
	// Grid ID
	GID uint64 `json:"gid"`

	// ID
	ID uint64 `json:"id"`

	// GUID
	GUID uint64 `json:"guid"`

	// Location code
	LocationCode string `json:"locationCode"`

	// Name
	Name string `json:"name"`

	// Flag
	Flag string `json:"flag"`

	// Meta
	Meta []interface{} `json:"_meta"`

	// CKey
	CKey string `json:"_ckey"`
}

Main information about locations

type ListLocations

type ListLocations []ItemLocation

List of locations

type ListRequest

type ListRequest struct {
	// Page number
	// Required: false
	Page uint64 `url:"page,omitempty" json:"page,omitempty"`

	// Page size
	// Required: false
	Size uint64 `url:"size,omitempty" json:"size,omitempty"`
}

Request struct for get list of locations

type Locations

type Locations struct {
	// contains filtered or unexported fields
}

Structure for creating request to locations

func New

func New(client interfaces.Caller) *Locations

Builder for locations endpoints

func (Locations) GetURL

func (l Locations) GetURL(ctx context.Context) (string, error)

GetURL gets the portal URL

func (Locations) List

List gets list all locations

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL