Changes between Version 58 and Version 59 of WebServiceDraft

Timestamp:

04/30/12 07:57:16 (12 years ago)

Author:

pereira.jair

Comment:

--

WebServiceDraft

@@ -52 +52 @@
 \
 \
-||'''Método:'''||'''ExpressoLivre.getAvailableServers'''||Retorna uma lista de servidores do expresso, para que centralize uma lista de servidores ativos que estao utilizando a nova API.||
+||'''Método:'''||'''/AvailableServers'''||Retorna uma lista de servidores do expresso, para que centralize uma lista de servidores ativos que estao utilizando a nova API.||
 ||'''Parâmetros:'''|| Sem Parametros || ||
 ||'''Retorno:'''||-serverName,\-serverDescription,\-serverUrl,\-serverContext,\-serverStatus|| ||
-||Retorno de Exemplo (JSON):||||{"result":{"servers":[{"serverID":"007","serverName":"dev.expresso.celepar.parana","serverDescription":" Servidor de Homologau00e7u00e3o - versu00e3o 2.4","serverUrl":"http://dev.expresso.celepar.parana","serverContext":"/api/webservice.php","serverStatus":"1"}]},"error":null,"id":"1"}
+||Retorno de Exemplo (JSON):||||{"result":{"servers":[{"serverID":"007","serverName":"dev.expresso.celepar.parana","serverDescription":" Servidor de Homologau00e7u00e3o - versu00e3o 2.4","serverUrl":"http://dev.expresso.celepar.parana","serverContext":"/api/rest/","serverStatus":"1"}]},"error":null,"id":"1"}
 \
 
@@ -62 +62 @@
 \
 \
-||'''Método:'''||'''Expresso.login'''||Criar sessão autenticada no Expresso||
+||'''Método:'''||'''/Login'''||Criar sessão autenticada no Expresso||
 ||'''Parâmetros:'''||-user\-password\-auth||-Login do Usuario.\-Senha do usuario.\-Autenticacao existente, caso ja esteja logado.||
 ||'''Retorno:'''||-auth\-profile[] array(\contactID,\contactMails[],\contactPhones[],\contactFullName\)\||auth: Chave de autenticacao do expresso (KP3+SESSIONID do usuario).\profile: Array Contendo informações do usuário.\contactID: uidNumber do usuário\contactMails[]: Endereço de email\contactPhones[]: Telefone comercial (corporativo)\contactFullName: Nome completo\\||
@@ -68 +68 @@
 \
 \
-||'''Método:'''||'''Expresso.logout'''||Finalizar sessão autenticada no Expresso||
+||'''Método:'''||'''/Logout'''||Finalizar sessão autenticada no Expresso||
 ||'''Parâmetros:'''||-auth||auth:Autenticacao existente, necessaria para destruir a sessao do usuario.||
 ||'''Retorno:'''||-hasLogout||-hasLogout:(Boolean 0 ou 1 indicando se o logout foi realizado com sucesso)||
 \
 \
-||'''Método:'''||'''Mail.getUserFolders'''||Listar pastas de Email||
+||'''Método:'''||'''/Mail/Folders'''||Listar pastas de Email||
 ||'''Parâmetros:'''||-auth\-search\-page\-resultsPerPage||auth:Autenticacao do usuario.\search:filtro por nome de pasta\page:pagina atual\resultsPerPage:Numero de resultados a retornar por pagina.||
 ||'''Retorno:'''||-folders array(\folderName,\folderID,\folderType,\folderParentID,\folderHasChildren,\qtdMessages,\qtdUnreadMessages,\percentUsageOfTotalQuota,\diskSize\)\-diskSizeUsed\-diskSizeLimit\-diskSizePercent||folders:Array com todas as pastas retornadas.\folderName:Nome da pasta.\folderID:Caminho da pasta\folderType:(1-Caixa de Entrada,2-Enviadas,3-Rascunhos,4-Lixeira,5-Pasta Comum,6-Pasta Compartilhada)\folderHasChildren:(Boolean 0 ou 1)Indica se a pasta possui sub-pastas ou nao.\qtdMessages:Quantidade de Mensagens na pasta.\qtdUnreadMessages:Quantidade de Mensagens nao lidas.\percentUsageOfTotalQuota:Percentual utilizado da quota do usuario para esta pasta.\diskSize:Tamanho total da pasta utilizado do disco em Bytes.\\diskSizeUsed:Utilizacao total da quota do usuario\diskSizeLimit:Limite de Quota total do Usuario.\diskSizePercent:Percentual de utilizacao da quota total do usuario.||
