Skip to content
This repository was archived by the owner on Jan 23, 2025. It is now read-only.

Commit 76e852e

Browse files
committed
Add User Preference API
1 parent dc7ef13 commit 76e852e

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

apiary.apib

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1375,6 +1375,74 @@ Register a new user.
13751375
"description":"Unknown server error. Please contact support."
13761376
}
13771377

1378+
+ Response 503 (application/json)
1379+
1380+
{
1381+
"name":"Service Unavailable",
1382+
"value":"503",
1383+
"description":"Servers are up but overloaded. Try again later."
1384+
}
1385+
1386+
## User Preference [/users/preference/{handle}]
1387+
### User Preference [GET]
1388+
+ Parameters
1389+
+ handle (required, string, `iRabbit`) ... Member Handle
1390+
1391+
+ Response 200 (application/json)
1392+
1393+
{
1394+
"privacy": {
1395+
"showMySchool": "Yes",
1396+
"showMyEarnings": "No",
1397+
"receiveMessages": "Yes",
1398+
"messageBlackList": ["handleA", "handleB"]
1399+
},
1400+
"emailNotification": {
1401+
"competitionAnnouncements": {
1402+
"algorithmCompetitions": "No",
1403+
"softwareDevelopmentOpportunities": "Yes",
1404+
"topCoderStudioCompetitions": "No"
1405+
},
1406+
"others": {
1407+
"employmentOpportunities": "Yes",
1408+
"topCoderNewsAndEvents": "Yes",
1409+
"topCoderDesignStudioNewsletter": "No"
1410+
}
1411+
}
1412+
}
1413+
1414+
+ Response 400 (application/json)
1415+
1416+
{
1417+
"name":"Bad Request",
1418+
"value":"400",
1419+
"description":"This message will explain why the request is invalid or cannot be served."
1420+
}
1421+
1422+
+ Response 401 (application/json)
1423+
1424+
{
1425+
"name":"Unauthorized",
1426+
"value":"401",
1427+
"description":"Authentication credentials were missing or incorrect."
1428+
}
1429+
1430+
+ Response 403 (application/json)
1431+
1432+
{
1433+
"name":"Forbidden",
1434+
"value":"403",
1435+
"description":"The request is understood, but it has been refused or access is not allowed."
1436+
}
1437+
1438+
+ Response 500 (application/json)
1439+
1440+
{
1441+
"name":"Internal Server Error",
1442+
"value":"500",
1443+
"description":"Unknown server error. Please contact support."
1444+
}
1445+
13781446
+ Response 503 (application/json)
13791447

13801448
{

0 commit comments

Comments
 (0)