User Profile¶

This is the user profile module.

API: Login¶

Login API

URL: {BASE_URL}/app/<APP_ID>/profile/<MODE>/<USER_ID>/login

Request Method: HTTP POST

Parameter	Mandatory	Type	Description
APP_ID	Yes	Alpha-numeric	The application ID issued by the Playblazer platform when the app was created
secret_key	Yes	Alpha-numeric	The secret key issued by the Playblazer platform when the app was created
MODE	Yes	String	The mode for login - used to identify how to interpret the user id. For example, if the user id is the FB id of the user, the mode should be set to ‘fb’ (or ‘facebook’). Instead, if the user id is the Twitter id, then mode should be set to ‘twitter’. This way, the user authentication can be handled with different (internal or external) authenticators.
USER_ID	Yes	Alpha-numeric	The user ID used to identify user’s profile.
ua:platform	No	String	The platform/OS from which the user is trying to login - something like, ios, android, flash, winrt etc.
ua:plat_ver	No	String	The version of the platform/OS - like 2.3.3, 6.0, 6.1 etc.
ua:app_ver	No	String	The application version
ua:screen_resolution	No	String	The screen resolution of the device (as WxH string) - for example, 240x320
ua:device_id	No	String	The unique device identifier - like UDID (on iOS) or IMEI (on Android) or some such thing
ua:oem_str	No	String	Any platform-sepcific information - for example, manuf-make-model of the device - like “motorola\|razr maxx\|XT910” Upto the application to decide what information to store here and in what format.
fmt	No	String	One of (json \| xml) - the format of output

If the login was successful (i.e. the user profile was loaded), the API call will return the corresponding user profile data in the format specified.

Note

For now, it is set to return only the status; however, it should ideally return the profile details (?).

Attention

This API call DOES NOT create new session(s) for the user - the sessions need to be created explicitly.

The sessions are part of the “sessions” module which is discussed in Sessions module.

Example¶

1. Successful call:

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    -F "ua:app_ver=1.0.1" \
    "http://api.playblazer.com/v1/app/1/profile/fb/kunalg/login"

Output:

{
    "status": "ok"
}

2. Error - user profile does not exist:

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    -F "ua:app_ver=1.0.1" \
    "http://api.playblazer.com/v1/app/1/profile/fb/nonexistent/login"

Output:

{
    "status": "error",
    "error": {
        "message": "User Profile not found",
        "code": -10003,
        "code_str": "E_NO_PROFILE"
    }
}

API: Logout¶

Logout API

URL: {BASE_URL}/app/<APP_ID>/profile/<MODE>/<USER_ID>/logout

Request Method: HTTP POST

Parameter	Mandatory	Type	Description
APP_ID	Yes	Alpha-numeric	The application ID issued by the Playblazer platform when the app was created
secret_key	Yes	Alpha-numeric	The secret key issued by the Playblazer platform when the app was created
MODE	Yes	String	The mode used to identify how to interpret the user id. For example, if the user id is the FB id of the user, the mode should be set to ‘fb’ (or ‘facebook’). Instead, if the user id is the Twitter id, then mode should be set to ‘twitter’. This way, the user authentication can be handled with different (internal or external) authenticators.
USER_ID	Yes	Alpha-numeric	The user ID used to identify user’s profile.
fmt	No	String	One of (json \| xml) - the format of output

For successful logout, the output will just contain status=ok state - of course, in the format that is specified in the API call.

The logout action can be configured to trigger automatic clearing of sessions for the user. By default, it DOES NOT clear the session(s) created for the user.

Example¶

1. Successful call:

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    "http://api.playblazer.com/v1/app/1/profile/fb/kunalg/logout"

Output:

{
    "status": "ok"
}

2. Error - user profile does not exist:

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    "http://api.playblazer.com/v1/app/1/profile/fb/nonexistent/logout"

Output:

{
    "status": "error",
    "error": {
        "message": "User Profile not found",
        "code": -10003,
        "code_str": "E_NO_PROFILE"
    }
}

API: Create New Profile¶

Create New Profile API

