APITài liệu tham khảoQuản lý công việc
Tạo Job
Tạo một job mới kèm các task trong tài khoản Fleetwork của bạn.
POST
/api/v1/workspace/jobsBody yêu cầu
jobNamestringBắt buộcTên jobjobStatusintegerBắt buộc0=New,1=Scheduled,2=InProgressjobTypeintegerBắt buộc0=Unknown,1=Shipment,2=ServicejobDescriptionstringTuỳ chọnMô tả jobmetaDatastringTuỳ chọnChuỗi JSON metadata tuỳ chỉnhtasksarrayBắt buộcMảng các đối tượng task (xem các trường Task bên dưới)
Các trường Task
taskNamestringBắt buộcTên tasktaskTypeintegerTuỳ chọn0=Unknown,1=Shipment,2=ServicepriorityintegerTuỳ chọn0=Low,1=Medium,2=HighdescriptionstringTuỳ chọnMô tả taskcontactNamestringTuỳ chọnTên người liên hệcontactPhonestringTuỳ chọnSố liên hệstartDtlongTuỳ chọnThời gian bắt đầu theo lịch (Unix ms)endDtlongTuỳ chọnThời gian kết thúc theo lịch (Unix ms)startTimeintegerTuỳ chọnKhung giờ bắt đầu (số phút kể từ nửa đêm)endTimeintegerTuỳ chọnKhung giờ kết thúc (số phút kể từ nửa đêm)serviceTimeintegerTuỳ chọnThời gian dịch vụ tính theo phútsetupTimeintegerTuỳ chọnThời gian chuẩn bị tính theo phútplaceobjectTuỳ chọnĐối tượng place — xem các trường Place bên dưới. Dùng API Search Places để lấy refId hợp lệ.metaDatastringTuỳ chọnChuỗi JSON metadata tuỳ chỉnh ở cấp taskskillIdUUIDTuỳ chọnID kỹ năng yêu cầu cho task nàyshipmentPropertyobjectCó điều kiệnBắt buộc với Shipment job — xem bên dưới
Các trường place
idUUIDTuỳ chọnID của một place đã tồn tại (nếu đã có trong sổ địa chỉ)refIdstringBắt buộcID tham chiếu bên ngoài của bạn cho place này (xem Search Places)namestringTuỳ chọnTên placeaddressstringTuỳ chọnĐịa chỉ đầy đủlatnumberTuỳ chọnVĩ độlngnumberTuỳ chọnKinh độcontactPersonstringTuỳ chọnTên người liên hệcontactNumstringTuỳ chọnSố liên hệstartTimeintegerTuỳ chọnKhung giờ bắt đầu (số phút kể từ nửa đêm)endTimeintegerTuỳ chọnKhung giờ kết thúc (số phút kể từ nửa đêm)
Các trường shipmentProperty (chỉ cho Shipment job)
shipmentTypeintegerBắt buộc1=Pick,2=Drop
JSON
{
"jobName": "Delivery Job Q1",
"jobDescription": "Morning delivery run",
"jobStatus": 1,
"jobType": 1,
"tasks": [
{
"taskName": "Pick up goods",
"taskType": 1,
"priority": 1,
"contactName": "Mr. Tuan",
"contactPhone": "+84901234567",
"shipmentProperty": { "shipmentType": 1 },
"place": {
"refId": "WH-001",
"name": "Main Warehouse",
"address": "100 Warehouse St, D7",
"lat": 10.74,
"lng": 106.72
}
},
{
"taskName": "Deliver to Customer A",
"taskType": 1,
"priority": 1,
"contactName": "Ms. Lan",
"contactPhone": "+84907654321",
"shipmentProperty": { "shipmentType": 2 },
"place": {
"refId": "CUST-A-001",
"name": "Customer A Location",
"address": "123 Le Loi, D1",
"lat": 10.7731,
"lng": 106.703
}
}
]
}