Changes between Version 58 and Version 59 of WebServiceDraft
- Timestamp:
- 04/30/12 07:57:16 (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WebServiceDraft
v58 v59 52 52 \\ 53 53 \\ 54 ||'''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.||54 ||'''Método:'''||'''/AvailableServers'''||Retorna uma lista de servidores do expresso, para que centralize uma lista de servidores ativos que estao utilizando a nova API.|| 55 55 ||'''Parâmetros:'''|| Sem Parametros || || 56 56 ||'''Retorno:'''||-serverName,\\-serverDescription,\\-serverUrl,\\-serverContext,\\-serverStatus|| || 57 ||Retorno de Exemplo (JSON):||||{"result":{"servers":[{"serverID":"007","serverName":"dev.expresso.celepar.parana","serverDescription":" Servidor de Homologa\u00e7\u00e3o - vers\u00e3o 2.4","serverUrl":"http:\/\/dev.expresso.celepar.parana","serverContext":"\/api\/ webservice.php","serverStatus":"1"}]},"error":null,"id":"1"}57 ||Retorno de Exemplo (JSON):||||{"result":{"servers":[{"serverID":"007","serverName":"dev.expresso.celepar.parana","serverDescription":" Servidor de Homologa\u00e7\u00e3o - vers\u00e3o 2.4","serverUrl":"http:\/\/dev.expresso.celepar.parana","serverContext":"\/api\/rest\/","serverStatus":"1"}]},"error":null,"id":"1"} 58 58 \\ 59 59 … … 62 62 \\ 63 63 \\ 64 ||'''Método:'''||''' Expresso.login'''||Criar sessão autenticada no Expresso||64 ||'''Método:'''||'''/Login'''||Criar sessão autenticada no Expresso|| 65 65 ||'''Parâmetros:'''||-user\\-password\\-auth||-Login do Usuario.\\-Senha do usuario.\\-Autenticacao existente, caso ja esteja logado.|| 66 66 ||'''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 \\ 69 69 \\ 70 ||'''Método:'''||''' Expresso.logout'''||Finalizar sessão autenticada no Expresso||70 ||'''Método:'''||'''/Logout'''||Finalizar sessão autenticada no Expresso|| 71 71 ||'''Parâmetros:'''||-auth||auth:Autenticacao existente, necessaria para destruir a sessao do usuario.|| 72 72 ||'''Retorno:'''||-hasLogout||-hasLogout:(Boolean 0 ou 1 indicando se o logout foi realizado com sucesso)|| 73 73 \\ 74 74 \\ 75 ||'''Método:'''||''' Mail.getUserFolders'''||Listar pastas de Email||75 ||'''Método:'''||'''/Mail/Folders'''||Listar pastas de Email|| 76 76 ||'''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.|| 77 77 ||'''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 \\ 80 80 \\ 81 ||'''Método:'''||''' Mail.getUserMessages'''||Listar mensagens de uma pasta de Email||81 ||'''Método:'''||'''/Mail/Messages'''||Listar mensagens de uma pasta de Email|| 82 82 ||'''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.|| 83 83 ||'''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 \\ 86 86 \\ 87 ||'''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.||87 ||'''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.|| 88 88 ||'''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.)|| 89 89 ||'''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 \\ 92 92 \\ 93 ||'''Método:'''||''' Catalog.getImagePicture'''||Retorna o BASE64 da Imagem de Um contato.||93 ||'''Método:'''||'''/Catalog/ContactPicture'''||Retorna o BASE64 da Imagem de Um contato.|| 94 94 ||'''Parâmetros:'''||-auth\\-search\\-contactType\\contactID||auth:Autenticacao do usuario.\\contactType:(1:Agenda do Expresso,2:Catalogo Geral.)\\contactID:Identificador do Contato.|| 95 95 ||'''Retorno:'''||-contacts array(\\contactID,\\contactImagePicture\\)||contactID: Identificador do Contato.\\contactImagePicture:Base64 da foto do contato.|| … … 97 97 \\ 98 98 \\ 99 ||'''Método:'''||'''Mail.addUserFolder'''||Adiciona uma nova pasta, Retorna um erro caso ja exista uma pasta com esse nome.|| 99 100 101 ---- 102 == 7. Recursos a serem implementados == 103 \\ 104 \\ 105 ||'''Método:'''||'''/Mail/AddFolder'''||Adiciona uma nova pasta, Retorna um erro caso ja exista uma pasta com esse nome.|| 100 106 ||'''Parâmetros:'''||-auth\\-parentFolderID\\-folderName||auth:Autenticacao do usuario.\\parentFolderID:Pasta Raiz na qual sera criada uma nova pasta.\\folderName:Nome da Nova Pasta.|| 101 107 ||'''Retorno:'''||-folderID||folderID: Identificador da nova pasta.|| … … 103 109 \\ 104 110 \\ 105 ||'''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.||111 ||'''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.|| 106 112 ||'''Parâmetros:'''||-auth\\-message||auth:Autenticacao do usuario.\\message:Mensagem que sera enviada para o administador do expresso.|| 107 113 ||'''Retorno:'''||-OK||OK: 1.|| … … 109 115 \\ 110 116 \\ 111 112 ---- 113 == 7. Recursos a serem implementados == 114 \\ 115 \\ 116 ||'''Método:'''||'''Mail.delUserFolder'''||Remove uma pasta de um usuario.|| 117 ||'''Método:'''||'''/Mail/DelFolder'''||Remove uma pasta de um usuario.|| 117 118 ||'''Parâmetros:'''||-auth\\-folderID||auth:Autenticacao do usuario.\\folderID:FolderID da pasta que sera removida.|| 118 119 \\ 119 120 \\ 120 ||'''Método:'''||''' Mail.moveMessage'''||Move uma mensagem de uma pasta para outra.||121 ||'''Método:'''||'''/Mail/MoveMessage'''||Move uma mensagem de uma pasta para outra.|| 121 122 ||'''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.|| 122 123 \\ 123 124 \\ 124 ||'''Método:'''||''' Mail.delMessage'''||Apaga uma Mensagem do Servidor.||125 ||'''Método:'''||'''/Mail/DelMessage'''||Apaga uma Mensagem do Servidor.|| 125 126 ||'''Parâmetros:'''||-auth\\-msgID||auth:Autenticacao do usuario.\\msgID:ID da mensagem que sera apagada.|| 126 127 \\ 127 128 \\ 128 ||'''Método:'''||''' Mail.cleanTrash'''||Limpa a lixeira.||129 ||'''Método:'''||'''/Mail/CleanTrash'''||Limpa a lixeira.|| 129 130 ||'''Parâmetros:'''||-auth||auth:Autenticacao do usuario.|| 130 131 \\ 131 132 \\ 132 ||'''Método:'''||''' Mail.sendMessage'''||Envia uma Mensagem.||133 ||'''Método:'''||'''/Mail/Send'''||Envia uma Mensagem.|| 133 134 ||'''Parâmetros:'''||-auth\\-msgSubject\\-msgTo\\-msgFrom\\-msgContent\\-msgForwardTo\\-msgCcTo\\-msgBccTo\\-originalMsgID\\-originalUserAction - (1:Forwarded,2:Reply,3:ReplyToAll)||auth:Autenticacao do usuario.|| 134 135 \\ 135 136 \\ 136 ||'''Método:'''||''' Mail.saveMessageAsDraft'''||Salva uma mensagem como Rascunho.||137 ||'''Método:'''||'''/Mail/SaveAsDraft'''||Salva uma mensagem como Rascunho.|| 137 138 ||'''Parâmetros:'''||-auth\\-msgSubject\\-msgTo\\-msgFrom\\-msgContent\\-msgForwardTo\\-msgCcTo\\-msgBccTo\\-originalMsgID\\-originalUserAction - (1:Forwarded,2:Reply,3:ReplyToAll)||auth:Autenticacao do usuario.||
