apiResponse

package
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Jan 8, 2023 License: MIT Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActiveMatchDetail 

type ActiveMatchDetail struct {
	AccountChampionsPlayed uint   `json:"Account_Champions_Played"`
	AccountLevel           uint   `json:"Account_Level"`
	ChampionID             uint   `json:"ChampionId"`
	ChampionLevel          uint   `json:"ChampionLevel"`
	ChampionName           string `json:"ChampionName"`
	MasteryLevel           uint   `json:"Mastery_Level"`
	Match                  uint   `json:"Match"`
	Queue                  uint   `json:"Queue,string"`
	Tier                   uint   `json:"Tier"`
	MapGame                string `json:"mapGame"`
	PlayerCreated          string `json:"playerCreated"`
	PlayerID               uint   `json:"playerId,string"`
	PlayerName             string `json:"playerName"`
	PlayerPortalID         string `json:"playerPortalId"`
	PlayerRegion           string `json:"playerRegion"`
	RetMsg                 string `json:"ret_msg"`
	TaskForce              uint   `json:"taskForce"`
	TierLosses             uint   `json:"tierLosses"`
	TierWins               uint   `json:"tierWins"`
}

ActiveMatchDetail stores data related to a Player in a currently Live Match

type BountyItem 

type BountyItem struct {
	Active          string `json:"active"`
	BountyItemID1   uint   `json:"bounty_item_id1"`
	BountyItemID2   uint   `json:"bounty_item_id2"`
	BountyItemName  string `json:"bounty_item_name"`
	ChampionID      uint   `json:"champion_id"`
	ChampionName    string `json:"champion_name"`
	FinalPrice      string `json:"final_price"`
	InitialPrice    string `json:"initial_price"`
	RetMsg          string `json:"ret_msg"`
	SaleEndDatetime string `json:"sale_end_datetime"`
	SaleType        string `json:"sale_type"`
}

BountyItem stores data related to a Bounty Item in Paladins

type Champion 

type Champion struct {
	Ability1               ChampionAbility `json:"Ability_1"`
	Ability2               ChampionAbility `json:"Ability_2"`
	Ability3               ChampionAbility `json:"Ability_3"`
	Ability4               ChampionAbility `json:"Ability_4"`
	Ability5               ChampionAbility `json:"Ability_5"`
	ChampionAbility1URL    string          `json:"ChampionAbility1_URL"`
	ChampionAbility2URL    string          `json:"ChampionAbility2_URL"`
	ChampionAbility3URL    string          `json:"ChampionAbility3_URL"`
	ChampionAbility4URL    string          `json:"ChampionAbility4_URL"`
	ChampionAbility5URL    string          `json:"ChampionAbility5_URL"`
	ChampionAbilityCardURL string          `json:"ChampionCard_URL"`
	ChampionAbilityIconURL string          `json:"ChampionIcon_URL"`
	Health                 uint            `json:"Health"`
	Lore                   string          `json:"Lore"`
	Name                   string          `json:"Name"`
	NameEnglish            string          `json:"Name_English"`
	OnFreeRotation         string          `json:"OnFreeRotation"`
	OnFreeWeeklyRotation   string          `json:"OnFreeWeeklyRotation"`
	Roles                  string          `json:"Roles"`
	Speed                  uint            `json:"Speed"`
	Title                  string          `json:"Title"`
	AbilityDescription1    string          `json:"abilityDescription1"`
	AbilityDescription2    string          `json:"abilityDescription2"`
	AbilityDescription3    string          `json:"abilityDescription3"`
	AbilityDescription4    string          `json:"abilityDescription4"`
	AbilityDescription5    string          `json:"abilityDescription5"`
	ChampionID             uint            `json:"id"`
	LatestChampion         string          `json:"latestChampion"`
	RetMsg                 string          `json:"ret_msg"`
}

Champion stores data related to an in game Champion

type ChampionAbility 

type ChampionAbility struct {
	Description     string `json:"Description"`
	AbilityID       uint   `json:"Id"`
	Summary         string `json:"Summary"`
	URL             string `json:"URL"`
	DamageType      string `json:"damageType"`
	RechargeSeconds uint   `json:"rechargeSeconds"`
}

