EI documentations

# User

# Add User

Sử dụng API này để thêm bản ghi mới

# Endpoint

# Parameters

Name Type Description Required
companyId Number get in token payload ✔️
email String ✔️
username String ✔️
password String ✔️
firstName String ➖
lastName String ➖
phone String ➖
address String ➖
avatar String ➖
roleId Number ✔️
supplierId Number ➖
changePassword Number ➖
isActive Number ➖
createdBy Number get in token payload ✔️
updatedBy Number get in token payload ✔️

# Response

{
  "status": true,
  "items": {
    "$rltAdd": [
        {
            ...<data>
        }
    ],
    "$rltUpdate": [],
    "$rltRemove": [],
    "$rltDelete": []
  }
}

curl -X POST http://localhost:3000/user/setList \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <const name="MOCK_TOKEN" />' \
  --data '{
    "items": {
        "$add": [
            {
                "email": "email",
                "username": "username",
                "password": "password",
                "firstName": "firstName",
                "lastName": "lastName",
                "phone": "phone",
                "address": "address",
                "avatar": "avatar",
                "roleId":"roleId",
                "supplierId": "supplierId"
            }
        ]
    }
  }'

# Update Page Content

Sử dụng API này để cập nhật nội dung

# Endpoint

# Parameters

Name Type Description Required
id Number ✔️
companyId Number get in token payload ✔️
email String ✔️
username String ✔️
password String ✔️
firstName String ➖
lastName String ➖
phone String ➖
address String ➖
avatar String ➖
roleId Number ✔️
supplierId Number ➖
changePassword Number ➖
isActive Number ➖
updatedBy Number get in token payload ✔️

# Response

{
  "status": true,
  "items": {
    "$rltAdd": [],
    "$rltUpdate": [
      {
        ...<data>
      }
    ],
    "$rltRemove": [],
    "$rltDelete": []
  }
}

curl -X POST http://localhost:3000/user/setList \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <const name="MOCK_TOKEN" />' \
  --data '{
    "items": {
        "$update": [
            {
                "id": 1,
                "email": "email",
                "username": "username",
                "password": "password",
                "firstName": "firstName",
                "lastName": "lastName",
                "phone": "phone",
                "address": "address",
                "avatar": "avatar",
                "roleId":"roleId",
                "supplierId": "supplierId"
            }
        ]
    }
  }'

# Delete User

Sử dụng API này để xóa bản ghi trên giao diện

# Endpoint

# Parameters

Name Type Description Required
id Number ✔️

# Response

{
  "status": true,
  "items": {
    "$rltAdd": [],
    "$rltUpdate": [],
    "$rltRemove": [],
    "$rltDelete": [
        {
          ...<data>
        }
    ]
  }
}

curl -X POST http://localhost:3000/user/setList \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <const name="MOCK_TOKEN" />' \
  --data '{
    "items": {
        "$delete": [
            {
                "id": 1
            }
        ]
    }
  }'

# Remove User

Sử dụng API này để xóa bản ghi khỏi database

# Endpoint

# Parameters

Name Type Description Required
id Number ✔️

# Response

{
  "status": true,
  "items": {
    "$rltAdd": [],
    "$rltUpdate": [],
    "$rltRemove": [
        {
          ...<data>
        }
    ],
    "$rltDelete": []
  }
}

curl -X POST http://localhost:3000/user/setList \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <const name="MOCK_TOKEN" />' \
  --data '{
    "items": {
        "$remove": [
            {
                "id": 1
            }
        ]
    }
  }'

# Get List User

Sử dụng API này để lấy danh sách User

# Endpoint

# Parameters

Name Type Description Required
companyId Number get in token payload ✔️

# Response

{
  "status": true,
  "message": "success",
  "data": {
    "status": true,
    "message": "success",
    "totalRows": 96,
    "rows": [
      {
        "id": 3,
        "email": "sales@gmail.com",
        "username": "sales",
        "firstName": "sales",
        "lastName": "sales",
        "phone": "02822453525",
        "address": "A01-06 Hoàng Anh River View, 37 Nguyễn Văn Hưởng, Thảo Điền, Thành phố Thủ Đức, TP. HCM",
        "avatar": "User/1/1/1620886308248.jpg",
        "roleId": 1,
        "companyId": 1,
        "supplierId": null,
        "createdBy": 1,
        "updatedBy": 1,
        "changePassword": 0,
        "isActive": 1,
        "createdAt": "2021-06-16T10:16:23.090Z",
        "updatedAt": "2021-09-10T08:35:40.826Z",
        "role": {
          "id": 1,
          "companyId": 1,
          "name": "Administrator",
          "deleted": false,
          "description": "",
          "createdBy": 1,
          "updatedBy": 1,
          "createdAt": "2021-08-04T03:32:49.000Z",
          "updatedAt": "2021-08-04T03:32:49.000Z"
        }
      },
      {
        ...<data>
      }
    ]
  }
}

curl -X POST http://localhost:3000/user/getListPaging \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <const name="MOCK_TOKEN" />' \
  --data '{}'

← Voucher →