redocly logoAPI docs by Redocly

Đặc tả api truyền tải lệnh vận chuyển (v1)

Tải về tệp đặc tả OASv3:Tải

Cục Đường Bộ Việt Nam: lenhvanchuyen.drvn@gmail.com Terms of Service

Các tài liệu liên quan khác

Dành cho đơn vị vận tải

Truyền tải lệnh đã xác minh bởi bến xe đi.

Sau khi bến xe khách thực hiện ký số để xác nhận trên LVC và cho xe xuất bến hoặc xe đến bến thì phải truyền dữ liệu về máy chủ Cục ĐBVN.

Authorizations:
oauth2
Cấu trúc tải trọng gửi lên: application/json
maLenh
required
string

Mã lệnh được định danh duy nhất tại đơn vị quản lý lệnh.
(Khuyến cáo sử dụng UUID)
xml
required
string

Tệp dữ liệu xml mã hóa dạng Base64.
Tệp dữ liệu lệnh vận chuyển điện tử đã được bến xe ký số.
Mảng của objects or null (TepDinhKem)

Bản thể hiện của lệnh vận chuyển điện tử.
(Lưu ý nên truyền để người dùng xem xét đảm bảo trực quan)
checksum
required
string

Chuỗi xác thực tính đúng đắn của dữ liệu.
Các chi tiết quy định về chuỗi xác thực (checksum) được công bố tại địa chỉ: https://benxe.gov.vn/doc

Các phản hồi

Yêu cầu ví dụ

Loại nội dung
application/json
{
  • "maLenh": "string",
  • "xml": "string",
  • "danhSachTepDinhKem": [
    ],
  • "checksum": "string"
}

Phản hồi ví dụ

Loại nội dung
application/json
{
  • "status": true,
  • "message": "string",
  • "errorCode": 0,
  • "data": {
    }
}

Truyền tải lệnh đã xác minh bởi bến xe đến.

Sau khi bến xe khách thực hiện ký số để xác nhận trên LVC và cho xe xuất bến hoặc xe đến bến thì phải truyền dữ liệu về máy chủ Cục ĐBVN.

Authorizations:
oauth2
Cấu trúc tải trọng gửi lên: application/json
maLenh
required
string

Mã lệnh được định danh duy nhất tại đơn vị quản lý lệnh.
(Khuyến cáo sử dụng UUID)
xml
required
string

Tệp dữ liệu xml mã hóa dạng Base64.
Tệp dữ liệu lệnh vận chuyển điện tử đã được bến xe ký số.
Mảng của objects or null (TepDinhKem)

Bản thể hiện của lệnh vận chuyển điện tử.
(Lưu ý nên truyền để người dùng xem xét đảm bảo trực quan)
checksum
required
string

Chuỗi xác thực tính đúng đắn của dữ liệu.
Các chi tiết quy định về chuỗi xác thực (checksum) được công bố tại địa chỉ: https://benxe.gov.vn/doc

Các phản hồi

Yêu cầu ví dụ

Loại nội dung
application/json
{
  • "maLenh": "string",
  • "xml": "string",
  • "danhSachTepDinhKem": [
    ],
  • "checksum": "string"
}

Phản hồi ví dụ

Loại nội dung
application/json
{
  • "status": true,
  • "message": "string",
  • "errorCode": 0,
  • "data": {
    }
}

Truyền tải lệnh đã ký dành cho xe buýt.

Sau khi bến xe khách thực hiện ký số để xác nhận trên LVC và cho xe xuất bến hoặc xe đến bến thì phải truyền dữ liệu về máy chủ Cục ĐBVN.

Authorizations:
oauth2
Cấu trúc tải trọng gửi lên: application/json
maLenh
required
string

Mã lệnh được định danh duy nhất tại đơn vị quản lý lệnh.
(Khuyến cáo sử dụng UUID)
xml
required
string