ChampionAbility stores data related to a Champion Ability

type ChampionCard 

type ChampionCard struct {
	ActiveFlagActivationSchedule string `json:"active_flag_activation_schedule"`
	ActiveFlagLTI                string `json:"active_flag_lti"`
	CardDescription              string `json:"card_description"`
	CardID1                      uint   `json:"card_id1"`
	CardID2                      uint   `json:"card_id2"`
	CardName                     string `json:"card_name"`
	CardNameEnglish              string `json:"card_name_english"`
	ChampionCardIconURL          string `json:"championIcon_URL"`
	ChampionTalentURL            string `json:"championTalent_URL"`
	ChampionID                   uint   `json:"champion_id"`
	ChampionName                 string `json:"champion_name"`
	Exclusive                    string `json:"exclusive"`
	Rank                         uint   `json:"rank"`
	Rarity                       string `json:"rarity"`
	RechargeSeconds              uint   `json:"recharge_seconds"`
	RetMsg                       string `json:"ret_msg"`
}

ChampionCard stores data related to a Card for a Champion

type ChampionRank 

type ChampionRank struct {
	Assists     uint   `json:"Assists"`
	Deaths      uint   `json:"Deaths"`
	Gold        uint   `json:"Gold"`
	Kills       uint   `json:"Kills"`
	LastPlayed  string `json:"LastPlayed"`
	Losses      uint   `json:"Losses"`
	MinionKills uint   `json:"MinionKills"`
	Minutes     uint   `json:"Minutes"`
	Rank        uint   `json:"Rank"`
	Wins        uint   `json:"Wins"`
	Worshippers uint   `json:"Worshippers"`
	Champion    string `json:"champion"`
	ChampionID  uint   `json:"champion_id,string"`
	PlayerID    uint   `json:"player_id,string"`
	RetMsg      string `json:"ret_msg"`
}

ChampionRank stores data related to player stats for a Champion

type DataUsed 

type DataUsed struct {
	ActiveSessions     uint   `json:"Active_Sessions"`
	ConcurrentSessions uint   `json:"Concurrent_Sessions"`
	RequestDailyLimit  uint   `json:"Request_Limit_Daily"`
	SessionCap         uint   `json:"Session_Cap"`
	SessionTimeLimit   uint   `json:"Session_Time_Limit"`
	TotalRequestsToday uint   `json:"Total_Requests_Today"`
	TotalSessionsToday uint   `json:"Total_Sessions_Today"`
	RetMsg             string `json:"ret_msg"`
}

DataUsed stores data related to how many requests and sessions have been used of the daily cap.

type Friend 

type Friend struct {
	AccountID   uint   `json:"account_id,string"`
	FriendFlags string `json:"friend_flags"`
	Name        string `json:"name"`
	PlayerID    uint   `json:"player_id,string"`
	PortalID    uint   `json:"portal_id,string"`
	RetMsg      string `json:"ret_msg"`
	Status      string `json:"status"`
}

Friend stores data related to a Player's Friend

type HiRezServerStatus 

type HiRezServerStatus struct {
	EntryDatetime string `json:"entry_datetime"`
	Environment   string `json:"environment"`
	LimitedAccess bool   `json:"limited_access"`
	Platform      string `json:"platform"`
	RetMsg        string `json:"ret_msg"`
	Status        string `json:"status"`
	Version       string `json:"version"`
}

HiRezServerStatus stores data related to a HiRez Service's current status.

type Item 

type Item struct {
	Description       string `json:"Description"`
	DeviceName        string `json:"DeviceName"`
	IconID            uint   `json:"IconId"`
	ItemID            uint   `json:"ItemId"`
	Price             uint   `json:"Price"`
	ShortDesc         string `json:"ShortDesc"`
	ChampionID        uint   `json:"champion_id"`
	ItemIconURL       string `json:"itemIcon_URL"`
	ItemType          string `json:"item_type"`
	RechargeSeconds   uint   `json:"recharge_seconds"`
	RetMsg            string `json:"ret_msg"`
	TalentRewardLevel uint   `json:"talent_reward_level"`
}

Item stores data related to an in game Item

type LoadoutItem 

