API Documentation

AIIMS IMS API v0.0.1

The API backend for the AIIMS Inventory Management System

• Item

  • 1.1 Request all items
  • 1.2 Add a new item
  • 2.1 Request item information
  • 2.2 Change item information
  • 2.3 Delete item

• Login

  • 1.1 Request login token

• Search

  • 1.1 Search for users
  • 1.2 Search for items

• User

  • 1.1 Request all users' information
  • 1.2 Add a new user
  • 2.1 Request user information
  • 2.2 Change user information
  • 2.3 Delete user

Item

2.3 Delete item

DELETE /item/:id

Parameters

Name	Type	Description
id	Number	The id of item to be deleted

Error Response

Error:

{
    "status": "Error status code",
    "message": "Error Message"
}:

2.1 Request item information

This can be used to get item details

GET /item/:id

Parameters

Name	Type	Description
id	String	The id of the item

Error Response

Error:

{
    "status": "Error status code",
    "message": "Error Message"
}

1.1 Request all items

GET /item?params

Parameters

Name	Type	Description
page		The page number of items
size		The number of items on each page
sort		The field to sort according to
order		The order to sort with 'asc' or 'desc'

Error Response

Error:

{
    "status": "Error status code",
    "message": "Error Message"
}

1.2 Add a new item

This can only by used by admin to add a new item

POST /item

2.2 Change item information

PUT /item/:id

Parameters

Name	Type	Description
item	Number	The id of the item to be changed
parameter	Type	The parameter to change

Error Response

Error:

{
    "status": "Error status code",
    "message": "Error Message"
}

Login

1.1 Request login token

Sending a post to this route will return a login token which should be sent with every request to access data. There is no need for logout since the token expires after a fixed time anyway

POST /auth

Success Response

Success:

{
     "token": "an access token"
}

Error Response

Error:

{
    "status": "Error status code",
    "message": "Error Message"
}

Search

1.2 Search for items

GET /search/items?params

Parameters

Name	Type	Description
query		The query to search for
limit		The number of items in result
sort		The field to sort according to
order		The order to sort with 'asc' or 'desc'

Success Response

Success:

{
    "status": "Status code",
    "data": [{Objects}]
}

Error Response

Error:

{
    "status": "Error status code",
    "message": "Error Message"
}

1.1 Search for users

GET /search/users?params

Parameters

Name	Type	Description
query		The query to search for
limit		The number of items in result
sort		The field to sort according to
order		The order to sort with 'asc' or 'desc'

Success Response

Success:

{
    "status": "Status code",
    "data": [{Objects}]
}

Error Response

Error:

{
    "status": "Error status code",
    "message": "Error Message"
}

User

2.3 Delete user

DELETE /user/:id

Parameters

Name	Type	Description
username	Number	The username to be deleted

Error Response

Error:

{
    "status": "Error status code",
    "message": "Error Message"
}

1.1 Request all users' information

This can only by used by admin to get the imformation about all users in one place.

GET /user/

Success Response

Success:

[{
    "name": "User Name",
    "role": "User Role"
}]

Error Response

Error:

{
    "status": "Error status code",
    "error": "Error Message"
}

2.1 Request user information

This can be used to get user details

GET /user/:id

Parameters

Name	Type	Description
username	Number	The username of the user

Success Response

Success:

{
    "name": "Name",
    "username": "Username",
    "role": "User Role"
}

Error Response

Error:

{
    "status": "Error status code",
    "error": "Error Message"
}

1.2 Add a new user

This can only by used by admin to add a new user

POST /user/

2.2 Change user information

PUT /user/:id

Parameters

Name	Type	Description
username	Number	The username to be changed
name	String	(optional) New name

Success Response

Success:

{
    "id": "User ID",
    "name": "New Name",
    "role": "User Role"
}

Error Response

Error:

{
    "status": "Error status code",
    "error": "Error Message"
}