rc_api_process_fetch_achievement_info_response

Parses the response for fetching earn rate information about an achievement.

Syntax

// 11.0+
int rc_api_process_fetch_achievement_info_server_response(
    rc_api_fetch_achievement_info_response_t* response,
    const rc_api_server_response_t* server_response
);

// [deprecated]
int rc_api_process_fetch_achievement_info_response(
    rc_api_fetch_achievement_info_response_t* response,
    const char* server_response
);

Parameters

response

The rc_api_fetch_achievement_info_response_t to construct.

server_response

The body of the HTTP response received from the server.

---

struct rc_api_fetch_achievement_info_response_t
{
  unsigned id;
  unsigned game_id;
  unsigned num_awarded;
  unsigned num_players;

  rc_api_lboard_info_t* recently_awarded;
  unsigned num_recently_awarded;

  rc_api_response_t response;
};

id

The unique identifier of the achievement.

game_id

The unique identifier of the game the achievement is associated to.

num_awarded

The number of times the achievement has been awarded.

num_players

The number of players that have earned at least one achievement in the game.

recently_awarded

An array of rc_api_achievement_awarded_entry_t entries for the user who have most recently earned the achievement.

num_recently_awarded

The number of items in the recently_awarded array.

response

Common server-provided response information. Contains a succeeded flag, and an error_message field.

---

struct rc_api_achievement_awarded_entry_t
{
  const char* username;
  time_t awarded;
}

username

The name of the user associated to the entry.

submitted

When the user was awarded the achievement.

Return value

If the function succeeds, the return value is RC_OK. Otherwise, the error code can be converted to a string using rc_error_str.

• RC_INVALID_JSON - the response was not valid JSON.
• RC_MISSING_VALUE - one or more required fields was not found in the response.

Remarks

The rc_api_fetch_achievement_info_response_t must be destroyed by rc_api_destroy_fetch_achievement_info_response when the caller is done with it.

Minimum version: 10.2.0

See also

rc_api_init_fetch_achievement_info_request

rc_api_destroy_fetch_achievement_info_response