URL: {BASE_URL}/app/<APP_ID>/profile/<MODE>/<USER_ID>/new

Request Method: HTTP POST

Parameter	Mandatory	Type	Description
APP_ID	Yes	Alpha-numeric	The application ID issued by the Playblazer platform when the app was created
secret_key	Yes	Alpha-numeric	The secret key issued by the Playblazer platform when the app was created
MODE	Yes	String	The mode used to identify how to interpret the user id. For example, if the user id is the FB id of the user, the mode should be set to ‘fb’ (or ‘facebook’). Instead, if the user id is the Twitter id, then mode should be set to ‘twitter’. This way, the user authentication can be handled with different (internal or external) authenticators.
USER_ID	Yes	Alpha-numeric	The user ID used to identify user’s profile.
attrib:first_name	No	String	The first name of the user
attrib:last_name	No	String	The last name of the user
attrib:email	No	String	The email id of the user
fmt	No	String	One of (json \| xml) - the format of output

If successful, the output will just contain status=ok state in the format that is specified in the API call; otherwise, status=error and error details encoded as explained earlier.

Note

You can add more attributes - even custom attributes - using the same syntax -

attrib:<attrib_name>=<value>

Example¶

1. Successful call (with custom attribute ‘dob’ added):

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    -F "attrib:dob=1974-03-13" \
    "http://api.playblazer.com/v1/app/1/profile/fb/test_profile/new"

Output:

{
    "status": "ok"
}

2. Error - user profile already exists:

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    "http://api.playblazer.com/v1/app/1/profile/fb/test_profile/new"

Output:

{
    "status": "error",
    "error": {
        "message": "Profile for fbid = 'test_profile' already exists",
        "code": -10004,
        "code_str": "E_PROFILE_EXISTS"
    }
}

API: Update Profile¶

Update Profile API

URL: {BASE_URL}/app/<APP_ID>/profile/<MODE>/<USER_ID>

Request Method: HTTP POST

Parameter	Mandatory	Type	Description
APP_ID	Yes	Alpha-numeric	The application ID issued by the Playblazer platform when the app was created
secret_key	Yes	Alpha-numeric	The secret key issued by the Playblazer platform when the app was created
MODE	Yes	String	The mode used to identify how to interpret the user id. For example, if the user id is the FB id of the user, the mode should be set to ‘fb’ (or ‘facebook’). Instead, if the user id is the Twitter id, then mode should be set to ‘twitter’. This way, the user authentication can be handled with different (internal or external) authenticators.
USER_ID	Yes	Alpha-numeric	The user ID used to identify user’s profile.
attrib:first_name	No	String	The first name of the user
attrib:last_name	No	String	The last name of the user
attrib:email	No	String	The email id of the user
fmt	No	String	One of (json \| xml) - the format of output

If successful, the output will just contain status=ok state in the format that is specified in the API call along with a dictionary “attribs” containing all the attributes including updated ones; otherwise, status=error and error details encoded as explained earlier.

Note

You can also update custom attributes - using the same syntax -

attrib:<attrib_name>=<value>

If the attribute doesn’t exist, it’ll be created.

Example¶

1. Successful call (with custom attributes ‘first name’ and ‘last name’ updated):

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    -F "attrib:first_name=Test" \
    -F "attrib:last_name=User" \
    "http://api.playblazer.com/v1/app/1/profile/fb/test_profile"

Output:

{
    "status": "ok",
    "attribs": {
        "twitterid":  null,
        "fbid": "test_profile",
        "last_name": "User",
        "first_name": "Test",
        "email": null,
        "googleid": null,
        "dob": "1974-03-13",
    }
}

2. Error - profile does not exist:

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    -F "attrib:first_name=Test" \
    -F "attrib:last_name=User" \
    "http://api.playblazer.com/v1/app/1/profile/fb/nonexistent"

Output:

{
    "status": "error",
    "error": {
        "message": "User Profile not found",
        "code": -10003,
        "code_str": "E_NO_PROFILE"
    }
}

API: Delete Profile¶

Delete Profile API

