mideveloper / cricfanatasyapi Goto Github PK

Team Leader Board API will return teams by scores in descending order. Team's score will be calculated by summing up players score comprising in a team.

Rest API: /teams/leaderboard
HttpMethod: Get
Authentication: Required
Response:
{
"result": [{
"id": 1,
"name": "team1",
"score": 30,
"team_owner": "S. Ikhlaq",
"team_owner_pic": "http://abc.com/a.jpg"
},
{
"id": 2,
"name": "team2",
"score": 50,
"team_owner": "Jitander",
"team_owner_pic": ""
}
]
}

• Players data migration
• Match schedule migration
• Teams migration
• Players by team migration
• Match stats migration

Get formation will return formation types, formation types are players type mix in a team.
There will be three type of static formations

1. 5 Batsmen, 5 Bowlers, 1 Wicket Keeper
2. 4 Batsmen, 4 Bowlers, 1 Wicket Keeper, 2 All Rounders
3. 3 Batsmen, 5 Bowlers, 2 All Rounders, 1 Wicket Keeper

Rest API: /formations
HttpMethod: Get
Authentication: Required
Response: {
"result": [{
"batsmen": 5,
"bowlers": 5,
"all_rounders": 0,
"wicket_keeper": 1,
"name": "formation1",
"id" : 1
}, {
"batsmen": 4,
"bowlers": 4,
"all_rounders": 2,
"wicket_keeper": 1,
"name": "formation2",
"id" : 2
}, {
"batsmen": 3,
"bowlers": 5,
"all_rounders": 2,
"wicket_keeper": 1,
"name": "formation3",
"id" : 3
}]
}

Create team API will create the team for user of 11 players, comprising with user selection formation.

REST API
HttpMethod: POST
Request Payload:
{
"players" : [1,2,3,4,192,6,7,8,9,10,129],
"name" : "Team 1",
"captain" : 1
}
Response:
{
"result" : {
"id" : 1,
}
}

User must login before using any feature of the site, credentials of users will be same as cogs. Once user gets login, user will be presented an authentication token, through that token user will access Apis of the system.

REST API: /auth/login
HTTP Method: POST
Request Payload: { user_name: "", password: "" }
Response Body: {
"result": {
"id" : 1,
"full_name": "",
"profile_picture": "",
"auth_token": ""}
}