rc_api_process_fetch_all_user_progress_server_response

Parses the response for the user's progress for a console.

Syntax

int rc_api_process_fetch_all_user_progress_server_response(
    rc_api_fetch_all_user_progress_response_t* response,
    const rc_api_server_response_t* server_response
);

Parameters

response

The rc_api_fetch_all_user_progress_response_t to construct.

server_response

The body of the HTTP response received from the server.

---

struct rc_api_fetch_all_user_progress_response_t
{
  rc_api_all_user_progress_entry_t* entries;
  uint32_t num_entries;
  rc_api_response_t response;
};

entries

An array of known games for the console.

num_entries

The number of items in the entries array.

response

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

---

struct rc_api_all_user_progress_entry_t
{
  uint32_t game_id;
  uint32_t num_achievements;
  uint32_t num_unlocked_achievements;
  uint32_t num_unlocked_achievements_hardcore;
};

game_id

The unique identifier of the game.

num_achievements

The number of achievements available in the game.

num_unlocked_achievements

The number of achievements unlocked by the user.

num_unlocked_achievements_hardcore

The number of achievements unlocked by the user in hardcore.

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_all_user_progress_response_t must be destroyed by rc_api_destroy_fetch_all_user_progress_response when the caller is done with it.

Minimum version: 12.0.0

See also

rc_api_init_fetch_all_user_progress_request

rc_api_destroy_fetch_all_user_progress_response