1. Informações Gerais (recurso ainda não disponível)

2. Objetivo

Os serviços especificados neste documento serão consumidos pelo aplicativo Monitor de Eventos e tem por objetivo permitir ao usuário consultar os eventos cadastrados na base TAF (totvs Automação fiscal) de um navegador convencional podendo ser também smartphone ou tablet.

3. Definições de Serviços

Todos os serviços devem obedecer às boas práticas de implementação de APIs presentes no Guia de Implementação de APIs TOTVS.

Deve-se tomar um cuidado especial com os retornos da requisição, inserindo o status HTTP correto de acordo com o erro encontrado (não enviar um status http 200 em uma mensagem de erro, por exemplo).

3.1. GET /wstaf001

Retorna a lista de contratos disponíveis para consulta ao usuário logado, no formato indicado abaixo:

{
    "eventsReinfTotalizers": [ 
	{
            "event": "R-5001",
            "descriptionEvent": "Informações de bases e tributos por evento",
            "monitoring": [
                {
                    "statusCode": 0,
                    "quantity": 4
                }
            ],
            "totalMonitoring": 4
        }
		],
    "hasNext": false,
    "eventsReinf": [
        {
            "totalNotValidation": 0,
            "event": "R-2010",
            "descriptionEvent": "Retenção contribuição previdenciária - serviços tomados",
            "typeEvent": 3,
            "monitoring": [
                {
                    "statusCode": 0,
                    "quantity": 2
                }
            ],
            "totalMonitoring": 2,
            "total": 4,
            "totalValidation": 4
        }
    ]
}

Descrição dos Campos:

• 
  
• eventsReinfTotalizers[]: Array com os eventos do tipo totalizadores. R-5001 e R-5011
• eventsReinf[]: Array com os eventos dos tipos Tabelas, Periódicos e Não Periódicos
• totalNotValidation: Quantidade de registros existentes na base (legado) que irá ou ao menos deveria compor a apuração do determinado evento
• totalValidation: Quantidade de registros existentes na base (legado) que foram considerados na apuração do determinado evento
• total: Quantidade total de registros existentes na base (legado) que foram considerados ou devem ser considerados na apuração do determinado evento
• event: Evento consultado. Ex: R-1000, R-2030
• typeEvent: Tipo do evento  1 - Todos, 2 - Tabelas, 3 - Periódicos, 4 - Não Periódicos, 5 - Totalizadores
• 
  
• totalMonitoring[]: Array com os eventos existentes no monitor de transmissão.
• totalMonitoring[n].statusCode: Status do evento no monitor. 0 - Aguardando transmissão , 2 - Aguardando retorno, 3 - Retorno com erros, 4 - Transmitido Ok.
• totalMonitoring[n].quantity: Quantidade do evento existente no monitor para o determinado statusCode

• hasNext: Indica se existe mais uma página de resultados ou se já está na última página (ver mais detalhes nos parâmetros aceitos: page e pageSize).

Parâmetros aceitos:

• page e pageSize

Utilizados para fazer paginação.

A primeira página é a 1.

Se não for enviado um page, considerar a página 1.

Se não for passado um pageSize, o parâmetro é desconsiderado e a mensagem pe retornada  completa apenas com base nos outros parâmetros.

TODA requisição de lista deve retornar um atributo hasNext indicando se atingiu a última página ou não..

• Filtros

Deve suportar filtrar os resultados de acordo com alguns parâmetros:

• • sourceBranch: Código Identificador da filial do ERP emissor. Deve existe em C1E_CODFIL
  • period: Período desejado para a consulta.
  • status: Array do tipo numérico que contem o status desejado para a consulta. 1 - Todos, 2 - Pendente apuração, 3 - Apurados, 4 - Pendentes transmissão, 5 - Retorno com erros, 6 - Transmitidos, 7 - Aguardando retorno, 8 - Retorno com erros, 9 - Sem pendências .
  • events: Array do tipo string contendo os eventos a serem consultados. Ex: {"R-2010", "R-2020"}  para consultar apenas R-2010 e R-2020, Ex: {totds} para retornar todos os eventos.
  • eventType: Array do tipo numérico contendo  os tipos dos eventos que devem ser retornados. Ex: {1,2, 3, 4}. 1 - Todos, 2 - Tabelas, 3 - Periódicos, 4 - Não Periódicos, 5 - Totalizadores.
  • page: Indica o numero da pagina desejada, este parâmetro trabalha em conjunto com pageSize.
  • pageSize: Quantidade de registros que a pagina deve conter, este parâmetro trabalha cem conjunto com page.