Tệp dữ liệu xml mã hóa dạng Base64.
Tệp dữ liệu lệnh vận chuyển điện tử đã được bến xe ký số.
Mảng của objects or null (TepDinhKem)

Bản thể hiện của lệnh vận chuyển điện tử.
(Lưu ý nên truyền để người dùng xem xét đảm bảo trực quan)
checksum
required
string

Chuỗi xác thực tính đúng đắn của dữ liệu.
Các chi tiết quy định về chuỗi xác thực (checksum) được công bố tại địa chỉ: https://benxe.gov.vn/doc

Các phản hồi

Yêu cầu ví dụ

Loại nội dung
application/json
{
  • "maLenh": "string",
  • "xml": "string",
  • "danhSachTepDinhKem": [
    ],
  • "checksum": "string"
}

Phản hồi ví dụ

Loại nội dung
application/json
{
  • "status": true,
  • "message": "string",
  • "errorCode": 0,
  • "data": {
    }
}

Truyền tải thông tin khi xe hoạt động trên đường.

Đơn vị vận tải/đơn vị truyền dữ liệu thực hiện truyền tải khi có thay đổi số lượng hành khách sau khi xe xuất bến. Nội dung này chỉ áp dụng cho xe khách tuyến cố định, không áp dụng cho xe buýt.

Authorizations:
oauth2
Cấu trúc tải trọng gửi lên: application/json
maLenhVanChuyen
required
string <uuid>

Mã lệnh vận chuyển được định danh trên Máy chủ của Cục ĐBVN sau khi truyền tải theo “API truyền tải lệnh vận chuyển điện tử khi đã được bến xe nơi đi ký số” thành công trả về dữ liệu “Mã lệnh vận chuyển”.
maLenh
required
string

Mã lệnh được định danh duy nhất tại đơn vị quản lý lệnh.
(Khuyến cáo sử dụng UUID)
soKhach
required
string

Số lượng khách thực tế trên xe.
toaDoGPS
string or null

Tọa độ GPS của xe khi truyền dữ liệu.
Định dạng tọa độ dạng: kinh độ, vĩ độ
Ví dụ: 41.40338, 2.17403
checksum
required
string

Chuỗi xác thực tính đúng đắn của dữ liệu.
Các chi tiết quy định về chuỗi xác thực (checksum) được công bố tại địa chỉ: https://benxe.gov.vn/doc

Các phản hồi

Yêu cầu ví dụ

Loại nội dung
application/json
{
  • "maLenhVanChuyen": "47b327c4-139e-42ce-9a60-e74f6b531658",
  • "maLenh": "string",
  • "soKhach": "string",
  • "toaDoGPS": "string",
  • "checksum": "string"
}

Phản hồi ví dụ

Loại nội dung
application/json
{
  • "status": true,
  • "message": "string",
  • "errorCode": 0,
  • "data": true
}

Truyền tải khi thực hiện thay thế xe trên lệnh vận chuyển cũ.

Sau khi doanh nghiệp thực hiện ký và phát hành lệnh thì cần phải truyền tải thông tin lệnh vận chuyển.

Authorizations:
oauth2
Cấu trúc tải trọng gửi lên: application/json
maLenh
required
string

Mã lệnh được định danh duy nhất tại đơn vị quản lý lệnh.
(Khuyến cáo sử dụng UUID)
maLenhBiThayThe
required
string

Mã lệnh được định danh duy nhất tại đơn vị quản lý lệnh.
(Khuyến cáo sử dụng UUID)
maLenhVanChuyen
required
string <uuid>

Mã lệnh vận chuyển đã được định danh trên Máy chủ của Cục ĐBVN sau khi được tiếp nhận thành công.
xml
required
string

Tệp dữ liệu xml mã hóa dạng Base64.
Tệp dữ liệu lệnh vận chuyển điện tử đã được bến xe ký số.
required
Mảng của objects (TepDinhKem)

