Capítulo XIV - Associação/ Desassociação de grupos nos cenários

Conforme descrito no capítulo “Associação de produtos/grupos” deste manual, um grupo de produtos serve para otimizar o volume de regras que serão geradas pela Systax, de forma que em cada cenário sejam geradas regras apenas para os produtos movimentados neste cenário, fazendo com que nosso cliente receba somente as regras que ele realmente utilizará.
Dito isso, essa API possibilita associar ou desassociar um grupo de produtos de um cenário existente.
Para os casos em que ocorrerem erros como cenário ou grupo não existente, grupo já associado anteriormente etc., a API irá informar a ocorrência conforme mensagem específica.

Descrição dos campos da chamada e retorno
  

 Chamada 

 

 

 

 

 Campo 

 

 

 Descrição 

 

 

 

 

 acao 

 

 

 Opções “associar” e “desassociar” 

 

 

 

 

 id_cenario 

 

 

 ID do cenário do cliente 

 

 

 

 

 nome_grupo 

 

 

 Nome do grupo de produtos 

 

 

 

 

 

 Retorno 

 

 

 

 

 Campo 

 

 

 Descrição 

 

 

 

 

 success 

 

 

 Status de retorno 

 

 

 

 

 message 

 

 

 Mensagem de retorno 

 

 

 

 

 itens 

 

 

 Quantidade de itens da chamada 

 

 

 

 

 status 

 

 

 Indicador numérico do tipo de status retornado 

 

 

 

 

 message 

 

 

 Mensagem relacionado ao status retornado 

 

 

 

 

 acao 

 

 

 Opção selecionada de associar ou desassociar 

 

 

 

 

 id_cenario 

 

 

 ID do cenário do cliente 

 

 

 

 

 nome_grupo 

 

 

 Nome do grupo de produtos 

 

 

 

 

 

 Tabela de referência para o campo “success” e “message” 

 

 

 

 

 Código de retorno 

 

 

 sucess 

 

 

 message 

 

 

 

 

 200 

 

 

 true 

 

 

 OK 

 

 

 

 

 400 

 

 

 false false false 

 

 

 token_invalid token_expired Username ou Password inválido 

 

 

 

 

 500 

 

 

 false 

 

 

 internal_error 

 

 

 

 

 

 Tabela de referência para o campo “msg” 

 

 

 

 

 Campo 

 

 

 nº ordem 

 

 

 Descrição 

 

 

 

 

 Status 

 

 

 0 

 

 

 Sucesso 

 

 

 

 

 1 

 

 

 Cenário não localizado 

 

 

 

 

 2 

 

 

 Grupo de Produtos não localizado 

 

 

 

 

 3 

 

 

 Grupo de Produtos já associado a este cenário 

 

 

 

 

 4 

 

 

 Grupo de Produtos não consta como associado a este cenário

Exemplos de chamada e retorno
  

 Chamada 

 { 

   "items": [ 

 

 { 

 

 "acao": "associar", 

 

 "id_cenario": 2448871, 

 

 "nome_grupo": "PenTest" 

 

 }, 

 

 { 

 

 "acao": "desassociar", 

 

 "id_cenario": 2518440, 

 

 "nome_grupo": "PenTest" 

 

 } 

   ] 

 } 

 

 

 Retorno 

 { 

   "success": true, 

 

"message": "Ok",  "items": [ 

 

 { 

 

 "status": 0, 

 

 "message": "Sucesso", 

 

"acao": "associar", 

 

 "id_cenario": 2448871, 

 

 "nome_grupo": "PenTest" 

 

 }, 

 

 { 

 

 "status": 0, 

 

 "message": "Sucesso", 

 

 "acao": "desassociar", 

 

 "id_cenario": 2518440, 

 

 "nome_grupo": "PenTest" 

 

} 

   ] 

 }