APIs

API for scanning platoon screenshots

Give a screenshot, get the requirements out of it. Easy as pie.

Screenshot scanner

POST http://echobaseapp.com/platoonAssigner/screenshot/scan

Scan a screenshot for platoon requirements. The contents of the entire screen must be included in the screenshot. For optimal performance, the recommended screen height should be somewhere between 400px and 500px. Do not send a screenshot with a height under 400px. Slots that have been filled by guild members will be recognized, but not automatically assigned to that member. combatType, affiliation, battle, and phase are all used to improve efficiency by limiting the possible results, and are all optional. You can leave out what you don't know or don't wish to limit. Keep in mind that battle and phase go together and must both be present for either of them to work. Also keep in mind that affiliation will be ignored when combatType = ship.

Query Parameters

Name	Type	Description
phase	number	1 - 6
battle	string	["RebelAssault", "ImperialRetaliation"]
affiliation	string	["Light", "Dark", "NA"]
combatType	string	["Toon", "Ship"]

Request Body

Name	Type	Description
platoonScreenshot	object	This is the uploaded image file. (gitbook does not have a "file" type option)

200

{
    "body": {
        "platoonNumber": 0,
        "platoonScreenshotRequirements": [
            [
                {
                    "displayName": "string",
                    "ggId": "string",
                    "taken": true
                }
            ]
        ]
    },
    "responseCodes": [
        {
            "message": "string",
            "name": "string",
            "type": "Success"
        }
    ],
    "success": true
}

400

{
    "body": null,
    "responseCodes": [
        {
            "name": "YAVIN_IV",
            "message": "The uploaded image must have a height greater than or equal to 400px.",
            "type": "Error"
        }
    ],
    "success": false
}