VGA Planets

Introduction

How The Website Works

Races

Dashboard

Starmap

Planets

Starships

General Information

Guides

Contributions

Searchable Documentation

API account toggleadvantage


Introduction —> How The Website Works —> API —> API account toggleadvantage

Overview of /account/toggleadvantage API call

Toggles the advantage for a specified officer (by race id). This advantage can be bought , or it can be Standard issue.

Data Sent

Data Description
apikey Player's existing API key
raceid Race (ID) to toggle the advantage for
advantageid ID for the advantage that is being toggled

Data Returned

If the process is successful, the following response is generated.

Data Description
success True
activeadvantages Comma seperated list of numbers of advantages owned for the active race
(e.g. 24,25,45,49,48,51, )

Notes

Failures

{"success":false,"error":"Missing required parameter - apikey"}

{"success":false,"error":"Missing required parameter - raceid"}

{"success":false,"error":"Missing required parameter - advantageid"}

{"success":false,"error":"Parameter raceid is in an incorrect format."}

{"success":false,"error":"This advantage can not be disabled."}

{"success":false,"error":"Super Spy Command has been retired and is no longer available."}

Back