@@ -79 +79 @@
 \
 \
-||'''Método:'''||'''Mail.getUserMessages'''||Listar mensagens de uma pasta de Email||
+||'''Método:'''||'''/Mail/Messages'''||Listar mensagens de uma pasta de Email||
 ||'''Parâmetros:'''||-auth\-folderID\-msgID\-search\-page\-resultsPerPage||auth:Autenticacao do usuario.\folderID:Filtro por pastas (so retornara mensagens da pasta informada)\\search:filtro por assunto da mensagem, conteudo.\page:pagina atual\resultsPerPage:Numero de resultados a retornar por pagina.||
 ||'''Retorno:'''||messages array(\msgID,\folderID,\msgDate,\msgFrom array(fullName,mailAddress),\msgTo array(array(fullName,mailAddress)),\msgReplyTo array(array(fullName,mailAddress)),\msgCC array(array(fullName,mailAddress)),\msgBCC array(array(fullName,mailAddress)),\msgBodyResume,\msgBody,\msgSeen,\msgHasAttachments,\msgAnswered,\msgFlagged,\msgDeleted,\msgDraft,\msgForwarded,\msgSize\)||-messages:Array com todas as mensagens retornadas.\msgID:Identificador da mensagem.\folderID:Identificador da Pasta da Mensagem.\msgDate:(YYYY-mm-dd H:i:s) \msgFrom: Array com o Nome do contato e email (fullName,mailAddress)\msgReplyTo,msgTo,msgCC,msgBCC: Sao arrays e retornam N arrays contendo (fullName,mailAddress)\msgBodyResume:Resumo do conteudo da mensagem (sem tags html)\msgBody:Conteudo da Mensagem, campo somente retorna valores quando e passado o parametro msgID que especifica qual mensagem sera exibida.\msgSeen:Boolean indicando se a mensagem foi marcada como lida.\msgHasAttachments:Boolean - indica se tem anexos ou nao.\msgAnswered:Boolean - flag do imap para Respondida\msgFlagged:Boolean - flag do imap para importantes\msgDeleted:Boolean - flag do imap para Deleted.\msgDraft:Boolean - flag do imap para Drafts.\msgForwarded:\msgSize:Tamanho da mensagem em Bytes.||
@@ -85 +85 @@
 \
 \
-||'''Método:'''||'''Catalog.getUserContacts'''||Retorna os Contatos do usuario, pode trazer os contatos pessoais da agenda, como do catalogo geral, diferenciando-os apenas pelo type.||
+||'''Método:'''||'''/Catalog/Contacts'''||Retorna os Contatos do usuario, pode trazer os contatos pessoais da agenda, como do catalogo geral, diferenciando-os apenas pelo type.||
 ||'''Parâmetros:'''||-auth\-search\-contactType\-page\-resultsPerPage||auth:Autenticacao do usuario.\search: busca por nome ou email do contato.\contactType:(1:Agenda do Expresso,2:Catalogo Geral.)||
 ||'''Retorno:'''||-contacts array(\contactID,\contactFullName,\contactAlias,\contactFirstName,\contactLastName,\contactHasImagePicture,\contactType,\contactMails array(),\contactPhones,\contactBirthDate,\contactNotes\)||contactID: Identificador do Contato.\contactFullName:Nome completo do Contato\contactFirstname:Primeiro nome do contato\contactLastName:Ultimo Nome do Contato\contactHasImagePicture:Boolean (0:Nao tem foto,1:possui foto).\contactType:(1:Agenda do Expresso,2:Catalogo Geral.)\contactMails:Array com os Emails do contato.\contactPhones:Array com os telefones do contato.||
@@ -91 +91 @@
 \
 \
-||'''Método:'''||'''Catalog.getImagePicture'''||Retorna o BASE64 da Imagem de Um contato.||
+||'''Método:'''||'''/Catalog/ContactPicture'''||Retorna o BASE64 da Imagem de Um contato.||
 ||'''Parâmetros:'''||-auth\-search\-contactType\contactID||auth:Autenticacao do usuario.\contactType:(1:Agenda do Expresso,2:Catalogo Geral.)\contactID:Identificador do Contato.||
 ||'''Retorno:'''||-contacts array(\contactID,\contactImagePicture\)||contactID: Identificador do Contato.\contactImagePicture:Base64 da foto do contato.||
