Getting driver's online time
Getting driver's online time
Request
GET
https://fleet-api.taxi.yandex.net/v2/parks/contractors/supply-hours
Query parameters
|
Name |
Description |
|
contractor_profile_id |
Type: string Driver's profile ID Example: |
|
period_from |
Type: string Period start date in ISO 8601 with time zone. URL-encoding is required for special characters when passing in URL: colon Example: |
|
period_to |
Type: string Period end date in ISO 8601 with time zone. URL-encoding is required for special characters when passing in URL: colon Example: |
Headers
|
Name |
Description |
|
X-API-Key |
Type: string API-key Min length: Example: |
|
X-Client-ID |
Type: string Client ID Min length: Example: |
|
X-Park-ID |
Type: string Partner ID Example: |
Responses
200 OK
Getting driver's online time
Body
application/json
{
"supply_duration_seconds": 3600,
"total_seconds": 3600
}
|
Name |
Description |
|
supply_duration_seconds |
Type: integer Driver's online time for the requested period in seconds |
|
total_seconds |
Type: integer Total duration of the requested period in seconds |
400 Bad Request
Invalid request parameters
Body
application/json
{
"code": "example",
"message": "Textual description of the error"
}
|
Name |
Description |
|
message |
Type: string Human-readable error message Example: |
|
code |
Type: string Machine-readable error code Example: |
401 Unauthorized
Request authorization parameters are missing
Body
application/json
{
"code": "example",
"message": "Textual description of the error"
}
|
Name |
Description |
|
message |
Type: string Human-readable error message Example: |
|
code |
Type: string Machine-readable error code Example: |
403 Forbidden
Insufficient rights to execute the request
Body
application/json
{
"code": "example",
"message": "Textual description of the error"
}
|
Name |
Description |
|
message |
Type: string Human-readable error message Example: |
|
code |
Type: string Machine-readable error code Example: |
404 Not Found
Requested resource was not found
Body
application/json
{
"code": "example",
"message": "Textual description of the error"
}
|
Name |
Description |
|
message |
Type: string Human-readable error message Example: |
|
code |
Type: string Machine-readable error code Example: |
429 Too Many Requests
Limit of requests was exceeded
Body
application/json
{
"code": "example",
"message": "Textual description of the error"
}
|
Name |
Description |
|
message |
Type: string Human-readable error message Example: |
|
code |
Type: string Machine-readable error code Example: |
500 Internal Server Error
Internal server error
Body
application/json
{
"code": "example",
"message": "Textual description of the error"
}
|
Name |
Description |
|
message |
Type: string Human-readable error message Example: |
|
code |
Type: string Machine-readable error code Example: |