URL: {BASE_URL}/app/<APP_ID>/profile/<MODE>/<USER_ID>/delete

Request Method: HTTP POST

Parameter	Mandatory	Type	Description
APP_ID	Yes	Alpha-numeric	The application ID issued by the Playblazer platform when the app was created
secret_key	Yes	Alpha-numeric	The secret key issued by the Playblazer platform when the app was created
MODE	Yes	String	The mode used to identify how to interpret the user id. For example, if the user id is the FB id of the user, the mode should be set to ‘fb’ (or ‘facebook’). Instead, if the user id is the Twitter id, then mode should be set to ‘twitter’. This way, the user authentication can be handled with different (internal or external) authenticators.
USER_ID	Yes	Alpha-numeric	The user ID used to identify user’s profile.
confirm	Yes	ENUM	One of (Y \| y \| N \| n)
fmt	No	String	One of (json \| xml) - the format of output

If successful, the output will just contain status=ok state in the format that is specified in the API call; otherwise, status=error and error details encoded as explained earlier.

Attention

The profile deletion supports soft-delete only. The profile is not actually deleted from the system; instead it’s just marked for deletion. This is so that the leaderboards and scoring system can still retain the references to previous values attached to the profile.

If the same user comes back again and tries to create a new profile using the same attributes (for example, FB id, google id etc.), then earlier profile will be reactivated instead of creating a new fresh profile - the attributes are the same.

Example¶

1. Successful call:

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    -F "confirm=y" \
    "http://api.playblazer.com/v1/app/1/profile/fb/test_profile/delete"

Output:

{
    "status": "ok"
}

API: Get Profile Details¶

Get Profile Details API

URL: {BASE_URL}/app/<APP_ID>/profile/<MODE>/<USER_ID>

Request Method: HTTP GET

Parameter	Mandatory	Type	Description
APP_ID	Yes	Alpha-numeric	The application ID issued by the Playblazer platform when the app was created
secret_key	Yes	Alpha-numeric	The secret key issued by the Playblazer platform when the app was created
MODE	Yes	String	The mode used to identify how to interpret the user id. For example, if the user id is the FB id of the user, the mode should be set to ‘fb’ (or ‘facebook’). Instead, if the user id is the Twitter id, then mode should be set to ‘twitter’. This way, the user authentication can be handled with different (internal or external) authenticators.
USER_ID	Yes	Alpha-numeric	The user ID used to identify user’s profile.
fmt	No	String	One of (json \| xml) - the format of output

This API call returns the profile details for the given <MODE> - <USER_ID> combination. The output will also include list of “scores” (if scoring module is enabled), “active sessions” (if session module is enabled).

Optionally, the application-specific code can add any attributes (like, level completion percentage) to the “profile_scores” dictionary.

Example¶

1. Successful call (note: in the following output, “level_completion” (in percentage) attribute in the “profile_scores” dictionary has been added by the application specific code):

URL Call:

curl "http://api.playblazer.com/v1/app/1/profile/fb/test_profile?secret_key=cb8d878989b9478e96d1b1574a1bf4ec"

Output:

