跳到內容

結束行程(beta)

Beta
POST
/v1/vehicles/trips/end
curl --request POST \
--url https://api.example.yas/v1/vehicles/trips/end \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "partnerId": "partner", "endTime": "2026-10-15T10:45:00.000Z", "sessionId": "0199e0a0-0000-7000-8000-000000000001" }'

Beta。合作夥伴的後端用 server key 結束仍在進行的行程。請送 partnerId、endTime,以及 sessionId 或 tripId 其中一個。兩個都送,或兩個都不送,是 400。endTime 必須是以 Z 結尾的 UTC。帶時區偏移是 400。第一次的 endTime 會保留,之後再呼叫不會改寫。未知的 sessionId 會記成已結束。未知的 tripId 是 404。同一個 tripId 有多於一個未結束的 session 是 409。POST /v1/trips/end 已棄用。請用這條路徑。

Request Bodyrequired

小節:Request Bodyrequired
Media typeapplication/json

只送 sessionId 或 tripId 其中一個。兩個都送,或兩個都不送,是 400。endTime 必須是以 Z 結尾的 UTC。

object
partnerId
required

來自 setup 的合作夥伴 id。必須與 server key 相符。

string
/^[a-z0-9-]{1,64}$/
endTime
required

以 Z 結尾的 UTC,例如 2026-10-15T10:45:00.000Z。+08:00 這類時區偏移是 400。

string format: date-time
/^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?Z$/
sessionId

要結束的未結束 session。送這個或 tripId,不要兩個都送。

string format: uuid
tripId

要結束的合作夥伴行程 id。送這個或 sessionId,不要兩個都送。

string
>= 1 characters

Example

{
"partnerId": "partner",
"endTime": "2026-10-15T10:45:00.000Z",
"sessionId": "0199e0a0-0000-7000-8000-000000000001"
}

行程已結束。未知的 sessionId 會記成已結束。

Media typeapplication/json
object
endTime
required

已保存的時間。之後再呼叫不會改寫。

string format: date-time
endedBy
required

partner 表示後端結束,phone 表示 SDK 結束,silence 表示手機停止回報。之後再呼叫不會改寫。

string
Allowed values: partner phone silence
sessionId
required
string format: uuid
tripId
string

Example

{
"endTime": "2026-10-15T10:45:00.000Z",
"endedBy": "partner",
"sessionId": "0199e0a0-0000-7000-8000-000000000001",
"tripId": "booking_1001"
}
400`endTime` 必須是以 `Z` 結尾的 UTC,例如 `2026-10-15T10:45:00.000Z`。帶時區偏移、缺少或不是真實時間、`sessionId` 不是 UUID、`tripId` 是空字串、兩個 id 都有,或兩個都沒有,都是 400。
Media typeapplication/json
object
error
required

穩定的錯誤代碼。沒有 stack trace。

string

Example

{
"error": "invalid_body"
}
401沒有 server key,或 server key 不正確。
Media typeapplication/json
object
error
required

穩定的錯誤代碼。沒有 stack trace。

string

Example

{
"error": "invalid_credentials"
}
403server key 可以只限車輛、只限機械人,或兩者都可以。超出範圍的呼叫是 403 `forbidden`,而且不會保存。`identity_mismatch` 表示 `partnerId` 與 server key 不符。
Media typeapplication/json
object
error
required

穩定的錯誤代碼。沒有 stack trace。

string

Example

{
"error": "forbidden"
}
404未知的 `tripId`。
Media typeapplication/json
object
error
required

穩定的錯誤代碼。沒有 stack trace。

string

Example

{
"error": "not_found"
}
409這個 `tripId` 有多於一個未結束的 session。
Media typeapplication/json
object
error
required

穩定的錯誤代碼。沒有 stack trace。

string

Example

{
"error": "ambiguous_trip"
}