API :: GET Consultar Roteiro

Busca e exibição de roteiros cadastrados.

Endpoint: GET /api/v1/producao/roteiro

Parâmetros de consulta (query)

Campo	Tipo	Obrigatório	Padrão	Descrição
itemCode	integer¹	Sim	—	Item a ser consultado. Quando preenchido, a API busca e lista todos os roteiros desse item, com todos os campos.
pagina	integer	Não	1	Número da página a ser consultada.
quantidade	integer	Não	10	Registros por página. Valor máximo permitido: 100. pagina não tem limite máximo.

Nota

¹ O documento de origem descreve itemCode como integer, mas também como “Formato: Alfanumérico” — checar com o autor da especificação qual dos dois está correto antes de implementar.

Regras de negócio

• Se itemCode existir mas não tiver roteiro cadastrado, a API não deve trazer nenhuma informação (retorno vazio, não é erro).

Erros

Condição	Mensagem
itemCode não informado	BR One :: Erro campo "itemCode" não pode ser nulo
itemCode inválido (item não existe)	BR One :: Erro item informado não existe
quantidade maior que o limite permitido (100)	BR One :: Erro valor no campo quantidade excede o permitido.

Autenticação, headers, response e códigos HTTP

Importante

[INFORMAÇÃO NÃO ENCONTRADA] — a especificação de origem não define autenticação, headers, formato/exemplo da resposta de sucesso, nem os códigos HTTP retornados (200, 400, 404 etc.). Precisa ser levantado com quem escreveu a história antes de publicar como referência definitiva.

Veja também

• api-roteiro-adicionar-linha

• api-roteiro-atualizar

• api-roteiro-excluir-linha