{
    "status": "ok",
    "attribs": {
        "first_name": "a",
        "last_name": "b",
        "deviceid": null,
        "twitterid": null,
        "fbid": "test_profile",
        "email": "c@t.com",
        "googleid": null
    },
    "profile_scores": {
        "played": 0,
        "level": 1,
        "wins": 0,
        "hp": 5,
        "losses": 0,
        "rp": 0,
        "xp": 0,
        "level_completion": 0
    },
    "login_status": "online",
    "active_sessions": [
        {
            "attribs": {},
            "has_rounds": false,
            "users": [
                {
                    "attribs": {
                        "first_name": "Kunal",
                        "last_name": "Gangakhedkar",
                        "dj": "true",
                        "twitterid": null,
                        "fbid": "kunalg",
                        "new_attr": "test",
                        "robot": "metro",
                        "deviceid": null,
                        "email": "kgangakhedkar@gmail.com",
                        "googleid": null
                    },
                    "profile_scores": {
                        "played": 0,
                        "level": 5,
                        "wins": 0,
                        "hp": 9,
                        "losses": 0,
                        "rp": 0,
                        "xp": 20,
                        "level_completion": 75
                    },
                    "state": "waiting"
                },
                {
                    "attribs": {
                        "first_name": "a",
                        "last_name": "b",
                        "deviceid": null,
                        "twitterid": null,
                        "fbid": "test_profile",
                        "email": "c@t.com",
                        "googleid": null
                    },
                    "profile_scores": {
                        "played": 0,
                        "level": 1,
                        "wins": 0,
                        "hp": 5,
                        "losses": 0,
                        "rp": 0,
                        "xp": 0,
                        "level_completion": 0
                    },
                    "state": "game_over"
                }
            ],
            "sess_id": "b58b0b1aaad746479b027fc387fa44a5",
            "start_time": "2013-07-23 12:50:15 +0000",
            "session_scores": [
                {
                    "score": 0,
                    "xp": 0,
                    "hp": 0,
                    "user": {
                        "first_name": "Kunal",
                        "last_name": "Gangakhedkar",
                        "twitterid": null,
                        "fbid": "kunalg",
                        "deviceid": null,
                        "email": "kgangakhedkar@gmail.com",
                        "googleid": null
                    }
                },
                {
                    "score": 0,
                    "xp": 0,
                    "hp": 0,
                    "user": {
                        "first_name": "a",
                        "last_name": "b",
                        "twitterid": null,
                        "fbid": "test_profile",
                        "deviceid": null,
                        "email": "c@t.com",
                        "googleid": null
                    }
                }
            ],
            "round_scores": [
                {
                    "extra": {
                        "custom": {}
                    },
                    "hp": 0,
                    "start_time_timestamp": 1374583815,
                    "score": 34.11,
                    "user": {
                        "attribs": {
                            "first_name": "Kunal",
                            "last_name": "Gangakhedkar",
                            "dj": "true",
                            "twitterid": null,
                            "fbid": "kunalg",
                            "new_attr": "test",
                            "robot": "metro",
                            "deviceid": null,
                            "email": "kgangakhedkar@gmail.com",
                            "googleid": null
                        }
                    },
                    "xp": 0,
                    "start_time": "2013-07-23 12:50:15 +0000"
                },
                {
                    "extra": null,
                    "hp": 0,
                    "start_time_timestamp": 1374583815,
                    "score": null,
                    "user": {
                        "attribs": {
                            "first_name": "a",
                            "last_name": "b",
                            "twitterid": null,
                            "fbid": "test_profile",
                            "deviceid": null,
                            "email": "c@t.com",
                            "googleid": null
                        }
                    },
                    "xp": 0,
                    "start_time": "2013-07-23 12:50:15 +0000"
                }
            ],
            "end_time": "2013-07-23 12:56:29 +0000",
            "end_time_timestamp": 1374584189,
            "is_turn_based": false,
            "start_time_timestamp": 1374583815
        }
    ],
    "deleted": false,
    "joined": "2013-07-23 11:51:55 +0000",
    "app_id": 10001,
    "wallet": {
        "currency": 0
    }
}

API: List Profile Details of other users¶

List Profile Details of other users API

URL: {BASE_URL}/app/<APP_ID>/profile/details

Request Method: HTTP POST

Parameter	Mandatory	Type	Description
APP_ID	Yes	Alpha-numeric	The application ID issued by the Playblazer platform when the app was created
secret_key	Yes	Alpha-numeric	The secret key issued by the Playblazer platform when the app was created
input_fmt	Yes	String	The format in which the input list of users is provided. One of (json \| xml) Right now, only JSON is supported
users	Yes	String	The list of users in JSON format whose profiles are to be returned. The details of each entry in the list are explained below.
fmt	No	String	One of (json \| xml) - the format of output

This API works just like the Get Profile Details API - only for returning a profile details for a whole bunch of users.

The output is also pretty much the same as that of “Get Profile Details” API - except the additional details like “prev_week_results” are not included in the output.

Note

