Pular para o conteúdo principal

Listar modelos de veículos

GEThttps://carchost.fieldcontrol.com.br/vehicles-models

Lista os modelos de veículos disponíveis, comuns a todas as contas, com a marca de cada um.

Requer os headers X-Api-Key e User-Agent. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Parâmetros de consulta

limitinteger

Quantidade de itens por página.

De 1 a 100.Padrão: 10.

offsetinteger

Quantidade de itens a pular.

De 0 a 200000.Padrão: 0.

qstring

Filtros no formato campo:valor, separados por espaço (como filtrar). Os filtros aceitos estão na tabela abaixo.

Exemplo: brand_id:ZWU5OTgxOTQtMmZhMC00ZDc5LThjYmEtZWRlODE0ZTViZjgxOjIyOTE1.

FiltroO que faz
name

Parte do nome do modelo, sem diferenciar maiúsculas e minúsculas. De 2 a 60 caracteres.

brand_id

Identificador da marca.

id

Identificador interno (UUID). O id retornado pela API não é aceito neste filtro e resulta em erro 500.

sortstring

Ordenação. Prefixo - inverte a ordem.

Valores aceitos: id, created_at, -created_at.Padrão: id.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Respostas

  • 200

    Lista de modelos.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 422

    Filtro, paginação ou ordenação inválidos (parametersValidationErr).

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.