Skip to content

Latest commit

 

History

History
211 lines (131 loc) · 2.74 KB

How-to-use-API.md

File metadata and controls

211 lines (131 loc) · 2.74 KB

API Documentation and how to use it.

This documentation is subject to continuous updating. Check frequently for updates.

Readme file can be viewed here as well

Please see respective links below to jump strait to the endpoint you are in need of.

User Endpoin Documentation

Table Of Contents

  1. Register
  2. Login
  3. Get All Users
  4. Get A User
  5. Update A User
  6. Delete A User

POST /users

Request Parameters

  • Expected: Body(Object)
  • Content type: application/json

Example Value

{}

Model

{

}

Responses Parameters

  • Code:
  • Content type: application/json

Example Value

data: {

}

POST /users/login

Request Parameters

  • Expected: Body(Object)
  • Content type: application/json

Example Value

{
  "email": "user@example.com",
  "password": "string"
}

Model

{
email*	    string($email)
password*	string
            minLength: 8
}

Responses Parameters

  • Code: 200
  • Content type: application/json

Example Value

data: { avatar: null email: email, firstName: string, id: string, lastName: string, role: 'Applicant' | 'Admin' token: string, }

GET /users

Request Parameters

  • Expected: Body(Object)
  • Authorization Header: Token?
  • Content type: application/json

Example Value

{}

Model

{

}

Responses Parameters

  • Code:
  • Content type: application/json

Example Value

data: {

}

GET /users/:id

Request Parameters

  • Expected: Body(Object)
  • Authorization Header: Token?
  • Content type: application/json

Example Value

{}

Model

{

}

Responses Parameters

  • Code:
  • Content type: application/json

Example Value

data: {

}

PUT /users/:id

Request Parameters

  • Expected: Body(Object)
  • Authorization Header: Token
  • Content type: application/json

Example Value

{}

Model

{

}

Responses Parameters

  • Code:
  • Content type: application/json

Example Value

data: {

}

DELETE /users/:id

Request Parameters

  • Expected: Body(Object)
  • Authorization Header: Token
  • Content type: application/json

Example Value

{}

Model

{

}

Responses Parameters

  • Code:
  • Content type: application/json

Example Value

data: {

}