RobCoInc / server

API Server
0 stars 0 forks source link

Running list of required endpoints #7

Open tehp opened 6 years ago

tehp commented 6 years ago

I want to list in this issue every endpoint that needs to exist for the app to pull/post to and from the server.

MorganAriss commented 6 years ago

User Returns

UserPasswordByEmail <--- For login only takes in email returns user password if it exists UserByEmail <--- For after successful login takes in email returns user if it exists UsersByUserId <--- Admin only takes the admins' userId and returns all underlings UsersByCompanyId <---- Admin only takes in a companyId and returns all users of that company

MorganAriss commented 6 years ago

Description Returns

DescriptionByName <--- arrest search takes in a name and returns the descriptions that match it DescriptionByNameWhereUserIdMatches takes in a name and a userId and returns all matching descriptions DescriptionByNameWhereCompanyIdMatches takes in the name of a description and the companyId of a user and returns all matching descriptions

needs a way to take multiple fields and return a list of the closest results. (height, weight, ect...)

MorganAriss commented 6 years ago

Location Returns

LocationByCompanyId <--- admin function takes in the companyId returns all locations made by that company

MorganAriss commented 6 years ago

Shift Returns

ShiftUnassignedByCompanyId <--- admin function takes in a companyId and returns all shifts the are unassigned

UserShift

ShiftByUserId takes in a userId and returns all shifts that are assigned to that user

MorganAriss commented 6 years ago

Arrest Returns

ArrestByUserId takes in a userId and returns all arrests made by that user

ArrestByCompanyId takes in a companyId and returns all arrests made by that company