SWDB/application/API/v2/help/api.php

<?php
    /**
     * @var mixed[] $API API help structure.
     */
    $API = [
        "version" => 2,
        "category" => [
            [ // BEGIN CATEGORY Profile
                "name" => "Profile",
                "command" => [
                    [ // BEGIN COMMAND UploadProfile
                        "name" => "UploadProfile",
                        "type" => "POST",
                        "url" => "/upload_profile/",
                        "description" => "Upload and refreshes a player profile.",
                        "parameter" => [
                            [
                                "key" => "key",
                                "type" => "int",
                                "description" => "User API key.",
                                "optional" => false
                            ],
                            [
                                "key" => "data",
                                "type" => "string",
                                "description" => "Response received from server on HubUserLogin.",
                                "optional" => false
                            ]
                        ],
                        "success" =>[
                            [
                                "status" => "204",
                                "description" => "Profile hast been uploaded",
                                "example" => null
                            ]
                        ],
                        "error" =>[
                            [
                                "status" => "400",
                                "description" => "Data could not be parsed.",
                                "example" => null
                            ],
                            [
                                "status" => "401",
                                "description" => "Player doesn't exist or an invalid API key was provided.",
                                "example" => null
                            ]
                        ]
                    ] // END COMMAND UploadProfile
                ]
            ], // END CATEGORY Profile
            [ // BEGIN CATEGORY Unit
                "name" => "Units",
                "command" => [
                    [ // BEGIN COMMAND GetUnits
                        "name" => "GetUnits",
                        "type" => "GET",
                        "url" => "/units/<player_id>/",
                        "description" => "Request Player's unit list.",
                        "parameter" => [
                            [
                                "key" => "player_id",
                                "type" => "int",
                                "description" => "Unique player ID.",
                                "optional" => false
                            ],
                            [
                                "key" => "key",
                                "type" => "int",
                                "description" => "API key. Mandatory for private users.",
                                "optional" => true
                            ]
                        ],
                        "success" =>[
                            [
                                "status" => "200",
                                "description" => "JSON formatted unit list, with ID and URL.",
                                "example" => json_encode('[{"id":6275532969,"uri":"/API/v2/units/8114048/6275532969"},{"id":6275661927,"uri":"/API/v2/units/8114048/6275661927"}]', JSON_PRETTY_PRINT),
                            ],
                            [
                                "status" => "204",
                                "description" => "The player has no units",
                                "example" => null
                            ],
                        ],
                        "error" =>[
                            [
                                "status" => "400",
                                "description" => "No user ID specified",
                                "example" => null
                            ],
                            [
                                "status" => "401",
                                "description" => "Player doesn't exist or player is private and no (or invalid) API key was provided.",
                                "example" => null
                            ]
                        ]
                    ], // END COMMAND GetUnits
                    [ // BEGIN COMMAND UnitDetails
                        "name" => "UnitDetails",
                        "type" => "GET",
                        "url" => "/units/<player_id>/<unit_id>",
                        "description" => "Request unit details.",
                        "parameter" => [
                            [
                                "key" => "player_id",
                                "type" => "int",
                                "description" => "Unique player ID.",
                                "optional" => false
                            ],
                            [
                                "key" => "unit_id",
                                "type" => "int",
                                "description" => "Unique unit ID.",
                                "optional" => false
                            ],
                            [
                                "key" => "key",
                                "type" => "int",
                                "description" => "API key. Mandatory for private users.",
                                "optional" => true
                            ]
                        ],
                        "success" =>[
                            [
                                "status" => "200",
                                "description" => "JSON formatted unit list, with ID and URL.",
                                "example" => json_encode('{"uid":8114048,"id":6275661927,"building":0,"unit":19811,"level":40,"stars":6,"hp":9885,"attack":736,"defense":582,"speed":90,"crit_rate":15,"crit_damage":50,"resistance":15,"accuracy":0,"experience":1005420,"exp_gained":0,"exp_gain_rate":0,"costume":0,"source":26,"create_time":"2018-08-0106:11:05","homunculus_name":"","lock":1,"runes":[{"id":14799423798,"type":17,"slot":1,"stars":6,"ancient":0,"level":12,"quality":5,"original_quality":3,"value":32251,"efficiency":69.61666666666667,"max_efficiency":69.61666666666667,"main_stat":3,"main_stat_value":118,"innate_stat":null,"innate_stat_value":0,"substat_1":8,"substat_1_value":12,"substat_1_enchant":0,"substat_1_grind":0,"substat_2":11,"substat_2_value":9,"substat_2_enchant":0,"substat_2_grind":0,"substat_3":9,"substat_3_value":6,"substat_3_enchant":0,"substat_3_grind":0,"substat_4":1,"substat_4_value":233,"substat_4_enchant":0,"substat_4_grind":0},{"id":13751864646,"type":11,"slot":2,"stars":6,"ancient":0,"level":15,"quality":5,"original_quality":3,"value":33949,"efficiency":72.73809523809524,"max_efficiency":72.73809523809524,"main_stat":8,"main_stat_value":42,"innate_stat":null,"innate_stat_value":0,"substat_1":9,"substat_1_value":11,"substat_1_enchant":0,"substat_1_grind":0,"substat_2":2,"substat_2_value":12,"substat_2_enchant":0,"substat_2_grind":0,"substat_3":4,"substat_3_value":8,"substat_3_enchant":1,"substat_3_grind":4,"substat_4":3,"substat_4_value":17,"substat_4_enchant":0,"substat_4_grind":0},{"id":14899061711,"type":11,"slot":3,"stars":6,"ancient":0,"level":15,"quality":5,"original_quality":5,"value":25461,"efficiency":82.14285714285714,"max_efficiency":82.14285714285714,"main_stat":5,"main_stat_value":160,"innate_stat":null,"innate_stat_value":0,"substat_1":11,"substat_1_value":16,"substat_1_enchant":0,"substat_1_grind":0,"substat_2":9,"substat_2_value":6,"substat_2_enchant":0,"substat_2_grind":0,"substat_3":2,"substat_3_value":15,"substat_3_enchant":0,"substat_3_grind":0,"substat_4":12,"substat_4_value":13,"substat_4_enchant":0,"substat_4_grind":0},{"id":13287836357,"type":11,"slot":4,"stars":5,"ancient":0,"level":12,"quality":5,"original_quality":3,"value":18059,"efficiency":62.84013605442177,"max_efficiency":62.84013605442177,"main_stat":2,"main_stat_value":37,"innate_stat":4,"innate_stat_value":7,"substat_1":11,"substat_1_value":11,"substat_1_enchant":0,"substat_1_grind":0,"substat_2":6,"substat_2_value":11,"substat_2_enchant":0,"substat_2_grind":0,"substat_3":12,"substat_3_value":5,"substat_3_enchant":0,"substat_3_grind":0,"substat_4":9,"substat_4_value":3,"substat_4_enchant":0,"substat_4_grind":0},{"id":16006183006,"type":17,"slot":5,"stars":6,"ancient":0,"level":12,"quality":5,"original_quality":4,"value":29875,"efficiency":83.20578231292517,"max_efficiency":83.20578231292517,"main_stat":1,"main_stat_value":1800,"innate_stat":9,"innate_stat_value":4,"substat_1":6,"substat_1_value":22,"substat_1_enchant":0,"substat_1_grind":0,"substat_2":4,"substat_2_value":13,"substat_2_enchant":0,"substat_2_grind":0,"substat_3":2,"substat_3_value":6,"substat_3_enchant":0,"substat_3_grind":0,"substat_4":10,"substat_4_value":6,"substat_4_enchant":0,"substat_4_grind":0},{"id":17822905595,"type":11,"slot":6,"stars":6,"ancient":0,"level":15,"quality":5,"original_quality":3,"value":28856,"efficiency":74.40476190476191,"max_efficiency":74.40476190476191,"main_stat":4,"main_stat_value":63,"innate_stat":null,"innate_stat_value":0,"substat_1":8,"substat_1_value":6,"substat_1_enchant":0,"substat_1_grind":0,"substat_2":9,"substat_2_value":16,"substat_2_enchant":0,"substat_2_grind":0,"substat_3":2,"substat_3_value":7,"substat_3_enchant":0,"substat_3_grind":0,"substat_4":12,"substat_4_value":7,"substat_4_enchant":0,"substat_4_grind":0}],"skills":[{"skill":10606,"level":3},{"skill":10611,"level":5},{"skill":10616,"level":5}]}', JSON_PRETTY_PRINT),
                            ]
                        ],
                        "error" =>[
                            [
                                "status" => "400",
                                "description" => "No user ID specified",
                                "example" => null
                            ],
                            [
                                "status" => "401",
                                "description" => "Player doesn't exist or player is private and no (or invalid) API key was provided.",
                                "example" => null
                            ],
                            [
                                "status" => "404",
                                "description" => "Specified unit doesn't exists or it doesn't belong to the player.",
                                "example" => null
                            ]
                        ]
                    ], // END COMMAND GetUnits
                ]
            ], // END CATEGORY Unit
            [ // BEGIN CATEGORY Run
                "name" => "Runs",
                "command" => [
                    [ // BEGIN COMMAND UploadRunDungeon
                        "name" => "UploadRunDungeon",
                        "type" => "POST",
                        "url" => "/upload_run_dungeon/",
                        "description" => "Registers a Cairos Dungeon run.",
                        "parameter" => [
                            [
                                "key" => "key",
                                "type" => "int",
                                "description" => "User API key.",
                                "optional" => false
                            ],
                            [
                                "key" => "request",
                                "type" => "string",
                                "description" => "Intercepted request, as sent to server on BattleDungeonResult command.",
                                "optional" => false
                            ],
                            [
                                "key" => "response",
                                "type" => "string",
                                "description" => "Intercepted response, as received from server on BattleDungeonResult command.",
                                "optional" => false
                            ]
                        ],
                        "success" =>[
                            [
                                "status" => "201",
                                "description" => "The run has been registered",
                                "example" => null
                            ]
                        ],
                        "error" =>[
                            [
                                "status" => "400",
                                "description" => "Data could not be parsed.",
                                "example" => null
                            ],
                            [
                                "status" => "401",
                                "description" => "Player doesn't exist or an invalid API key was provided.",
                                "example" => null
                            ],
                            [
                                "status" => "409",
                                "description" => "The run is already logged.",
                                "example" => null
                            ]
                        ]
                    ], // END COMMAND UploadRunDungeon
                    [ // BEGIN COMMAND UploadRunScenario
                        "name" => "UploadRunDungeon",
                        "type" => "POST",
                        "url" => "/upload_run_scenario/",
                        "description" => "Registers a Scenario run.",
                        "parameter" => [
                            [
                                "key" => "key",
                                "type" => "int",
                                "description" => "User API key.",
                                "optional" => false
                            ],
                            [
                                "key" => "request",
                                "type" => "string",
                                "description" => "Intercepted request, as sent to server on BattleScenarioResult command.",
                                "optional" => false
                            ],
                            [
                                "key" => "response",
                                "type" => "string",
                                "description" => "Intercepted response, as received from server on BattleScenarioResult command.",
                                "optional" => false
                            ]
                        ],
                        "success" =>[
                            [
                                "status" => "201",
                                "description" => "The run has been registered",
                                "example" => null
                            ]
                        ],
                        "error" =>[
                            [
                                "status" => "400",
                                "description" => "Data could not be parsed.",
                                "example" => null
                            ],
                            [
                                "status" => "401",
                                "description" => "Player doesn't exist or an invalid API key was provided.",
                                "example" => null
                            ],
                            [
                                "status" => "409",
                                "description" => "The run is already logged.",
                                "example" => null
                            ]
                        ]
                    ], // END COMMAND UploadRunScenario
                    [ // BEGIN COMMAND UploadRunDimension
                        "name" => "UploadRunDimension",
                        "type" => "POST",
                        "url" => "/upload_run_dimension/",
                        "description" => "Registers a Dimensional Hole Dungeon run.",
                        "parameter" => [
                            [
                                "key" => "key",
                                "type" => "int",
                                "description" => "User API key.",
                                "optional" => false
                            ],
                            [
                                "key" => "request",
                                "type" => "string",
                                "description" => "Intercepted request, as sent to server on BattleDimensionHoleDungeonResult command.",
                                "optional" => false
                            ],
                            [
                                "key" => "response",
                                "type" => "string",
                                "description" => "Intercepted response, as received from server on BattleDimensionHoleDungeonResult command.",
                                "optional" => false
                            ]
                        ],
                        "success" =>[
                            [
                                "status" => "201",
                                "description" => "The run has been registered",
                                "example" => null
                            ]
                        ],
                        "error" =>[
                            [
                                "status" => "400",
                                "description" => "Data could not be parsed.",
                                "example" => null
                            ],
                            [
                                "status" => "401",
                                "description" => "Player doesn't exist or an invalid API key was provided.",
                                "example" => null
                            ],
                            [
                                "status" => "409",
                                "description" => "The run is already logged.",
                                "example" => null
                            ]
                        ]
                    ], // END COMMAND UploadRunDimension
                    [ // BEGIN COMMAND UploadRunTOA
                        "name" => "UploadRunTOA",
                        "type" => "POST",
                        "url" => "/upload_run_toa/",
                        "description" => "Registers a TOA run.",
                        "parameter" => [
                            [
                                "key" => "key",
                                "type" => "int",
                                "description" => "User API key.",
                                "optional" => false
                            ],
                            [
                                "key" => "request",
                                "type" => "string",
                                "description" => "Intercepted request, as sent to server on BattleTrialTowerResult_v2 command.",
                                "optional" => false
                            ],
                            [
                                "key" => "response",
                                "type" => "string",
                                "description" => "Intercepted response, as received from server on BattleTrialTowerResult_v2 command.",
                                "optional" => false
                            ]
                        ],
                        "success" =>[
                            [
                                "status" => "201",
                                "description" => "The run has been registered",
                                "example" => null
                            ]
                        ],
                        "error" =>[
                            [
                                "status" => "400",
                                "description" => "Data could not be parsed.",
                                "example" => null
                            ],
                            [
                                "status" => "401",
                                "description" => "Player doesn't exist or an invalid API key was provided.",
                                "example" => null
                            ],
                            [
                                "status" => "409",
                                "description" => "The run is already logged.",
                                "example" => null
                            ]
                        ]
                    ], // END COMMAND UploadRunTOA
                ]
            ], // END CATEGORY Run
        ],
    ];
?>