Alliance API Layout Suggestion

[Shakyr]

Revamped my suggestion after some research and talking to a few people.

 

Suggestion for the Alliance API endpoints, that introduces a bit of consistency and groups a few related values.

 

api/alliances/

- two options

- summary of basic stats, good for the stat junkies to quickly update

{
	allianceid,
	name,
	color,
	memberCount,
	vacationCount,
	applicantCount,
	score,
	avgscore
}

api/alliances/<allianceid>/

- specific lookup for an alliance

{
	allianceid,
	name,
	acronym,
	color,
	rank,
	memberCount, /* includes those on vacation */
	vacationCount,
	applicantCount, /* includes those on vacation */
	canjoinalliance,
	score,
	avgscore,
	datefounded,
	continent,
	flagurl,
	forumurl,
	ircchan,
	stats {
		gdp,
		cities,
		infrastructure,
		landarea,
		population,
		treasures
	},
	military {
		soldiers,
		tanks,
		aircraft,
		ships,
		missiles,
		nukes
	}
}

I've deliberately left actual members out (officerids, leaderids, heirids), because they really need their own lookup API.

 

api/alliances/<allianceid>/members/

- list of members in the alliance

- includes those on vacation

- excludes applicants

{
	{
		alliancerank, /* by score */
		nationid,
		leader=0/1,
		heir=0/1,
		officer=0/1
	},
	{
		...
	}
}

api/alliances/<allianceid>/leaders/

- list of leaders in the alliance

- includes those on vacation

{
	<nationid>,
	<nationid>,
	...
}

api/alliances/<allianceid>/heirs/

- list of heirs in the alliance

- includes those on vacation

{
	<nationid>,
	<nationid>,
	...
}

api/alliances/<allianceid>/officers/

- list of officers in the alliance

- includes those on vacation

{
	<nationid>,
	<nationid>,
	...
}

api/alliances/<allianceid>/applicants/

- list of applicants in the alliance

- includes those on vacation

{
	<nationid>,
	<nationid>,
	...
}

Edited February 24, 2016 by Shakyr

[Guest Frawley]

aye, some restructuring would be useful.

[Shakyr]

Updated OP