Since we're starting to see a few duplicate threads for requests for various endpoints and stats, it seemed appropriate to aggregate them into a single thread so people can find them quickly and hopefully make it easier for the forum and API dev teams to manage our requests.
NEW ENDPOINT REQUESTS
Requisitions Index
ADDITIONS TO EXISTING ENDPOINTS
Requisition Information
NEW ENDPOINT REQUESTS
Requisitions Index
- Example Path: /metadata/h5/metadata/requisitions
- Provides: An object with keys representing types of requisitions, and values being arrays of all available requisitions for that type.
- Notes: Obtaining IDs is not possible through any other means. The same goes for the requisition pack endpoint, though IDs for that endpoint can be obtained through Spartan rank rewards and commendations,
- Request Thread
- Example Path: /profile/h5/profiles/player-requisitions/{player}
- Provides: An object with keys representing types of requisitions, and values being objects containing the ID of the requisition and the count of how many the given player has.
- Notes: This endpoint could possibly fall under the stats or profile service.
- Request Thread
- Example Path: /stats/h5/stat-breakdown/{matchId}
- Provides: An array of flexible stats objects for the match, containing the flexible stat ID, type, position (x,y,z) and time offset since start of match if applicable, else null.
- Notes: This would include medals and impulses.
- Request Thread
- Example Path: /profile/h5/profiles/player-profile/{player}
- Provides: An object containing the given player's current XP/SR, playlist ranks CSRs, Service Tag, Spartan Company, total suicides, total betrayals, and current commendation progress.
- Notes: Commendations could be pulled out to a separate profile endpoint, similar to the requisitions for player endpoint above.
- Request Thread | Another Thread
- Example Path: /metadata/h5/metadata/all
- Provides: A list of objects containing each metadata endpoint, to save on requests.
- Notes: An (e.g.) only=commendations,campaignMissions,spartanRanks parameter would be useful.
- Request Thread
ADDITIONS TO EXISTING ENDPOINTS
Requisition Information
- Affects: Service Record: Warzone and Post-Game Carnage Report: Warzone.
- Provides:
- To Post Game Carnage Report:
- List of REQ Cards redeemed in match
- To Service Record:
- Total number of REQ Cards redeemed
- Most redeemed REQ Card in matches
- To Post Game Carnage Report:
- Request Thread
- Affects: Player Matches
- Provides: (one solution) a after={matchid} parameter, and the total amount of games in the response.
- Notes: Rationale available in the request thread.
- Request Thread
