Documento de API

Considerações Gerais

Objetivo

Gerenciar os dados a serem enviados ao aplicativo de agenda do representante umovMe.

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/ utp00508sen.p

A execução na forma persistente ...

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

run utp/ utp00508sen.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:

getIdUmov
Requisito
Sintaxe	RUN getIdUmov(INPUT 'schedule', INPUT ('id=':U + string(ttAgenda.id_Umov)), INPUT cToken, OUTPUT idScheduleUmov).
Descrição	Recebe o tipo de dado do UmovMe, código alternativo no UmovMe, o token e retorna o id do registro no UmovMe
	Parâmetros	Descrição
	cTable	Entidade a ser pesquisada no UmovMe
	cValue	Valor alteranativo ( campo + valor )
	cToken	Chave de acesso ao ambiente1
Retorno	cIdUmov

createSchedule
Requisito
Sintaxe	RUN createSchedule (INPUT table ttAgenda, INPUT cToken).
Descrição	Cria as tarefas do representante no Center da UmovMe.
	Parâmetros	Descrição
	ttAgenda	TempTable com os dados da tarefa a ser criada.
	cToken	Chave de acesso.
Retorno

createSchedule
Requisito
Sintaxe	RUN createSchedule (INPUT table ttAgenda, INPUT cToken).
Descrição	Cria as tarefas do representante no Center da UmovMe.
	Parâmetros	Descrição
	ttAgenda	TempTable com os dados da tarefa a ser criada.
	cToken	Chave de acesso.
Retorno

createLocal
Requisito
Sintaxe	RUN createLocal (INPUT table ttAgenda, INPUT cToken).
Descrição	Cria os clientes que estão associados a tarefa no Center da UmovMe.
	Parâmetros	Descrição
	ttAgenda	TempTable com os dados da tarefa a ser criada.
	cToken	Chave de acesso.
Retorno	cToken