The input to this API call is a JSON formatted list of user identifiers - as (mode, id). Make sure that the input is well-formed JSON string.

The same logic as other regular APIs is used to lookup profiles based on (mode, id) combination. Using it as a tuple allows us to potentially include profiles from different social networks creating a pivot point.

Example¶

1. Successful call:

Like stated in the example in “Get Profile Details”, “level_completion” (in percentage) in “profile_scores” dictionary has been added by application-specific code.

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    -F "input_fmt=json" \
    -F "users=[{\"mode\": \"fb\", \"id\": \"kunalg\"}, {\"mode\": \"fb\", \"id\": \"abcd\"}, {\"mode\": \"google\", \"id\": \"kgangakhedkar\"}, {\"mode\": \"google\", \"id\": \"12345678\"}]" \
    "http://api.playblazer.com/v1/app/1/profile/details"

Output:

{
    "status": "ok",
    "profiles": [
        {
            "attribs": {
                "first_name": "Kunal",
                "last_name": "Gangakhedkar",
                "twitterid": null,
                "fbid": "kunalg",
                "email": "kgangakhedkar@gmail.com",
                "googleid": null,
                "test_attr": "True"
            },
            "profile_scores": {
                "played": 123,
                "level": 6,
                "wins": 38,
                "hp": 8,
                "losses": 13,
                "xp": 0,
                "level_completion": 44.232,
            },
            "active_sessions": [ ],
            "deleted": false,
            "joined": null,
            "app_id": 1
        },
        {
            "attribs": {
                "first_name": "Kunal",
                "last_name": "Gangakhedkar",
                "twitterid": null,
                "fbid": "abcd",
                "email": "kgangakhedkar@gmail.com",
                "googleid": null,
                "test_attr": "True"
            },
            "profile_scores": {
                "played": 118,
                "level": 1,
                "wins": 48,
                "hp": 3,
                "losses": 80,
                "xp": 0,
                "level_completion": 21.232,
            },
            "active_sessions": [ ],
            "deleted": false,
            "joined": null,
            "app_id": 1
        },
        {
            "attribs": {
                "googleid": "kgangakhedkar"
            },
            "profile_scores": {
                "played": 56,
                "level": 2,
                "wins": 60,
                "hp": 100,
                "losses": 55,
                "xp": 0,
                "level_completion": 18.112,
            },
            "active_sessions": [ ],
            "deleted": false,
            "joined": null,
            "app_id": 1
        },
        {
            "attribs": {
                "first_name": null,
                "last_name": null,
                "twitterid": null,
                "fbid": null,
                "email": null,
                "googleid": "12345678"
            },
            "profile_scores": {
                "played": 0,
                "level": 0,
                "wins": 0,
                "hp": 0,
                "losses": 0,
                "xp": 0,
                "level_completion": 0.0,
            },
            "active_sessions": [ ],
            "deleted": false,
            "joined": "2013-01-03 23:16:16",
            "app_id": 1
        }
    ]
}

API: Migrate Profile¶

Migrate Profile API

URL: {BASE_URL}/app/<APP_ID>/profile/<MODE>/<USER_ID>/migrate

Request Method: HTTP POST

Parameter	Mandatory	Type	Description
APP_ID	Yes	Alpha-numeric	The application ID issued by the Playblazer platform when the app was created
secret_key	Yes	Alpha-numeric	The secret key issued by the Playblazer platform when the app was created
MODE	Yes	String	The mode used to identify how to interpret the user id. Currently, profile migration is supported only for “guest” mode”.
USER_ID	Yes	Alpha-numeric	The user ID used to identify user’s profile.
to:mode	Yes	String	The mode of the target profile
to:id	Yes	Alpha-numeric	The user id of the target profile
fmt	No	String	One of (json \| xml) - the format of output

This API migrates all the data-structures to the target profile - provided the target profile does not already exist.

On successful invocation, the API will return status=ok; whereas, in case of failure, the return value will be status=error - with err_code = -10006 and err_str = “E_PROFILE_MIGRATION_FAILED”.

