API này chỉ lấy danh sách đơn vị sản phẩm.
Request
- URL:
/productunits - Method: GET
Query Parameter
| Key | Mô tả | Kiểu dữ liệu | Mặc định |
|---|---|---|---|
| company_id | ID công ty | Interger (Bắt buộc) | |
| page | Trang cần lấy dữ liệu (để phân trang) | Interger | 1 |
| limit | Số dữ liệu lấy mỗi trang | Integer | 50 |
| sort_by | Tiêu chí sắp xếp kết quả (xem thêm bên dưới) | String | id |
| sort_type | Thứ tự lấy kết quả | String (ASC hoặc DESC) | ASC |
| keyword | Tìm kiếm từ khóa theo Tên | String | |
| status | Trạng thái (Xem danh sách bên dưới) | Integer | |
| creator_id | ID người tạo đơn vị sản phẩm | Integer |
Các tiêu chí sắp xếp ‹sort_by›
| Giá trị | Mô tả |
|---|---|
| unit_id | Sắp xếp theo ID của đơn vị sản phẩm |
| date_created | Ngày tạo đơn vị sản phẩm |
| date_modified | Ngày chỉnh sửa đơn vị sản phẩm |
Response
Success response
Nếu request thành công, bạn nhận được response với các thông tin sau
| Đối tượng JSON trả về (Content-Type: application/json) - 200 OK | ||
|---|---|---|
| Tên | Mô tả | Kiểu dữ liệu |
| total | Tổng số đơn vị sản phẩm tìm thấy | Integer |
| currentpage | Số trang hiện tại đang lấy kết quả | Integer |
| limit | Số dòng dữ liệu lấy trong một trang | Integer |
| items | Danh sách đơn vị sản phẩm trả về | ProductUnit[] |
| Cấu trúc JSON của đối tượng ‹Unit› | ||
|---|---|---|
| Tên | Mô tả | Kiểu dữ liệu |
| company_id | ID công ty | Integer |
| creator_id | ID người tạo đơn vị sản phẩm | Integer |
| id | ID đơn vị sản phẩm | Integer |
| name | Tên sản phẩm | String |
| description | Mô tả | String |
| is_deleted | Đơn vị đã bị xóa | Integer |
| is_deletedby | ID usẻ đã xóa Đơn vị | Integer |
| status | Trạng thái (Xem danh sách bên dưới) | Integer |
| date_created | Ngày tạo | Integer |
Các trạng thái đơn vị sản phẩm ‹status›
| Giá trị | Mô tả |
|---|---|
| 1 | ENABLE - Có hiệu lực |
| 3 | DISABLE - Vô hiệu lực |
Ví dụ một response json object:
{ "total": 6, "currentpage": 1, "limit": 1, "items": [ { "company_id": 1, "creator_id": 14573, "id": 1574, "name": "Kg", "description": "", "status": 1, "is_deleted": 0, "is_deletedby": 0, "date_deleted": 0, "date_created": 1505286256 } ] } Error response
Nếu response có lỗi thì có thể tham khảo bảng bên dưới để biết các lỗi có thể xuất hiện khi gửi request này:
| HTTP Status | Mã lỗi | Mô tả |
|---|---|---|
| 403 | error_not_permission | Không có quyền truy cập |