@@ -97 +97 @@
 \
 \
-||'''Método:'''||'''Mail.addUserFolder'''||Adiciona uma nova pasta, Retorna um erro caso ja exista uma pasta com esse nome.||
+
+
+----
+== 7. Recursos a serem implementados ==
+\
+\
+||'''Método:'''||'''/Mail/AddFolder'''||Adiciona uma nova pasta, Retorna um erro caso ja exista uma pasta com esse nome.||
 ||'''Parâmetros:'''||-auth\-parentFolderID\-folderName||auth:Autenticacao do usuario.\parentFolderID:Pasta Raiz na qual sera criada uma nova pasta.\folderName:Nome da Nova Pasta.||
 ||'''Retorno:'''||-folderID||folderID: Identificador da nova pasta.||
@@ -103 +109 @@
 \
 \
-||'''Método:'''||'''Expresso.sendSupportFeedback'''||Envia um email de sugestao para o administrador do expresso, a funcao devera enviar uma mensagem como se fosse o usuario logado para o administrador.||
+||'''Método:'''||'''/SendSupportFeedBack'''||Envia um email de sugestao para o administrador do expresso, a funcao devera enviar uma mensagem como se fosse o usuario logado para o administrador.||
 ||'''Parâmetros:'''||-auth\-message||auth:Autenticacao do usuario.\message:Mensagem que sera enviada para o administador do expresso.||
 ||'''Retorno:'''||-OK||OK: 1.||
@@ -109 +115 @@
 \
 \
-
-----
-== 7. Recursos a serem implementados ==
-\
-\
-||'''Método:'''||'''Mail.delUserFolder'''||Remove uma pasta de um usuario.||
+||'''Método:'''||'''/Mail/DelFolder'''||Remove uma pasta de um usuario.||
 ||'''Parâmetros:'''||-auth\-folderID||auth:Autenticacao do usuario.\folderID:FolderID da pasta que sera removida.||
 \
 \
-||'''Método:'''||'''Mail.moveMessage'''||Move uma mensagem de uma pasta para outra.||
+||'''Método:'''||'''/Mail/MoveMessage'''||Move uma mensagem de uma pasta para outra.||
 ||'''Parâmetros:'''||-auth\-msgID\-folderID\-newFolderID||auth:Autenticacao do usuario.\msgID:ID da mensagem que sera movida.\folderID:FolderID da pasta que esta a mensagem.\ newFolderID:ID da pasta para qual a mensagem sera movida.||
 \
 \
-||'''Método:'''||'''Mail.delMessage'''||Apaga uma Mensagem do Servidor.||
+||'''Método:'''||'''/Mail/DelMessage'''||Apaga uma Mensagem do Servidor.||
 ||'''Parâmetros:'''||-auth\-msgID||auth:Autenticacao do usuario.\msgID:ID da mensagem que sera apagada.||
 \
 \
-||'''Método:'''||'''Mail.cleanTrash'''||Limpa a lixeira.||
+||'''Método:'''||'''/Mail/CleanTrash'''||Limpa a lixeira.||
 ||'''Parâmetros:'''||-auth||auth:Autenticacao do usuario.||
 \
 \
-||'''Método:'''||'''Mail.sendMessage'''||Envia uma Mensagem.||
+||'''Método:'''||'''/Mail/Send'''||Envia uma Mensagem.||
 ||'''Parâmetros:'''||-auth\-msgSubject\-msgTo\-msgFrom\-msgContent\-msgForwardTo\-msgCcTo\-msgBccTo\-originalMsgID\-originalUserAction - (1:Forwarded,2:Reply,3:ReplyToAll)||auth:Autenticacao do usuario.||
 \
 \
-||'''Método:'''||'''Mail.saveMessageAsDraft'''||Salva uma mensagem como Rascunho.||
+||'''Método:'''||'''/Mail/SaveAsDraft'''||Salva uma mensagem como Rascunho.||
 ||'''Parâmetros:'''||-auth\-msgSubject\-msgTo\-msgFrom\-msgContent\-msgForwardTo\-msgCcTo\-msgBccTo\-originalMsgID\-originalUserAction - (1:Forwarded,2:Reply,3:ReplyToAll)||auth:Autenticacao do usuario.||