However, if the calling profile (i.e. the “guest” mode profile) does not exist, the error will have err_code = -10003 and err_str = “E_NO_PROFILE”.

After successful invocation, the application should continue using the new profile details (i.e. new “mode” and “id” values) - old profile identifiers will no longer be available.

Example¶

1. Successful call:

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    -F "to:mode=fb" \
    -F "to:id=new_profile_id" \
    "http://api.playblazer.com/v1/app/1/profile/guest/user_1234567/migrate"

Output:

{
    "status": "ok"
}

2. Error - calling profile does not exist:

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    -F "to:mode=fb" \
    -F "to:id=new_profile_id" \
    "http://api.playblazer.com/v1/app/1/profile/guest/user_non_existent/migrate"

Output:

{
    "status": "error",
    "error": {
        "message": "User Profile not found",
        "code": -10003,
        "code_str": "E_NO_PROFILE"
    }
}

3. Error - target profile alread exists:

URL Call:

curl -X POST \
    -F "secret_key=cb8d878989b9478e96d1b1574a1bf4ec" \
    -F "to:mode=fb" \
    -F "to:id=existing_profile" \
    "http://api.playblazer.com/v1/app/1/profile/guest/user_1234567/migrate"

Output:

{
    "status": "error",
    "error": {
        "message": "Target profile 'fbid' = 'existing_profile' already exists",
        "code": -10006,
        "code_str": "E_PROFILE_MIGRATION_FAILED"
    }
}

API: Get user stats¶

Get user stats API

URL: {BASE_URL}/app/<APP_ID>/profile/<MODE>/<USER_ID>/stats

Request Method: HTTP GET

Parameter	Mandatory	Type	Description
APP_ID	Yes	Alpha-numeric	The application ID issued by the Playblazer platform when the app was created
secret_key	Yes	Alpha-numeric	The secret key issued by the Playblazer platform when the app was created
MODE	Yes	String	The mode used to identify how to interpret the user id.
USER_ID	Yes	Alpha-numeric	The user ID used to identify user’s profile.
fmt	No	String	One of (json \| xml) - the format of output

Attention

This API is specific to application - the hosted application code has to fill up the “stats” dictionary. If the application does not provide hooks/functions to fill up the “stats” dictionary, it’ll be returned as “null” in the output.

This API returns the following stats for the given user as “stats” dictionary (field names in brackets in bold):

Challenges (challenge loops) played (challenges_played)
Fights played (fights_played)
Challenges (fights) won (challenges_won)
Challenges (fights) lost (challenges_lost)
Win/loss ratio (win_loss_ratio)
Best challenge time (best_challenge_time)
Robots unlocked (robots_unlocked) - RSF specific field added by the app code
Total time spent in challenges (in seconds) (total_time_spent_in_seconds)

Example¶

1. Successful call:

URL Call:

curl "http://api.playblazer.com/v1/app/1/profile/fb/kunalg/stats?secret_key=cb8d878989b9478e96d1b1574a1bf4ec"

Output:

{
    "status": "ok",
    "stats": {
        "challenges_played": 0,
        "robots_unlocked": 0,
        "win_loss_ratio": 0.9824561403508771,
        "challenges_won": 56,
        "best_challenge_time": 22.233,
        "challenges_lost": 57,
        "fights_played": 198,
        "total_time_spent_in_seconds": 668168
    }
}

API: Get user history¶

Get user history API

URL: {BASE_URL}/app/<APP_ID>/profile/<MODE>/<USER_ID>/history

Request Method: HTTP GET

Parameter	Mandatory	Type	Description
APP_ID	Yes	Alpha-numeric	The application ID issued by the Playblazer platform when the app was created
secret_key	Yes	Alpha-numeric	The secret key issued by the Playblazer platform when the app was created
MODE	Yes	String	The mode used to identify how to interpret the user id.
USER_ID	Yes	Alpha-numeric	The user ID used to identify user’s profile.
start	No	String	The starting point of pagination (default 0)
limit	No	String	No. of records to return (default 10)
order	No	String	Sorting order based on start-time of the challenge. Possible values: desc (descending sort - default) asc
fmt	No	String	One of (json \| xml) - the format of output

