...
3.3 API Spec: <gắn link tài liệu mô tả API vào đây>
| Panel |
|---|
| title | API Spec Documentlấy danh sách NCC |
|---|
|
Method | GET | URL | application/supplierEvaluation/list |
|---|
Description | API lấy danh sách lịch sử đánh giá |
|---|
Note | API cũ, sửa lại |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | <token> | Token của người dùng đăng nhập | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjY0NTU3ODksInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.wrvIFd-Q2kHgkTmPf6ryMY6aDIgXpNsWmSvvifQWc5k |
2. BodyRequestPathFieldRequire | Data Type / Length | Description | Note | Sample Values |
|---|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | page | true | Integer | trang |
|
| | 2 | limit | true | Integer | số bản ghi cần lấy |
|
| | 3 | evaluationGrade | false | String | Xếp hạng |
|
| | 4 | name | false | String | tên NCC |
|
| | 5 | cityId | false | Integer | id thành phố |
|
| | 6 | businessId | false | Integer | id nghành nghề chính |
|
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | code | Integer | 0: thành công còn lại thất bại |
|
| | 2 | message | String | message |
|
| | 3 | result | Object | kết quả trả ra |
|
| | 4 | (result) total | Integer | số lượng bản ghi |
|
| | 5 | (result) page | Integer | page |
|
| | 6 | (result) items | List<Object> | danh sách bản ghi |
|
| | 7 | (items) id | Integer | id NCC |
|
| | 8 | (items) contactOrg | String | Người liên tục |
|
| | 9 | (items) capacityProfile | String | hồ sơ năng lực |
|
| | 11 | (items) type | Integer | Loại |
|
| | 12 | (items) name | String | tên NCC |
|
| | 13 | (items) taxCode | String | mã số thuế |
|
| | 14 | (items) evaluationGrade | String | Xếp hạng đánh giá |
|
| | 15 | (items) cityId | Integer | thành phố |
|
| | 16 | (items) districtId | Integer | huyện |
|
| | 17 | (items) subdistrictId | Integer | xã |
|
| | 18 | (items) address | String | địa chỉ |
|
| | 19 | (items) legalRepresentative | String | đại diện pháp lý |
|
| | 20 | (items) businessId | Integer | id ngành nghề chính |
|
| | 21 | (items) active | Integer | trạng thái |
|
| | 22 | (items) cityName | String | huyện |
|
| | 23 | (items) districtName | String | thành phố |
|
| | 24 | (items) subdistrictName | String | xã |
|
| | 25 | (items) businessName | String | tên ngành nghề chính |
|
| | 26 | (items) fieldName | String | tên lĩnh vực chính |
|
| | 27 | (items) evaluationGrade | String | xếp hạng |
|
|
|
| Panel |
|---|
| title | API lấy chi tiết NCC |
|---|
|
Method | GET | URL | application/organization/get |
|---|
Description | API chi tiết NCC |
|---|
Note | API cũ, sửa lại |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | <token> | Token của người dùng đăng nhập | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjY0NTU3ODksInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.wrvIFd-Q2kHgkTmPf6ryMY6aDIgXpNsWmSvvifQWc5k |
2. RequestSTT | Field | Require | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | id | true | Integer | id NCC |
|
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | code | Integer | 0: thành công còn lại thất bại |
|
| | 2 | message | String | message |
|
| | 3 | result | Object | kết quả trả ra |
|
| | 4 | (result) id | Integer | id NCC |
|
| | 5 | (result) contactOrg | String | Người liên tục |
|
| | 6 | (result) capacityProfile | String | hồ sơ năng lực |
|
| | 7 | (result) type | Integer | Loại |
|
| | 8 | (result) name | String | tên NCC |
|
| | 9 | (result) taxCode | String | mã số thuế |
|
| | 11 | (result) evaluationGrade | String | Xếp hạng đánh giá |
|
| | 12 | (result) cityId | Integer | thành phố |
|
| | 13 | (result) districtId | Integer | huyện |
|
| | 14 | (result) subdistrictId | Integer | xã |
|
| | 15 | (result) address | String | địa chỉ |
|
| | 16 | (result) legalRepresentative | String | đại diện pháp lý |
|
| | 17 | (result) businessId | Integer | id ngành nghề chính |
|
| | 18 | (result) active | Integer | trạng thái |
|
| | 19 | (result) cityName | String | huyện |
|
| | 20 | (result) districtName | String | thành phố |
|
| | 21 | (result) subdistrictName | String | xã |
|
| | 22 | (result) businessName | String | tên ngành nghề chính |
|
| | 23 | (result) fieldName | String | tên lĩnh vực chính |
|
| | 24 | (result) evaluationGrade | String | xếp hạng |
|
| | 25 | (result) evaluationScore | String | điểm đánh giá |
|
| | 26 | (result) supplierRatingRecommended | String | đề xuất |
|
| | 27 | (result) completionDate | String | ngày hoàn thành |
|
| | 28 | (result) fields | List<Object> | Danh sách Lĩnh vực phụ |
|
| | 29 | (fields) id | Integer | id |
|
| | 30 | (fields) organizationId | Integer | id NCC |
|
| | 31 | (fields) fieldId | Integer | id lĩnh vực |
|
| | 32 | (fields) fieldName | String | tên lĩnh vực |
|
| | 33 | (result) businesses | List<Object> | Danh sách Ngành nghề phụ |
|
| | 34 | (businesses) id | Integer | id |
|
| | 35 | (businesses) organizationId | Integer | id NCC |
|
| | 36 | (businesses) businessId | Integer | id ngành nghề phụ |
|
| | 37 | (businesses) businessName | String | tên ngành nghề phụ |
|
| | 38 | (result) bankAccounts | List<Object> | Danh sách tài khoản ngân hàng |
|
| | 39 | (bankAccounts) id | Integer | id |
|
| | 40 | (bankAccounts) organizationId | Integer | id NCC |
|
| | 41 | (bankAccounts) bankName | String | tên ngân hàng |
|
| | 42 | (bankAccounts) accountNumber | String | số tài khoản |
|
| | 43 | (bankAccounts) accountHolder | String | tên tài khoản |
|
| | 44 | (bankAccounts) isDefault | Integer | đánh dấu có mặc định hay không. 1: mặc định, 0: không mặc định |
|
|
|
| Panel |
|---|
| title | API lấy danh sách các tài khoản ngân hàng của 1 NCC |
|---|
|
Method | GET | URL | application/organization/getBankAccounts |
|---|
Description | API Lấy danh sách các tài khoản ngân hàng của 1 NCC |
|---|
Note | API mới |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | <token> | Token của người dùng đăng nhập | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjY0NTU3ODksInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.wrvIFd-Q2kHgkTmPf6ryMY6aDIgXpNsWmSvvifQWc5k |
2. RequestSTT | Field | Require | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | orgId | true | Integer | id NCC |
|
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | code | Integer | 0: thành công còn lại thất bại |
|
| | 2 | message | String | message |
|
| | 3 | result | List<Object> | kết quả trả ra |
|
| | 4 | (bankAccounts) id | Integer | id NCC |
|
| | 5 | (bankAccounts) organizationId | Integer | id NCC |
|
| | 6 | (bankAccounts) bankName | String | tên ngân hàng |
|
| | 7 | (bankAccounts) accountNumber | String | số tài khoản |
|
| | 8 | (bankAccounts) accountHolder | String | tên tài khoản |
|
| | 9 | (bankAccounts) isDefault | Integer | đánh dấu có mặc định hay không. 1: mặc định, 0: không mặc định |
|
|
|
| Panel |
|---|
|
Method | GET | URL | application/organization/delete |
|---|
Description | API xóa 1 NCC |
|---|
Note | API cũ |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | <token> | Token của người dùng đăng nhập | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjY0NTU3ODksInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.wrvIFd-Q2kHgkTmPf6ryMY6aDIgXpNsWmSvvifQWc5k |
2. RequestSTT | Field | Require | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | id | true | Integer | id NCC |
|
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | code | Integer | 0: thành công còn lại thất bại |
|
| | 2 | message | String | message |
|
|
|
| Panel |
|---|
| title | API thêm mới/ cập nhật NCC |
|---|
|
Method | GET | URL | application/organization/update |
|---|
Description | API thêm mới/ cập nhật NCC |
|---|
Note | API cũ, sửa lại |
|---|
STT | Field | Source Data Type / Length | Description | Sample Values |
|---|
| 1 | authorization | <token> | Token của người dùng đăng nhập | Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3NjY0NTU3ODksInVzZXIiOiJ7XCJpZFwiOjIwMjAsXCJ1c2VybmFtZVwiOlwiMDM3NDc4ODQwNVwiLFwibmFtZVwiOlwiQ2h1IFRo4buLIExpw6puXCIsXCJyb2xlc1wiOltdLFwibWFwQmVhdXR5U2Fsb25cIjp7XCJicG0ucmVib3JuLnZuXCI6Nn0sXCJlbXBsb3llZUlkXCI6NTMxLFwiYnJhbmNoSWRcIjoyM30ifQ.wrvIFd-Q2kHgkTmPf6ryMY6aDIgXpNsWmSvvifQWc5k |
2. RequestSTT | Field | Require | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | id | true | Integer | id NCC |
|
|
3. Response / Incoming Data Specification| STT | Field | Data Type / Length | Description | Note | Sample Values |
|---|
| 1 | code | Integer | 0: thành công còn lại thất bại |
|
| | 2 | message | String | message |
|
| | 3 | result | Object | kết quả trả ra |
|
| | 4 | (result) id | Integer | id NCC |
|
| | 5 | (result) contactOrg | String | Người liên tục |
|
| | 6 | (result) capacityProfile | String | hồ sơ năng lực |
|
| | 7 | (result) type | Integer | Loại |
|
| | 8 | (result) name | String | tên NCC |
|
| | 9 | (result) taxCode | String | mã số thuế |
|
| | 11 | (result) evaluationGrade | String | Xếp hạng đánh giá |
|
| | 12 | (result) cityId | Integer | thành phố |
|
| | 13 | (result) districtId | Integer | huyện |
|
| | 14 | (result) subdistrictId | Integer | xã |
|
| | 15 | (result) address | String | địa chỉ |
|
| | 16 | (result) legalRepresentative | String | đại diện pháp lý |
|
| | 17 | (result) businessId | Integer | id ngành nghề chính |
|
| | 18 | (result) active | Integer | trạng thái |
|
| | 19 | (result) cityName | String | huyện |
|
| | 20 | (result) districtName | String | thành phố |
|
| | 21 | (result) subdistrictName | String | xã |
|
| | 22 | (result) businessName | String | tên ngành nghề chính |
|
| | 23 | (result) fieldName | String | tên lĩnh vực chính |
|
| | 24 | (result) evaluationGrade | String | xếp hạng |
|
| | 25 | (result) evaluationScore | String | điểm đánh giá |
|
| | 26 | (result) supplierRatingRecommended | String | đề xuất |
|
| | 27 | (result) completionDate | String | ngày hoàn thành |
|
| | 28 | (result) fields | List<Object> | Danh sách Lĩnh vực phụ |
|
| | 29 | (fields) id | Integer | id |
|
| | 30 | (fields) organizationId | Integer | id NCC |
|
| | 31 | (fields) fieldId | Integer | id lĩnh vực |
|
| | 32 | (fields) fieldName | String | tên lĩnh vực |
|
| | 33 | (result) businesses | List<Object> | Danh sách Ngành nghề phụ |
|
| | 34 | (businesses) id | Integer | id |
|
| | 35 | (businesses) organizationId | Integer | id NCC |
|
| | 36 | (businesses) businessId | Integer | id ngành nghề phụ |
|
| | 37 | (businesses) businessName | String | tên ngành nghề phụ |
|
| | 38 | (result) bankAccounts | List<Object> | Danh sách tài khoản ngân hàng |
|
| | 39 | (bankAccounts) id | Integer | id |
|
| | 40 | (bankAccounts) organizationId | Integer | id NCC |
|
| | 41 | (bankAccounts) bankName | String | tên ngân hàng |
|
| | 42 | (bankAccounts) accountNumber | String | số tài khoản |
|
| | 43 | (bankAccounts) accountHolder | String | tên tài khoản |
|
| | 44 | (bankAccounts) isDefault | Integer | đánh dấu có mặc định hay không. 1: mặc định, 0: không mặc định |
|
|
|
3.4 Mô tả các trường dữ liệu trên màn hình:
...