Partner API - Get All External Stations

Tài liệu API dành cho PartnerBooking.

Endpoint

URL	/PartnerAPI/Stations/user/getAllExternal
Method	POST

Headers schema

Header	Required	Mô tả
clientId hoặc clientid	Yes	Mã định danh đối tác
apiKey hoặc apikey	Yes	Khóa xác thực API của đối tác

Body schema

Field	Type	Required	Rule	Mô tả
searchText	string	No	allow "", null	Từ khóa tìm kiếm.
filter.stationArea	string	No	Khu vực trạm để lọc danh sách trạm.	-
filter.availableStatus	number or array	No	number\|number[]	-
filter.enablePriorityMode	number or array	No	number(min 0)\|number[]	-
skip	number	No	default 0, min 0	Số bản ghi bỏ qua (phân trang).
limit	number	No	-	Số bản ghi tối đa trả về (phân trang).
order	object	No	-	Cấu hình sắp xếp kết quả.

Sample Request

curl --location '{HOST_NAME}/PartnerAPI/Stations/user/getAllExternal' \
  --header 'Content-Type: application/json' \
  --header 'clientId: TESTCLIENT' \
  --header 'apiKey: 07e73e61-0dce-4b39-8ecf-06ef70b35c08' \
  --data '{}'

Success response

{
  "statusCode": 200,
  "error": null,
  "message": "Success",
  "data": {
    "data": [
      {
        "stationsId": 57,
        "stationCode": "29-03S",
        "stationsName": "Trung tâm đăng kiểm 29-03S",
        "stationsAddress": "Hà Nội",
        "stationStatus": 1
      }
    ],
    "total": 1
  }
}

Mã lỗi

HTTP	Mã lỗi	Mô tả
400	Validation Error	Payload không đúng schema.
429	`QUOTA_EXCEEDED`	apiKey không hợp lệ hoặc vượt quota.
500	`UNKNOWN_ERROR`	Lỗi không xác định.

Tham khảo

Quy chuẩn chung -> Common Error

Data test cho developer

clientId: TESTCLIENT
apiKey: 07e73e61-0dce-4b39-8ecf-06ef70b35c08

Cần thay bằng dữ liệu môi trường thật khi tích hợp.