Attention

This API is specific to application - the application has to fill up the “history” dictionary. If the application does not provide hooks/functions to fill up the “history” dictionary, it’ll contain following values for the fields (field names in brackets):

Total no. of records found (“total_records”) = 0
Count of records in the current listing (“count”) = 0
Data - actual list of records (“data”) = null

This API returns the information about the challenges/fights played by the given user. Please note that this API returns data about individual fights - and not challenge loops.

The output contains following dictionaries along with “status=ok”:

“paging”: giving the “start” and “limit” params for the next page.
“history”: the list of past challenges/fights played by the user.

The “history” dictionary in the output will contain following details (field names in brackets):

Total no. of records found (“total_records”)
Count of records in the current listing (“count”)
Data - actual list of records (“data”)

Each element in the “data” list has following fields(field names in brackets):

Session id (“sess_id”)
Start time (“start_time”)
End time (“end_time”)
User’s score (“score”)
Opponent’s score (“oppn_score”)
Opponent’s attributes as dictionary (“oppn”)
Result of the fight (“result”) - “win”, “loss”, “tie”, “abandoned”

Example¶

1. Successful call (requesting only 5 records with default sorting - “desc”):

URL Call:

curl "http://api.playblazer.com/v1/app/1/profile/fb/kunalg/history?secret_key=cb8d878989b9478e96d1b1574a1bf4ec&limit=5"

Output:

{
    "status": "ok",
    "paging": {
        "next": {
            "start": 5,
            "limit": 5
        }
    },
    "history": {
        "total_records": 198,
        "count": 5,
        "data": [
            {
                "result": "win",
                "sess_id": "84192fe1955d4dec825fc1c482589c01",
                "start_time": "2013-07-12 10:48:56 +0000",
                "score": 52.24,
                "end_time": "2013-07-12 10:50:37 +0000",
                "oppn_score": 55.24,
                "oppn": {
                    "first_name": "Kunal",
                    "last_name": "Gangakhedkar",
                    "twitterid": null,
                    "fbid": "abcd",
                    "email": "kgangakhedkar@gmail.com",
                    "googleid": null,
                    "test_attr": "True"
                }
            },
            {
                "result": "abandoned",
                "sess_id": "75f727a07a6d42ee81459278e2c938e5",
                "start_time": "2013-07-12 10:40:55 +0000",
                "score": 52.24,
                "end_time": "2013-07-12 10:45:29 +0000",
                "oppn_score": null,
                "oppn": {
                    "googleid": "kgangakhedkar"
                }
            },
            {
                "result": "tie",
                "sess_id": "84192fe1955d4dec825fc1c482589c01",
                "start_time": "2013-07-12 10:39:25 +0000",
                "score": 52.24,
                "end_time": "2013-07-12 10:48:56 +0000",
                "oppn_score": 52.24,
                "oppn": {
                    "first_name": "Kunal",
                    "last_name": "Gangakhedkar",
                    "twitterid": null,
                    "fbid": "abcd",
                    "email": "kgangakhedkar@gmail.com",
                    "googleid": null,
                    "test_attr": "True"
                }
            },
            {
                "result": "abandoned",
                "sess_id": "08b86c45fe6a49f18fbbe02d25b8b706",
                "start_time": "2013-06-14 11:06:33 +0000",
                "score": null,
                "end_time": "2013-06-14 11:06:41 +0000",
                "oppn": { }
            },
            {
                "result": "loss",
                "sess_id": "cc55501e022a4c7d98d57f4548f949ec",
                "start_time": "2013-05-19 16:10:05 +0000",
                "score": 87.33,
                "end_time": "2013-05-19 16:15:28 +0000",
                "oppn_score": 73.33,
                "oppn": {
                    "first_name": "Kunal",
                    "last_name": "Gangakhedkar",
                    "twitterid": null,
                    "fbid": "abcd",
                    "email": "kgangakhedkar@gmail.com",
                    "googleid": null,
                    "test_attr": "True"
                }
            }
        ]
    }
}