Define Transport Operator Quota - Documentação DEVMOB

curl --request POST \ --url https://api.example.com/api/v1/bko/transport-operator-quotas \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "transportOperatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "periodStart": "2023-11-07T05:31:56Z", "periodEnd": "2023-11-07T05:31:56Z", "maxTrips": 2 } '

{ "transportOperatorQuotaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "cooperativeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "transportOperatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "periodStart": "2023-11-07T05:31:56Z", "periodEnd": "2023-11-07T05:31:56Z", "maxTrips": 123, "reservedTrips": 123, "consumedTrips": 123, "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z", "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z" }

Authorizations

Authorization

string

header

required

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

Query Parameters

fields

string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Define transport operator quota payload

transportOperatorId

string<uuid>

required

Transport operator identifier

routeId

string<uuid>

required

Route identifier

periodType

enum<string>

required

Period type

Available options:

DAILY,

WEEKLY,

MONTHLY,

CUSTOM

periodStart

string<date-time>

required

Period start

periodEnd

string<date-time>

required

Period end

maxTrips

integer

required

Maximum trips

Required range: x >= 1

Response

Created

Cota máxima de viagens por permissionário, rota e período

transportOperatorQuotaId

string<uuid>

required

Identificador único

cooperativeId

string<uuid>

required

Cooperativa da regra

transportOperatorId

string<uuid>

required

Permissionário controlado

routeId

string<uuid>

required

Rota controlada

periodType

enum<string>

required

Tipo do período

Available options:

DAILY,

WEEKLY,

MONTHLY,

CUSTOM

periodStart

string<date-time>

required

Início do período

periodEnd

string<date-time>

required

Fim do período

maxTrips

integer

required

Quantidade máxima de viagens permitidas

reservedTrips

integer

required

Viagens em andamento ou reservadas

consumedTrips

integer

required

Viagens concluídas que consumiram cota

status

enum<string>

required

Status da regra

Available options:

ACTIVE,

INACTIVE,

EXHAUSTED

createdBy

string<uuid> | null

required

Usuário que criou o registro, quando aplicável

createdAt

string<date-time>

required

Data de criação

updatedBy

string<uuid> | null

required

Usuário que fez a última atualização, quando aplicável

updatedAt

string<date-time>

required

Data da última atualização

deletedBy

string<uuid> | null

required

Usuário que removeu o registro, quando aplicável

deletedAt

string<date-time> | null

required

Data de remoção