type LoadoutItem struct {
	ItemID   uint   `json:"ItemId"`
	ItemName string `json:"ItemName"`
	Points   uint   `json:"Points"`
}

LoadoutItem stores data related to an Item inside a Loadout

type MatchDetail added in v1.0.1 

type MatchDetail struct {
	AccountLevel        uint   `json:"Account_Level"`
	ActiveID1           uint   `json:"ActiveId1"`
	ActiveID2           uint   `json:"ActiveId2"`
	ActiveID3           uint   `json:"ActiveId3"`
	ActiveID4           uint   `json:"ActiveId4"`
	ActiveLevel1        uint   `json:"ActiveLevel1"`
	ActiveLevel2        uint   `json:"ActiveLevel2"`
	ActiveLevel3        uint   `json:"ActiveLevel3"`
	ActiveLevel4        uint   `json:"ActiveLevel4"`
	ActivePlayerID      uint   `json:"ActivePlayerId,string"`
	Assists             uint   `json:"Assists"`
	BanID1              uint   `json:"BanId1"`
	BanID2              uint   `json:"BanId2"`
	BanID3              uint   `json:"BanId3"`
	BanID4              uint   `json:"BanId4"`
	BanID5              uint   `json:"BanId5"`
	BanID6              uint   `json:"BanId6"`
	ChampionID          uint   `json:"ChampionId"`
	DamageDoneInHand    uint   `json:"Damage_Done_In_Hand"`
	DamageDonePhysical  uint   `json:"Damage_Done_Physical"`
	DamageMitigated     uint   `json:"Damage_Mitigated"`
	DamagePlayer        uint   `json:"Damage_Player"`
	DamageTaken         uint   `json:"Damage_Taken"`
	DamageTakenPhysical uint   `json:"Damage_Taken_Physical"`
	Deaths              uint   `json:"Deaths"`
	EntryDatetime       string `json:"Entry_Datetime"`
	GoldEarned          uint   `json:"Gold_Earned"`
	GoldPerMinute       uint   `json:"Gold_Per_Minute"`
	Healing             uint   `json:"Healing"`
	HealingPlayerSelf   uint   `json:"Healing_Player_Self"`
	ItemID1             uint   `json:"ItemId1"`
	ItemID2             uint   `json:"ItemId2"`
	ItemID3             uint   `json:"ItemId3"`
	ItemID4             uint   `json:"ItemId4"`
	ItemID5             uint   `json:"ItemId5"`
	ItemID6             uint   `json:"ItemId6"`
	ItemLevel1          uint   `json:"ItemLevel1"`
	ItemLevel2          uint   `json:"ItemLevel2"`
	ItemLevel3          uint   `json:"ItemLevel3"`
	ItemLevel4          uint   `json:"ItemLevel4"`
	ItemLevel5          uint   `json:"ItemLevel5"`
	ItemLevel6          uint   `json:"ItemLevel6"`
	KillingSpree        uint   `json:"Killing_Spree"`
	KillsBot            uint   `json:"Kills_Bot"`
	KillsPlayer         uint   `json:"Kills_Player"`
	LeagueLosses        uint   `json:"League_Losses"`
	LeaguePoints        uint   `json:"League_Points"`
	LeagueTier          uint   `json:"League_Tier"`
	LeagueWins          uint   `json:"League_Wins"`
	MapGame             string `json:"Map_Game"`
	MasteryLevel        uint   `json:"Mastery_Level"`
	Match               uint   `json:"Match"`
	MatchDuration       uint   `json:"Match_Duration"`
	Minutes             uint   `json:"Minutes"`
	MultiKillMax        uint   `json:"Multi_kill_Max"`
	ObjectiveAssists    uint   `json:"Objective_Assists"`
	PartyID             uint   `json:"PartyId"`
	Platform            string `json:"Platform"`
	ReferenceName       string `json:"Reference_Name"`
	Region              string `json:"Region"`
	Skin                string `json:"Skin"`
	SkinID              uint   `json:"SkinId"`
	TaskForce           uint   `json:"TaskForce"`
	Team1Score          int    `json:"Team1Score"`
	Team2Score          int    `json:"Team2Score"`
	TeamID              uint   `json:"TeamId"`
	TimeInMatchSeconds  uint   `json:"Time_In_Match_Seconds"`
	WinStatus           string `json:"Win_Status"`
	WinningTaskForce    uint   `json:"Winning_TaskForce"`
	HasReplay           string `json:"hasReplay"`
	MatchQueueID        uint   `json:"match_queue_id"`
	Name                string `json:"name"`
	PlayerID            uint   `json:"playerId,string"`
	PlayerName          string `json:"playerName"`
	PlayerPortalID      uint   `json:"playerPortalId,string"`
	PlayerPortalUserID  uint   `json:"playerPortalUserId,string"`
	RetMsg              string `json:"ret_msg"`
}

