Com o serviço web SOAP (Simple Object Access Protocol), é possível realizar o cadastro de tarefas sem a necessidade de estar no sistema. Este recurso é utilizado para fazer integração e/ou automatização de processos de qualquer sistema com o Procedo.
Nome: Tarefaservice
Tecnologia: Webservice SOAP
URL WSDL: https://app.procedo.com.br/api/tarefaservice?wsdl
Objetivo: Webservice que realiza a criação de Tarefas no Procedo. Essa pode estar vinculado a um cliente, prospect ou uma oportunidade.
Observação: solicite seu token de segurança para utilizar os métodos do webservice [email protected]
Métodos
Método: gravaTarefa
Descrição: Adiciona um novo evento (tarefas ou compromissos) no Procedo.
Parâmetro | Obrigatório | Formato | Descrição |
token | sim | String | Identificado único da empresa para uso do método. |
tarefa | sim | Array | Conterá as tags que compõem os dados da tarefa. |
tipo | sim | String | Identifica se é uma tarefa ( T ) ou um compromisso/evento ( C ) |
entidade | não | String | Opções: emitente, oportunidade ou NULL |
codentidade | não | Int | Código referente ao identificador da entidade. Só será feito o cadastro desse campo caso o campo entidade esteja preenchido corretamente, porém não é obrigatório. |
assunto | não | String | Assunto da tarefa |
dtinicio | sim | String | Data do inicio da tarefa. Formato: yyyy-mm-dd |
dttermino | parcialmente | String | Data do termino da tarefa. Formato: yyyy-mm-dd. Essa data não pode ser menor que a “data do inicio” |
hrinicio | parcialmente | String | Horário de inicio da tarefa. Formato: HH:mm. Se o tipo do evento for tarefa(T), esse campo poderá ser escrito em branco(NULL) |
hrtermino | parcialmente | String | Horário de término da tarefa. Formato: HH:mm.Se o tipo do evento for tarefa(T), esse campo poderá ser escrito em branco(NULL) |
diainteiro | não | Int | Define se será um evento de dia inteiro.
1 = Sim, então ignora os horários e define o evento de dia inteiro 0 = Não |
lembrete | não | Int | Informa quando será o lembrete da tarefa. Deve ser informado em minutos, por exemplo, 30 (meia hora antes), 60 (1 hora antes), 1440 (1 dia antes). Caso o valor informado seja diferente das opções do Procedo, haverá um arredondamento |
responsavel | sim | Int | Código referente ao usuário responsável por aquela tarefa |
descricao | não | String | Descrição sobre a tarefa |
O campo dttermino torna-se obrigatório caso a evento seja de dia inteiro.
Caso os horários sejam iguais ao Procedo, irá atualizar o horário de término para 30 minutos após o horário de inicio.
Retorno
Código | Retorno |
0 | Token inválido, neste caso é necessário entrar em contato novamente para obter o código de acesso |
1 | Ok, o registro foi inserido |
9 | Tipo de tarefa deve ser T (tarefa) ou C (compromisso/evento); tipo informado inválido |
10 | Entidade deve ser emitente ou oportunidade; entidade informada inválida |
11 | Cliente/Prospect não encontrado |
12 | Data de término não pode ser inferior a data de início |
13 | Horário de término não pode ser inferior ao horário de início |
14 | Responsável não pode ser nulo |
15 | Responsável não encontrado |
16 | Data do início não foi informada. Caso o evento seja de dia inteiro a data término deve ser informada |
17 | Uma data ou as duas informadas estão inválidas, formato correto das datas: yyyy-mm-dd |
18 | Caso a tarefa seja do tipo T (tarefa) e a data do início seja invalida |
19 | Um ou os dois horários não foram informados |
20 | Um horário ou os dois informados estão inválidos, formato correto dos horários: HH:mm |
35 | Empresa sem acesso a funcionalidade solicitada |
99 | Erro ao processar a tarefa |
Exemplo
Exemplo de requisição com as informações sendo enviadas através do SoapUI:
<x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:SOAPServerWSDL" xmlns:tar="http://localhost.procedo.com.br/api/tarefaservice?wsdl"> <x:Header/> <x:Body> <urn:gravaTarefa> <urn:token>b1raff1de57740ere045f8da13f42943881c655flv</urn:token> <urn:tarefa> <tar:tipo>C</tar:tipo> <tar:entidade>oportunidade</tar:entidade> <tar:codentidade>1093</tar:codentidade> <tar:assunto>Exemplo de Tarefa</tar:assunto> <tar:dtinicio>2017-09-02</tar:dtinicio> <tar:dttermino>2017-09-02</tar:dttermino> <tar:hrinicio>13:00</tar:hrinicio> <tar:hrtermino>17:00</tar:hrtermino> <tar:diainteiro>0</tar:diainteiro> <tar:lembrete>30</tar:lembrete> <tar:responsavel>39</tar:responsavel> <tar:descricao>Exemplo de Tarefa</tar:descricao> </urn:tarefa> </urn:gravaTarefa> </x:Body> </x:Envelope>
Agora o exemplo de retorno com sucesso:
<?xml version="1.0" encoding="UTF-8"?> <SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"> <SOAP-ENV:Body> <ns1:gravaTarefaResponse xmlns:ns1="urn:SOAPServerWSDL"> <return xsi:type="xsd:string">1</return> </ns1:gravaTarefaResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>