StunlockStudios / battlerite-docs

Documentation and Guides
11 stars 1 forks source link

Team data undocumented makes it hard to make 'correct' calls #21

Open aarhusgregersen opened 6 years ago

aarhusgregersen commented 6 years ago

Heya!

I'd love to start contributing more actively to this API, as I am in the process of exploring the API and building an application with it.

That being said, I'm noticing a fallacy in the team call (https://github.com/gamelocker/battlerite-docs/blob/master/source/teams/teams.rst).

First of, I don't know which number for season should be used, I think this could use more documentation. I'm guessing 6, from the example - although the game is actually currently running its first real season? This needs clearing up :)

Second, I used this call: https://api.dc01.gamelockerapp.com/shards/global/teams?tag[season]=6&tag[playerIds]=786946724437581824,786630647182667776 which uses mine and a friends ID, and it returns a lot of teams: Even nameless ones. Why is this?

I do see one, I believe to be a real team, which has the 'name' field filled out, but what are all the 'empty' ones? And why are so many returned?

I'd love clearing this up, I'm unsure if I even make the correct API calls, since the lack of documentation.

I'd love to help fill it out too, if only I knew more!

Let me know how I can help further.

Best

jsmienk commented 6 years ago

When providing more than one player ID, the call will return all teams in which at least one of the provided players participated in. So all your teams and all your friends’ teams. What it does not do is only return the teams in which both players participate.

The reason you get so many empty teams is because it returns all teams (= unique groups of players). So also groups you have only played a single match with (casual or ranked, placed or not). That’s also why the name field is often empty.

aarhusgregersen commented 6 years ago

Awesome!

Maybe I'm the only simpleton in town, but I'll likely add some of this (and your other responses) to docs :)