api_example.md

#1 Sign In

GET    /sign_in

{
	account:string,
	password:string
}

Response

{
	accessToken:string,
	role:String
}

---

#1-2 Sign Out

GET    /sign_out

{
	accessToken:string
}

Response

{
	ok
}

---

#2-1 Get Users

GET    /users

{
	accessToken:string
}

Response

{
	users:
	[
		{
			id:number,
			account:string,
			name:string,
			role:
			{
				id:number,
				name:string
			},
			team:
			{
				id:number,
				name:string
			}
			userForGamePermissions:
			[
				{
					userForGamePermissionId:number,
					game:
					{
						id:number,
						name:string
					},
					canReadMonitor:bool,
					canSetMonitor:bool,
					description:string（主Pic/副Pic/廠商）
				},
				...
			]
		},
		...
	]
}

---

#2-2 Add User

POST    /users

{
	accessToken:string,
	account:string,
	password:string
}

Response

{
	id:number
}

---

#2-3 Edit Password

PATCH    /users/password

{
	accessToken:string,
	id:number,
	oldPassword:string,
	newPassword:string
}

Response

ok

---

#2-4 Delete User

DELETE    /users

{
	accessToken:string,
	id:number
}

Response

ok

---

#2-5 Edit User's Team

PATCH    /users/team

{
	accessToken:string,
	userId:number,
	teamId:number
}

Response

ok

---

#2-6 Edit User's Role

PATCH    /users/role

{
	accessToken:string,
	userId:number,
	roleId:number
}

Response

ok

---

#2-7 Edit User For Game's Permission

PATCH    /users/game

{
	accessToken:string,
	userId:number,
	gameId:number,
	canReadMonitor:bool,
	canSetMonitor:bool,
	description:string（主Pic/副Pic/廠商）
}

Response

{
	userForGamePermissionId:number
}

---

#3-1 GET Permissions

GET    /permissions

{
	accessToken:string
}

Response

{
	permissions:
	[
		{
			id:number,
			description:string
		},
		...
	]
}

---

#4-1 GET Roles

GET    /roles

{
	accessToken:string
}

Response

{
	roles:
	[
		{
			id:number,
			name:string,
			permissions:
			[
				{
					id:number,
					name:string,
					description:string
				},
				...
			]
		},
		...
	]
}

---

#4-2 Add Role

POST    /roles

{
	accessToken:string,
	name:string,
	permissions:
	[
		{
			id:number
		},
		...
	]
}

Response

{
	id:number
}

---

#4-3 Edit Role

PATCH    /roles

{
	accessToken:string,
	id:number,
	permissions:
	[
		{
			id:number
		},
		...
	]
}

Response

ok

---

#4-4 Delete Role

DELETE    /roles

{
	accessToken:string,
	id:number
}

Response

ok

---

#5-1 GET Teams

GET    /teams

{
	accessToken:string
}

Response

{
	teams:
	[
		{
			id:string,
			name:string,
			users:
			[
				{
					id:string,
					name:string,
					isLeader:bool
				},
				...
			]
		},
		...
	]
}

---

#5-2 Add Team

POST    /teams

{
	accessToken:string,
	name:string,
	code（代號）:string
}

Response

{
	id:string
}

---

#5-3 Edit Team

PATCH    /teams

{
	accessToken:string,
	name:string,
	code（代號）:string
}

Response

ok

---

#5-4 Delete Team

DELETE    /teams

{
	accessToken:string,
	id:number
}

Response

ok

---

#6-1 Get Vendors

GET    /vendors

{
	accessToken:string
}

Response

{
	vendors:
	[
		{
			id:number,
			name:string,
			games:
			[
				{
					id:number,
					name:string
				},
				...
			]
		},
		...
	]
}

---

#6-2 Add Vendor

POST    /vendors

{
	accessToken:string,
	name:string,
	code:string（代號）
}

Response

{
	id:number
}

---

#6-3 Edit Vendor's Name

PATCH    /vendors

{
	accessToken:string,
	id:number,
	name:string
}

Response

ok

---

#6-4 Delete Vendor

DELETE    /vendors

{
	accessToken:string,
	id:number
}

Response

ok

---

#7-1 Get Games

GET    /games

{
	accessToken:string
}

Response

{
	games:
	[
		{
			id:number,
			name:string,
			userForGamePermissions:
			[
				{
					id:number,
					user:
					{
						id:number,
						name:string
					}
					canReadMonitor:bool,
					canSetMonitor:bool,
					description:string（主Pic/副Pic/廠商）
				},
			...
			]
		},
		...
	]
}

---

#7-2 Add Game

POST    /games

{
	accessToken:string,
	name:string,
	code:string,
	description:string
}

Response

{
	id:string
}

---

#7-3 Edit Game's Name

PATCH    /games

{
	accessToken:string,
	id:number,
	name:string
}

Response

ok

---

#7-4 Delete Game

DELETE    /games

{
	accessToken:string,
	id:number
}

Response

ok

---