Skip to main content
GET
Get efficency

Авторизации

Authorization
string
header
обязательно

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Заголовки

X-Tenant-Id
integer

Компания, в контексте которой выполняется запрос — её id из GET /v1/tenant/. Пользователь должен состоять в этой компании: чужой id доступа к данным не даёт. Без заголовка компания определяется по домену запроса.

Параметры запроса

car__isnull
boolean
category
integer
category__in
integer[]

Несколько значений могут быть разделены запятыми.

disable__isnull
boolean
disable__method
enum<integer>
  • 0 - удалить
  • 1 - Архив
  • 2 - Списано
Доступные опции:
0,
1,
2
disabled
boolean
end_at
string<date>

Конец отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент времени, от которого берётся дата.

exclude_ids
integer[]

Несколько значений могут быть разделены запятыми.

filter_key
string
fleet_status
string
free
boolean
group
integer
group__in
integer[]

Несколько значений могут быть разделены запятыми.

has_sublease
boolean
id
integer
id__in
integer[]

Несколько значений могут быть разделены запятыми.

ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

pageSize
integer

Number of results to return per page.

rental_point
integer
rental_point__in
integer[]

Несколько значений могут быть разделены запятыми.

request
number
saleable
boolean

A search term.

start_at
string<date>

Начало отчётного периода, включительно. Дата (ГГГГ-ММ-ДД) или момент времени, от которого берётся дата.

state
integer
state__in
integer[]

Несколько значений могут быть разделены запятыми.

status
number
sublease_user
number
sublease_user__in
number[]

Несколько значений могут быть разделены запятыми.

sublease_user__isnull
boolean
type
number
unique_id
string
unique_id__in
string[]

Несколько значений могут быть разделены запятыми.

Ответ

200 - application/json
count
integer
обязательно
Пример:

123

results
object[]
обязательно
next
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=2"