Bản thể hiện của lệnh vận chuyển điện tử.
(Lưu ý nên truyền để người dùng xem xét đảm bảo trực quan)
checksum
required
string

Chuỗi xác thực tính đúng đắn của dữ liệu.
Các chi tiết quy định về chuỗi xác thực (checksum) được công bố tại địa chỉ: https://benxe.gov.vn/doc

Các phản hồi

Yêu cầu ví dụ

Loại nội dung
application/json
{
  • "maLenh": "string",
  • "maLenhBiThayThe": "string",
  • "maLenhVanChuyen": "47b327c4-139e-42ce-9a60-e74f6b531658",
  • "xml": "string",
  • "danhSachTepDinhKem": [
    ],
  • "checksum": "string"
}

Phản hồi ví dụ

Loại nội dung
application/json
{
  • "status": true,
  • "message": "string",
  • "errorCode": 0,
  • "data": {
    }
}

Dành cho bến xe khách

Truyền tải dữ liệu lệnh khi xe xuất bến.

Sau khi bến xe khách thực hiện ký số để xác nhận trên LVC và cho xe xuất bến hoặc xe đến bến thì phải truyền dữ liệu về máy chủ Cục ĐBVN.

Authorizations:
oauth2
Cấu trúc tải trọng gửi lên: application/json
maLenh
required
string

Mã lệnh được định danh duy nhất tại đơn vị quản lý lệnh.
(Khuyến cáo sử dụng UUID)
xml
required
string

Tệp dữ liệu xml mã hóa dạng Base64.
Tệp dữ liệu lệnh vận chuyển điện tử đã được bến xe ký số.
Mảng của objects or null (TepDinhKem)

Bản thể hiện của lệnh vận chuyển điện tử.
(Lưu ý nên truyền để người dùng xem xét đảm bảo trực quan)
checksum
required
string

Chuỗi xác thực tính đúng đắn của dữ liệu.
Các chi tiết quy định về chuỗi xác thực (checksum) được công bố tại địa chỉ: https://benxe.gov.vn/doc

Các phản hồi

Yêu cầu ví dụ

Loại nội dung
application/json
{
  • "maLenh": "string",
  • "xml": "string",
  • "danhSachTepDinhKem": [
    ],
  • "checksum": "string"
}

Phản hồi ví dụ

Loại nội dung
application/json
{
  • "status": true,
  • "message": "string",
  • "errorCode": 0,
  • "data": {
    }
}

Truyền tải dữ liệu lệnh khi xe đến bến trả khách.

Sau khi bến xe khách thực hiện ký số để xác nhận trên LVC và cho xe xuất bến hoặc xe đến bến thì phải truyền dữ liệu về máy chủ Cục ĐBVN.

Authorizations:
oauth2
Cấu trúc tải trọng gửi lên: application/json
maLenh
required
string

Mã lệnh được định danh duy nhất tại đơn vị quản lý lệnh.
(Khuyến cáo sử dụng UUID)
xml
required
string

Tệp dữ liệu xml mã hóa dạng Base64.
Tệp dữ liệu lệnh vận chuyển điện tử đã được bến xe ký số.
Mảng của objects or null (TepDinhKem)

Bản thể hiện của lệnh vận chuyển điện tử.
(Lưu ý nên truyền để người dùng xem xét đảm bảo trực quan)
checksum
required
string

Chuỗi xác thực tính đúng đắn của dữ liệu.
Các chi tiết quy định về chuỗi xác thực (checksum) được công bố tại địa chỉ: https://benxe.gov.vn/doc

Các phản hồi

Yêu cầu ví dụ

Loại nội dung
application/json
{
  • "maLenh": "string",
  • "xml": "string",
  • "danhSachTepDinhKem": [
    ],
  • "checksum": "string"
}

Phản hồi ví dụ

Loại nội dung
application/json
{
  • "status": true,
  • "message": "string",
  • "errorCode": 0,
  • "data": {
    }
}