Plataforma (platform)

2.0info: Routing API 1.0.0 description: Routing API Service contact: email: research@senior.com.brhost: https://api.senior.com.br/platform /routing – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /route/: post: operationId: createVehicleProblem summary: Cria uma roteirização para um problema de roteirização de veículos. description: Endpoint que requisita um solução de roteirização, enviando um problema de roteirização de veículos. parameters: – #/parameters/clientId – name: execution in: query required: false type: string description: Parâmetro opcional que define a arquitetura de nuvem onde a roteirização será processada. Pode ser lambda (menos poder de processamento e máximo de dez minutos de execução) ou batch (mais poder de processamento, sem limite de tempo). O padrão é lambda, caso não seja definido. – name: body in: body required: true schema: #/definitions/RoutingProblem responses: 201: description: CREATED schema: #/definitions/RoutingRequestResponse 401: description: UNAUTHORIZED 400: description: BAD REQUEST get: operationId: getRoutingSolution summary: Recupera a solução computada para um problema de roteirização de veículos. parameters: – #/parameters/clientId – name: routingId in: query type: string description: routingId da roteirização solicitada (obtida no response do método POST) responses: 200: description: OK schema: type: array items: #/definitions/RoutingSolution 500: description: INTERNAL SERVER ERROR 404: description: NOT FOUNDdefinitions: RoutingProblem: type: object properties: originLocation: description: objeto que representa as coordenadas da origem (saída dos veículos) type: object properties: latitude: description: latitude da origem dos veículos type: number longitude: description: longitude da origem dos veículos type: number finalLocation: description: objeto que representa as coordenadas do destino final dos veículos (se igual à origem, saída e chegada são os mesmos) type: object properties: latitude: description: latitude do destino final dos veículos type: number longitude: description: longitude do destino final dos veículos type: number vehicles: description: array de veículos type: array items: type: object properties: licensePlate: description: placa (ou identificador único) do veículo type: string group: description: objeto que representa definições do grupo/tipo de veículo type: object properties: groupDescription: description: descrição/título do grupo/tipo de veículo type: string weight: description: capacidade de peso máxima do veículo (em kg) type: number cubicCapacity: description: capacidade em metros cúbics máxima do veículo (em m³) type: number startWorkingTime: description: início do horário de trabalho do veículo type: string endWorkingTime: description: fim do horário de trabalho do veículo type: string startBreakTime: description: início do horário de intervalo do veículo type: string endBreakTime: description: fim do horário de intervalo do veículo type: string activities: description: array de atividades type: array items: type: object properties: activityId: description: identificador único da atividade type: integer latitude: description: latitude da localização da atividade type: number longitude: description: longitude da localização da atividade type: number weight: description: peso da demanda da atividade (em kg) type: number cubicMeters: description: metros cúbicos da demanda (opcional) type: number timeDuration: description: duração máxima da atividade (opcional) type: string startTimeWindow: description: horário de início da janela de tempo da atividade (opcional) type: string endTimeWindow: description: horário de fim da janela de tempo da atividade (opcional) type: string RoutingRequestResponse: type: object properties: routingId: description: identificador único da roteirização solicitada. type: string RoutingSolution: type: object properties: routingId: description: routing id type: string routingStatus: description: status do processo de roteirização (SUCCESSFUL ou FAILED) type: string object: description: url do arquivo de solução, salvo no formato JSON type: string