MatchDetail stores data related to a Match

type MatchIdsByQueue 

type MatchIdsByQueue struct {
	ActiveFlag    string `json:"Active_Flag"`
	EntryDatetime string `json:"Entry_Datetime"`
	Match         uint   `json:"Match,string"`
	Region        string `json:"Region"`
	RetMsg        string `json:"ret_msg"`
}

Match stores data related to an in game Match

type MergedPlayer 

type MergedPlayer struct {
	MergeDatetime string `json:"merge_datetime"`
	PlayerID      uint   `json:"playerId,string"`
	PortalID      uint   `json:"portalId,string"`
}

MergedPlayer stores data related to merged identites of the same Player on different Platforms

type Player 

type Player struct {
	ActivePlayerID        uint   `json:"ActivePlayerId"`
	AvatarID              uint   `json:"AvatarId"`
	AvatarURL             string `json:"AvatarURL"`
	CreatedDatetime       string `json:"Created_Datetime"`
	HoursPlayed           uint   `json:"HoursPlayed"`
	PlayerID              uint   `json:"Id"`
	LastLoginDatetime     string `json:"Last_Login_Datetime"`
	Leaves                uint   `json:"Leaves"`
	Level                 uint   `json:"Level"`
	LoadingFrame          string `json:"LoadingFrame"`
	Losses                uint   `json:"Losses"`
	MasteryLevel          uint   `json:"MasteryLevel"`
	MinutesPlayed         uint   `json:"MinutesPlayed"`
	Name                  string `json:"Name"`
	PersonalStatusMessage string `json:"Personal_Status_Message"`
	Platform              string `json:"Platform"`
	RankedController      Ranked `json:"RankedController"`
	RankedKBM             Ranked `json:"RankedKBM"`
	Region                string `json:"Region"`
	Title                 string `json:"Title"`
	TotalAchievements     uint   `json:"Total_Achievements"`
	TotalWorshippers      uint   `json:"Total_Worshippers"`
	TotalXP               uint   `json:"Total_XP"`
	Wins                  uint   `json:"Wins"`
	HirezPlayerName       string `json:"hz_player_name"`
	RetMsg                string `json:"ret_msg"`
}

type PlayerLoadout 

type PlayerLoadout struct {
	ChampionID   uint          `json:"ChampionId"`
	ChampionName string        `json:"ChampionName"`
	DeckID       uint          `json:"DeckId"`
	DeckName     string        `json:"DeckName"`
	LoadoutItems []LoadoutItem `json:"LoadoutItems"`
	PlayerID     uint          `json:"playerId"`
	PlayerName   string        `json:"playerName"`
	RetMsg       string        `json:"ret_msg"`
}

PlayerLoadout stores data related to a Player's Champion Loadout

type PlayerMatchHistory 

