Documento de API

Considerações Gerais

Objetivo

Receber as agendas criadas e executadas no aplicativo do UmovMe, afim de atualizar os dados no ERP.

Funcionamento

Na forma padrão, realiza-se a chamada através de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.

A sintaxe para a chamada da API/BO é:

run utp/utp00508rec.p.

A execução na forma persistente ...

A sintaxe para executar a API/BO em modo persistente é:

run utp/utp00508rec.p persistent set h-handle.

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Nos atributos das tabelas temporárias de entrada e saída:

ttAgenda					Entrada/Saída
Agenda do Representante que irá receber dados do Umov para atualização no ERP
Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cdn_emitente	Inteiro		Emitente
cdn_repres	Inteiro		representante
dat_agenda	Character		Data da agenda
dat_agenda_orig	Date		Data da agenda real
dat_visita	Date		Data executada
dat_agendto_origin	Date		Data da agenda ERP
des_obs	Character		Observação Agenda
hra	Character		Hora Agenda
cdn_usuar	Character		Código Usuário
Id_umov	Inteiro		Código Umov

Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

getSchedule
Requisito
Sintaxe	Run getSchedule in handle (input cToken).
Descrição	Método principal para receber as agendas executadas no dispositivo móvel.
	Parâmetros	Descrição
	cToken	Chave de acesso ao ambiente do UmovMe
Retorno

processNewTaskUmov
Requisito
Sintaxe	Run processNewTaskUmov in handle (input table ttId, cToken).
Descrição	Adiciona as agendas criadas no aplicativo móvel dentro da agenda do ERP
	Parâmetros	Descrição
	ttId	Agendas que foram criadas no dispositivo móvel.
	cToken	Chave de Acesso UmovMe.
Retorno

createError
Requisito
Sintaxe	Run createError in handle (input table RowErrors).
Descrição	Adiciona erro ao log de erros da integração
	Parâmetros	Descrição
	RowErrors	erros
Retorno

processTaskUmov
Requisito
Sintaxe	Run processTaskUmov in handle (input table ttId, cToken).
Descrição	Atualiza as agendas executadas no aplicativo móvel dentro da agenda do ERP
	Parâmetros	Descrição
	ttId	ttId
	cToken	cToken
Retorno

createScheduleERP
Requisito
Sintaxe	Run createScheduleERP in handle (input table ttAgenda).
Descrição	Criar as agendas recebidas do UmovMe
	Parâmetros	Descrição
	ttAgenda	TempTable com os dados para criar a nova agenda
Retorno

updateScheduleERP
Requisito
Sintaxe	Run updateScheduleERP in handle (input table ttAgenda, input iStatus).
Descrição	Adiciona um novo contato ao lead no CRM
	Parâmetros	Descrição
	ttAgenda	TempTable com os dados das agendas.
	iStatus	0 – agenda será mantida como integrada / 1 – agenda será enviada novamente ao UmovMe
Retorno

createAgendaRepres
Requisito
Sintaxe	Run createAgendaRepres in handle (input table ttAgendaRepres).
Descrição	Adiciona uma nova agenda no ERP
	Parâmetros	Descrição
	ttAgendaRepres	tempTable com os dados da agenda.
Retorno