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

Commit 2322b93

Browse files
committed
Merge User Settings API to My Profile API
1 parent ffe82a6 commit 2322b93

File tree

1 file changed

+43
-91
lines changed

1 file changed

+43
-91
lines changed

apiary.apib

Lines changed: 43 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1063,7 +1063,49 @@ Register a new user.
10631063
"address": "address1, city, Maine, 04043, United States",
10641064
"age": "25 - 34",
10651065
"gender": "Male",
1066-
"shirt_size": "Medium"
1066+
"shirt_size": "Medium",
1067+
"privacy": {
1068+
"showMySchool": "Yes",
1069+
"showMyEarnings": "No",
1070+
"receiveMessages": "Yes",
1071+
"messageBlackList": ["handleA", "handleB"]
1072+
},
1073+
"emailNotification": {
1074+
"competitionAnnouncements": {
1075+
"algorithmCompetitions": "No",
1076+
"softwareDevelopmentOpportunities": "Yes",
1077+
"topCoderStudioCompetitions": "No"
1078+
},
1079+
"others": {
1080+
"employmentOpportunities": "Yes",
1081+
"topCoderNewsAndEvents": "Yes",
1082+
"topCoderDesignStudioNewsletter": "No"
1083+
}
1084+
},
1085+
"demographic": {
1086+
"nonEnglishName": "name1",
1087+
"jobTitle": "Lorem ipsum",
1088+
"company": "company1",
1089+
"country": "Indonesia",
1090+
"representedCountry": "Indonesia",
1091+
"phone": "555555",
1092+
"timeZone": "US/Central",
1093+
"age": "18 - 25",
1094+
"gender": "Male",
1095+
"ethnicBackground": "Asian or Pacific Islander",
1096+
"primaryInterest": "Creative Competition",
1097+
"shirtSize": "Small",
1098+
"collegeMajor": "Computer Science",
1099+
"collegeMajorDescription": "Software Design",
1100+
"degreeProgram": "Bachelors",
1101+
"graduationDate": "21/02/2011",
1102+
"clubsOrOrganizations": "None",
1103+
"school": "Harvard University",
1104+
"gpa": 3.5,
1105+
"gpaScale": 5,
1106+
"isStudent": "Yes",
1107+
"isProfessional": "No"
1108+
}
10671109
}
10681110

10691111
+ Response 400 (application/json)
@@ -1375,96 +1417,6 @@ Register a new user.
13751417
"description":"Unknown server error. Please contact support."
13761418
}
13771419

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 Settings [/users/settings]
1387-
### User Settings [GET]
1388-
1389-
+ Response 200 (application/json)
1390-
1391-
{
1392-
"privacy": {
1393-
"showMySchool": "Yes",
1394-
"showMyEarnings": "No",
1395-
"receiveMessages": "Yes",
1396-
"messageBlackList": ["handleA", "handleB"]
1397-
},
1398-
"emailNotification": {
1399-
"competitionAnnouncements": {
1400-
"algorithmCompetitions": "No",
1401-
"softwareDevelopmentOpportunities": "Yes",
1402-
"topCoderStudioCompetitions": "No"
1403-
},
1404-
"others": {
1405-
"employmentOpportunities": "Yes",
1406-
"topCoderNewsAndEvents": "Yes",
1407-
"topCoderDesignStudioNewsletter": "No"
1408-
}
1409-
},
1410-
"demographic": {
1411-
"nonEnglishName": "name1",
1412-
"jobTitle": "Lorem ipsum",
1413-
"company": "company1",
1414-
"country": "Indonesia",
1415-
"representedCountry": "Indonesia",
1416-
"phone": "555555",
1417-
"timeZone": "US/Central",
1418-
"age": "18 - 25",
1419-
"gender": "Male",
1420-
"ethnicBackground": "Asian or Pacific Islander",
1421-
"primaryInterest": "Creative Competition",
1422-
"shirtSize": "Small",
1423-
"collegeMajor": "Computer Science",
1424-
"collegeMajorDescription": "Software Design",
1425-
"degreeProgram": "Bachelors",
1426-
"graduationDate": "21/02/2011",
1427-
"clubsOrOrganizations": "None",
1428-
"school": "Harvard University",
1429-
"gpa": 3.5,
1430-
"gpaScale": 5,
1431-
"isStudent": "Yes",
1432-
"isProfessional": "No"
1433-
}
1434-
}
1435-
1436-
+ Response 400 (application/json)
1437-
1438-
{
1439-
"name":"Bad Request",
1440-
"value":"400",
1441-
"description":"This message will explain why the request is invalid or cannot be served."
1442-
}
1443-
1444-
+ Response 401 (application/json)
1445-
1446-
{
1447-
"name":"Unauthorized",
1448-
"value":"401",
1449-
"description":"Authentication credentials were missing or incorrect."
1450-
}
1451-
1452-
+ Response 403 (application/json)
1453-
1454-
{
1455-
"name":"Forbidden",
1456-
"value":"403",
1457-
"description":"The request is understood, but it has been refused or access is not allowed."
1458-
}
1459-
1460-
+ Response 500 (application/json)
1461-
1462-
{
1463-
"name":"Internal Server Error",
1464-
"value":"500",
1465-
"description":"Unknown server error. Please contact support."
1466-
}
1467-
14681420
+ Response 503 (application/json)
14691421

14701422
{

0 commit comments

Comments
 (0)