Pular para o conteúdo principal

Exporta dados de avarias de veículos em JSON.

GET /api/{userId}/vehicles/damage/export/json

Parâmetros de rota

NomeTipoDescrição
userIdnumberIdentificador do usuário

Requisição

  • Método: GET
  • Path: /api/\{userId\}/vehicles/damage/export/json
  • Headers: Authorization, Accept: application/json
  • Autorização: informe o userId do token na URL e envie o token no header Authorization: Bearer <YOUR_API_TOKEN> (gerados no painel de API do Site Admin).

Parâmetros de consulta (query string)

NomeTipoDescrição
platestringPlaca do veículo (busca parcial). Pelo menos plate ou serviceOrderCode deve ser informado.
serviceOrderCodestringCódigo da OS relacionada à avaria. Pelo menos plate ou serviceOrderCode deve ser informado.
partIdnumberIdentificador da parte do veículo.
creationUserIdnumberIdentificador do usuário que registrou a avaria.
startDatestring (YYYY-MM-DD)Data inicial do período de criação da avaria.
endDatestring (YYYY-MM-DD)Data final do período de criação da avaria.
startTimestring (HH:MM:SS)Hora inicial do período. Padrão: 00:00:00.
endTimestring (HH:MM:SS)Hora final do período. Padrão: 23:59:59.

Resposta

  • Status: 200 OK
  • Content-Type: application/json

Exemplo de resposta

{
"response": "success",
"data": {
"establishment": {
"establishmentId": 1234,
"establishmentName": "Estacionamento Central",
"documentId": "12345678000199",
"addresses": [
{
"street": "Av. Paulista",
"number": "1000",
"city": "São Paulo",
"state": "SP",
"zipCode": "01310-100"
}
],
"base64Logo": "iVBORw0KGgoAAAANSUhEUgAA..."
},
"content": [
{
"damageId": 5821,
"plate": "ABC1D23",
"establishmentId": 1234,
"photoUrl": "https://jumpparkapi.sfo2.digitaloceanspaces.com/damages/5821.jpg",
"observation": "Arranhão na porta dianteira esquerda",
"registerDateTime": "2026-04-18 14:32:11",
"serviceOrderId": 98741,
"serviceOrderCode": "EST1000123",
"categoryId": 2,
"categoryName": "Arranhão",
"partId": 7,
"partName": "Porta Dianteira Esquerda",
"typeId": 1,
"typeName": "Leve",
"userId": 42,
"userName": "João da Silva"
},
{
"damageId": 5822,
"plate": "ABC1D23",
"establishmentId": 1234,
"photoUrl": "https://jumpparkapi.sfo2.digitaloceanspaces.com/damages/5822.jpg",
"observation": "Amassado no para-choque traseiro",
"registerDateTime": "2026-04-19 09:10:45",
"serviceOrderId": 98812,
"serviceOrderCode": "EST1000145",
"categoryId": 3,
"categoryName": "Amassado",
"partId": 12,
"partName": "Para-choque Traseiro",
"typeId": 2,
"typeName": "Médio",
"userId": 42,
"userName": "João da Silva"
}
],
"vehicle": [
{
"vehicleId": 731,
"plate": "ABC1D23",
"establishmentId": 1234,
"vehicleModel": "Fiat Uno",
"vehicleColor": "Prata"
}
]
}
}

Quando a consulta não possui plate nem serviceOrderCode, ou quando não há avarias para os filtros informados, o endpoint retorna um array vazio ([]).