Get User Profile¶
Returns a User Profile for an account.
← Request¶
GET /profile/<account> [/<path>]
Argument | Description |
---|---|
account |
Account number of the user’s profile. A special value me refers to current user. |
path |
Optionally, adding additional directories to the request would make the service to return only part of the User Profile, by path. |
Please note that profile
scope is required for this request.
→ Response¶
In case of success, a User Profile is returned:
{
<profile object>
}
Response Code | Description |
---|---|
200 OK |
Everything went OK, User Profile follows. |
404 Not found |
This user has yet to upload a user profile, and there no such a user profile. |
Get User Profiles Of Multiple Accounts¶
Returns a User Profile objects for several accounts. Useful when you have a list of users, and need User Profiles for them (for example, a player list).
← Request¶
GET /profiles
Argument | Description |
---|---|
accounts |
A JSON list of account numbers of the user’s profiles (["1", "20", "444"] ) |
Note
Only Public Fields will be returned.
Please note that profile
scope is required for this request.
→ Response¶
In case of success, an object of User Profiles is returned. Those accounts who miss a profile,
will return an empty object {}
.
{
"<account-id>": { profile object },
"<account-id>": { profile object },
"<account-id>": { profile object },
...
}
Response Code | Description |
---|---|
200 OK |
Everything went OK, User Profiles follow. |
Update User Profile¶
Updates a User Profile for an account.
← Request¶
POST /profile/<account> [/<path>]
Argument | Description |
---|---|
account |
Account number of the user’s profile. A special value me refers to current user. |
data |
A Profile Object with updates to the User Profile |
merge |
If true , the fields of the Profile Object will be merged with old values, otherwise the values
that are not mentioned in updates will be deleted as well. |
path |
Optionally, adding additional directories to the request would make the service to update only part of the User Profile, by path. |
Please note that profile_write
scope is required for this request.
→ Response¶
In case of success, a User Profile is updated, and updated value is returned:
{
<profile object>
}
Response Code | Description |
---|---|
200 OK |
Everything went OK, User Profile follows. |
400 Profile Error |
Some of the Functions might have failed |
404 Not found |
This user has yet to upload a user profile, and there no such a user profile. |