VGA Planets

Introduction

How The Website Works

Races

Dashboard

Starmap

Planets

Starships

General Information

Guides

Contributions

Searchable Documentation

API account togglehull


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

Overview of /account/togglehull API call

Toggles the ship hull for a specified officer (by race id). This hull 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 hull for
hullid ID for the hull that is being toggled

Data Returned

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

Data Description
success True
activehulls Comma seperated list of numbers of hulls active for the current race
(e.g. 15,16,17,18,78,79,80,81,82,83,85,104,105,1090,107,1084, )

Notes

Failures

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

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

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

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

Back