type PlayerMatchHistory struct {
	ActiveID1           uint   `json:"ActiveId1"`
	ActiveID2           uint   `json:"ActiveId2"`
	ActiveID3           uint   `json:"ActiveId3"`
	ActiveID4           uint   `json:"ActiveId4"`
	ActiveLevel1        uint   `json:"ActiveLevel1"`
	ActiveLevel2        uint   `json:"ActiveLevel2"`
	ActiveLevel3        uint   `json:"ActiveLevel3"`
	ActiveLevel4        uint   `json:"ActiveLevel4"`
	Active1             string `json:"Active_1"`
	Active2             string `json:"Active_2"`
	Active3             string `json:"Active_3"`
	Active4             string `json:"Active_4"`
	Assists             uint   `json:"Assists"`
	Champion            string `json:"Champion"`
	ChampionID          uint   `json:"ChampionId"`
	Damage              uint   `json:"Damage"`
	DamageDoneInHand    uint   `json:"Damage_Done_In_Hand"`
	DamageMitigated     uint   `json:"Damage_Mitigated"`
	DamageTaken         uint   `json:"Damage_Taken"`
	DamageTakenPhysical uint   `json:"Damage_Taken_Physical"`
	Deaths              uint   `json:"Deaths"`
	Gold                uint   `json:"Gold"`
	Healing             uint   `json:"Healing"`
	HealingPlayerSelf   uint   `json:"Healing_Player_Self"`
	ItemID1             uint   `json:"ItemId1"`
	ItemID2             uint   `json:"ItemId2"`
	ItemID3             uint   `json:"ItemId3"`
	ItemID4             uint   `json:"ItemId4"`
	ItemID5             uint   `json:"ItemId5"`
	ItemID6             uint   `json:"ItemId6"`
	ItemLevel1          uint   `json:"ItemLevel1"`
	ItemLevel2          uint   `json:"ItemLevel2"`
	ItemLevel3          uint   `json:"ItemLevel3"`
	ItemLevel4          uint   `json:"ItemLevel4"`
	ItemLevel5          uint   `json:"ItemLevel5"`
	ItemLevel6          uint   `json:"ItemLevel6"`
	KillingSpree        uint   `json:"Killing_Spree"`
	Kills               uint   `json:"Kills"`
	Level               uint   `json:"Level"`
	MapGame             string `json:"Map_Game"`
	Match               uint   `json:"Match"`
	MatchQueueID        uint   `json:"Match_Queue_Id"`
	MatchTime           string `json:"Match_Time"`
	Minutes             uint   `json:"Minutes"`
	MultiKillMax        uint   `json:"Multi_kill_Max"`
	ObjectiveAssists    uint   `json:"Objective_Assists"`
	Queue               string `json:"Queue"`
	Region              string `json:"Region"`
	Skin                string `json:"Skin"`
	SkinID              uint   `json:"SkinId"`
	TaskForce           uint   `json:"TaskForce"`
	Team1Score          int    `json:"Team1Score"`
	Team2Score          int    `json:"Team2Score"`
	TimeInMatchSeconds  uint   `json:"Time_In_Match_Seconds"`
	WardsPlaced         uint   `json:"Wards_Placed"`
	WinStatus           string `json:"Win_Status"`
	WinningTaskForce    uint   `json:"Winning_TaskForce"`
	PlayerID            uint   `json:"playerId"`
	PlayerName          string `json:"playerName"`
	RetMsg              string `json:"ret_msg"`
}

type PlayerStatus 

type PlayerStatus struct {
	Match                 uint   `json:"Match"`
	MatchQueueID          uint   `json:"match_queue_id"`
	PersonalStatusMessage string `json:"personal_status_message"`
	RetMsg                string `json:"ret_msg"`
	Status                uint   `json:"status"`
	StatusString          string `json:"status_string"`
}

PlayerStatus stores data related to a Players current Status

type Ranked 

type Ranked struct {
	Leaves   uint   `json:"Leaves"`
	Losses   uint   `json:"Losses"`
	Name     string `json:"Name"`
	Points   uint   `json:"Points"`
	PrevRank uint   `json:"PrevRank"`
	Rank     uint   `json:"Rank"`
	Season   uint   `json:"Season"`
	Tier     uint   `json:"Tier"`
	Trend    uint   `json:"Trend"`
	Wins     uint   `json:"Wins"`
}

Player stores data related to a Player account

type SearchPlayer 

type SearchPlayer struct {
	Name         string `json:"Name"`
	HZPlayerName string `json:"hz_player_name"`
	PlayerID     uint   `json:"player_id,string"`
	PortalID     uint   `json:"portal_id,string"`
	PrivacyFlag  string `json:"privacy_flag"`
	RetMsg       string `json:"ret_msg"`
}

SearchPlayer stores data related to a searched player

type Session 

type Session struct {
	RetMsg    string `json:"ret_msg"`
	SessionID string `json:"session_id"`
	Timestamp string `json:"timestamp"`
}

Session stores data related to a current HiRezAPI Session.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.