source: sandbox/webservice/restclient_new/js/resources.js @ 7808

Revision 7808, 14.0 KB checked in by alexandrecorreia, 11 years ago (diff)

Ticket #2507 - Criado um novo cliente REST para teste/documentação no Expresso.

  • Property svn:executable set to *
Line 
1// BEGIN Resources
2//
3// params =
4//      0 - Valores : text, passowrd
5//                      Descrição: Tipo do campo text ou password;
6//      1 - Valores : enabled, disabled
7//                      Descrição : Se a input está habilitada para inserir dados       
8//      2 - Valores : string
9//                      Descrição : tipo do dado
10//      3 - Valores : true, false
11//                      Descrição : Se o campo é um valor obrigatório para as requisições
12//      4 - Valores : vazio ou qualquer outro valor que seja padrão
13//                      Descrição : Caso o campo necessite de um valor default
14//      5 - Valores : Campo aberto
15//                      Descrição : Utilizado para informar ao usuário qual o tipo da informação é necessária                                   
16
17var resources_expresso =
18{
19        login :
20        {
21                apps    : [],           
22                id              : "login",
23                description : "Realiza a autenticação do usuário",
24                method : ["POST"],
25                rest   : "Login",
26                click  : "execute.ajax('login')",
27                params :
28                {
29                        auth :          ["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
30                        user :          [ "text", "enabled", "string", true, "", "Login do Usuário"],
31                        password:       [ "password", "enabled", "string", true, "", "Senha do Usuário"]
32                }
33        },
34
35        logout :
36        {
37                apps    : [],
38                id              : "logout",
39                description : "Desloga o usuário, invalidando a chave de autenticação",
40                method  : ["POST"],
41                rest    : "Logout",
42                click   : "execute.ajax('logout')",
43                params  :
44                {
45                        auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"]
46                }
47        },
48
49        expresso_version :
50        {
51                apps    : [],
52                id              : "expresso_version",
53                description : "Retorna a versão do Expressos e a Versão da API instalada",
54                method  : ["POST","GET"],
55                rest    : "ExpressoVersion",
56                click   : "execute.ajax('expresso_version')"
57        },
58
59        mail_folders :
60        {
61                apps    : ["mail"],
62                id              : "mail_folders",
63                description : "Lista as pastas do usuários",
64                method  : ["POST"],
65                rest    : "Mail/Folders",
66                click   : "execute.ajax('mail_folders')",
67                params  :
68                {
69                        auth            :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
70                        folderID        :["text", "enabled", "string", false, "", "Pasta base para a busca"],
71                        search          :["text", "enabled", "string", false, "", "Buscar pastas com o nome" ]
72                }
73        },
74
75        mail_add_folder :
76        {
77                apps    : ["mail"],             
78                id              : "mail_add_folder",
79                description : "Adiciona uma nova pasta.",
80                method  : ["POST"],
81                rest    : "Mail/AddFolder",
82                click   : "execute.ajax('mail_add_folder')",
83                params  :
84                {
85                        auth                    :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."],
86                        parentfolderID  :["text", "enabled", "string", true, "INBOX", "Pasta base para adicionar a nova pasta."],
87                        folderName              :["text", "enabled", "string", true, "", "Nome da nova Pasta."]
88                }
89        },
90
91        mail_messages :
92        {
93                apps    : ["mail"],             
94                id              : "mail_messages",
95                description : "Retorna as mensagens do usuário",
96                method  : ["POST"],
97                rest    : "Mail/Messages",
98                click   : "execute.ajax('mail_messages')",
99                params  :
100                {
101                        auth                    :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."],
102                        folderID                :["text", "enabled", "string", false, "INBOX", "Pasta base retornar as mensagens."],
103                        msgID                   :["text", "enabled", "string", false, "", "ID da mensagem."],
104                        search                  :["text", "enabled", "string", false, "", "Buscar pastas com o nome."],
105                        resultsPerPage  :["text", "enabled", "int", true, "10", "Resultados por página."],
106                        page                    :["text", "enabled", "int", true, "1", "Página Atual."]
107                }
108        },
109
110        mail_attachment :
111        {
112                apps    : ["mail"],             
113                id              : "mail_attachment",
114                description : "Retorna o anexo da mensagem para download",
115                method  : ["POST"],
116                rest    : "Mail/Attachment",
117                click   : "execute.ajax('mail_attachment')",
118                params  :
119                {
120                        auth                    :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."],
121                        folderID                :["text", "enabled", "string", false, "", "Pasta onde está localizada a mensagem."],
122                        messageID               :["text", "enabled", "string", false, "", "ID da mensagem na pasta."],
123                        attachmentID    :["text", "enabled", "string", false, "", "ID do anexo da mensagem."],
124                }
125        },
126
127        mail_send:
128        {
129                apps    :["mail"],
130                id              : "mail_send",
131                description : "Envia uma mensagem de email.",
132                method  : ["POST"],
133                rest    : "Mail/Send",
134                click   : "execute.ajax('mail_send')",
135                params  :
136                {
137                        auth            :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."],
138                        msgTo           :["text", "enabled", "string", true, "", "Enviar mensagem para."],
139                        msgCc           :["text", "enabled", "string", false, "", "Enviar mensagem com cópia para."],
140                        msgBcc          :["text", "enabled", "string", false, "", "Enviar mensagem com cópia oculta para."],
141                        msgSubject      :["text", "enabled", "string", true, "", "Assunto da mensagem."],
142                        msgBody         :["text", "enabled", "string", true, "", "Conteúdo da mensagem."]
143                }
144        },
145
146        mail_rename_folder:
147        {
148                apps    : ["mail"],             
149                id              : "mail_rename_folder",
150                description : "Renomeia uma pasta, recebe como parametros o \"folderID\" da pasta a ser renomeada, e o nome da nova pasta \"folderName\"",
151                method  : ["POST"],
152                rest    : "Mail/RenameFolder",
153                click   : "execute.ajax('mail_rename_folder')",
154                params  :
155                {
156                        auth            :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
157                        folderID        :["text", "enabled", "string", true, "", "ID (folderID) da pasta que será renomeada"],
158                        folderName      :["text", "enabled", "string", true, "", "Nome da nova Pasta"]
159                }
160        },
161
162        mail_del_folder:
163        {
164                apps    : ["mail"],             
165                id              : "mail_del_folder",
166                description : "Exclui uma pasta. Recebe como parametros o \"folderID\" da pasta que será excluída. Obs: Somente exclui a pasta se não houver mensagens dentro dela.",
167                method  : ["POST"],
168                rest    : "Mail/DelFolder",
169                click   : "execute.ajax('mail_del_folder')",
170                params  :
171                {
172                        auth            :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
173                        folderID        :["text", "enabled", "string", true, "", "ID (folderID) da pasta que será excluida."]   
174                }
175
176        },
177
178        mail_clean_trash:
179        {
180                apps    : ["mail"],             
181                id              : "mail_clean_trash",
182                description : "Limpa a Lixeira do Usuário",
183                method  : ["POST"],
184                rest    : "Mail/CleanTrash",
185                click   : "execute.ajax('mail_clean_trash')",
186                params  :
187                {
188                        auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."]     
189                }
190        },
191
192        mail_send_support_feedback:
193        {
194                apps    : ["mail"],             
195                id              : "mail_send_support_feedback",
196                description : "Envia uma mensagem de Sugestão para o administrador do Expresso.",
197                method  : ["POST"],
198                rest    : "Mail/SendSupportFeedback",
199                click   : "execute.ajax('mail_send_support_feedback')",
200                params  :
201                {
202                        auth    :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."],
203                        message :["text", "enabled", "string", true, "", "Mensagem de sugestão a ser enviada para o suporte do Expresso."]     
204                }
205        },
206
207        catalog_contacts:
208        {
209                apps    : ["catalog"],         
210                id              : "catalog_contacts",
211                description : "Retorna os contatos do Catálogo Pessoal e Geral, recebe como parametros o \"search\" como parametro de busca e o contactType (1-Pessoal, 2-Catálogo Geral)",
212                method  : ["POST"],
213                rest    : "Catalog/Contacts",
214                click   : "execute.ajax('catalog_contacts')",
215                params  :
216                {
217                        auth            :["text", "disabled", "string", true, "", "Chave de autenticação do usuário."],
218                        search          :["text", "enabled", "string", false, "", "Buscar contatos pelo nome"],
219                        contactType :["text", "enabled", "string", true, "", "Tipo do contato a ser buscado (1-Pessoal, 2-Catálogo Geral)."]
220                }
221        },
222
223        catalog_contact_picture:
224        {
225                apps    : ["catalog"],
226                id              : "catalog_contact_picture",
227                description : "Retorna a foto de um contato em BASE64. Recebe como parametros o \"contactID\" e o \"contactType\" (1-Pessoal, 2-Catálogo Geral).",
228                method  : ["POST"],
229                rest    : "Catalog/ContactPicture",
230                click   : "execute.ajax('catalog_contact_picture')",
231                params  :
232                {
233                        auth            :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
234                        contactID       :["text", "enabled", "string", false, "", "ID do Contato que será retornado a foto"],
235                        contactType :["text", "enabled", "string", false, "1", "Tipo do contato a ser buscado (1-Pessoal, 2-Catálogo Geral)" ] 
236                }
237
238        },
239
240        calendar_events:
241        {
242                apps    : ["calendar"],
243                id              : "calendar_events",
244                description : "Retorna os Eventos do Calendário, Recebe como parametro a data inicial \"dateStart\" e a data final \"dateEnd\" e retorna todos os eventos no periodo.",
245                method  : ["POST"],
246                rest    : "Calendar/Events",
247                click   : "execute.ajax('calendar_events')",
248                params  :
249                {
250                        auth            :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
251                        dateStart       :["text", "enabled", "string", true, "", "Data inicial de consulta da agenda(DD/MM/YYYY)"],
252                        dateEnd         :["text", "enabled", "string", true, "", "Data final de consulta da agenda(DD/MM/YYYY)"]
253                }
254        },
255
256        admin_create_user:
257        {
258                apps    : ["admin"],
259                id              : "admin_create_user",
260                description : "Cria um usuário no Expresso, necessário ter a permissão para a criação ( Módulo ExpressoAdmin )",
261                method  : ["POST"],
262                rest    : "Admin/CreateUser",
263                click   : "execute.ajax('admin_create_user')",
264                params  :
265                {
266                        auth                            :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"], 
267                        account_login           :["text", "enabled", "string", true, "", "Login do usuário"],
268                        account_email           :["text", "enabled", "string", true, "", "Email do usuário"],
269                        account_name            :["text", "enabled", "string", true, "", "Nome do usuário"],
270                        account_profile         :["text", "enabled", "string", true, "", "Perfil do usuário( Verifique se o perfil está disponível no servidor)"],
271                        account_password        :["password", "enabled", "string", true, "", "Senha do usuário"],
272                        account_re_password     :["password", "enabled", "string", true, "", "Confirmação da senha do usuário"],
273                        account_phone           :["text", "enabled", "string", true, "", "Telefone do usuário. Máscara padrão (00)0000-0000"],
274                        account_cpf                     :["text", "enabled", "string", true, "", "CPF do usuário. Máscara padrão 000.000.000-00"],
275                        account_rg                      :["text", "enabled", "string", true, "", "RG do usuário"],
276                        account_rg_uf           :["text", "enabled", "string", true, "", "UF"],
277                        account_description :["text", "enabled", "string", true, "", "Descrição do usuário"]
278                }
279        },
280
281        admin_search_user:
282        {       
283                apps    : ["admin"],
284                id              : "admin_search_user",
285                description : "Faz a busca de usuário(s) no Expresso, necessário ter a permissão para busca ( Módulo ExpressoAdmin)",
286                method  :[ "POST" ],
287                rest    : "Admin/SearchUser",
288                click   : "execute.ajax('admin_search_user')",
289                params  :
290                {
291                        auth                            :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
292                        account_search_user     :["text", "enabled", "string", true, "", "Procurar usuário ( igual ao módulo admin do expresso )"]             
293                }
294        },
295
296        admin_delete_user:
297        {
298                apps    : ["admin"],
299                id              : "admin_delete_user",
300                description : "Exclui um usário no Expresso, necessário ter a permissão para a exclusão ( Módulo ExpressoAdmin )",
301                method  : ["POST"],
302                rest    : "Admin/DeleteUser",
303                click   : "execute.ajax('admin_delete_user')",
304                params  :
305                {
306                        auth                                    :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
307                        account_uid_del                 :["text", "enabled", "string", true, "", "UID do usuário" ],
308                        account_uidnumber_del   :["text", "enabled", "string", true, "", "UIDNumber do usuário"]
309                }
310        },
311
312        admin_edit_user:
313        {
314                apps    : ["admin"],
315                id              : "admin_edit_user",
316                description : "Edita um usuário no Expresso, necessário ter a permissão para exclusão ( Módulo ExpressoAdmin )",
317                method  : ["POST"],
318                rest    : "Admin/EditUser",
319                click   : "execute.ajax('admin_edit_user')",
320                params  :
321                {
322                        auth                                    :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
323                        account_uidnumber_edit  :["text", "enabled", "string", true, "", "UIDNumber do usuário para edição"]
324                }
325        },
326
327        admin_rename_user:
328        {
329                apps    : ["admin"],           
330                id              : "admin_rename_user",
331                description : "Renomeia um usuário no Expresso, necessário ter a permissão para exclusão ( Módulo ExpressoAdmin )",
332                method  : ["POST"],
333                rest    : "Admin/RenameUser",
334                click   : "execute.ajax('admin_rename_user')",
335                params  :
336                {
337                        auth                                    :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
338                        account_uid_rename              :["text", "enabled", "string", true, "", "UID do usuário a ser renomeado."],
339                        account_uid_new_rename  :["text", "enabled", "string", true, "", "Novo UID do usuário ser renomeado."]
340                }
341        },
342
343        admin_update_user:
344        {
345                apps    : ["admin"],
346                id              : "admin_update_user",
347                description : "Atualiza um usuário no Expresso, necessário ter a permissão para exclusão ( Módulo ExpressoAdmin )",
348                method  : ["POST"],
349                rest    : "Admin/UpdateUser",
350                click   : "execute.ajax('admin_update_user')",
351                params  :
352                {
353                        auth                                    :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
354                        account_uidnumber_up    :["text", "enabled", "string", true, "", "UIDNumber do usuário"],       
355                        account_login_up                :["text", "enabled", "string", true, "", "Login do usuário"],   
356                        account_email_up                :["text", "enabled", "string", true, "", "Email do usuário"],   
357                        account_name_up                 :["text", "enabled", "string", true, "", "Nome do usuário"],   
358                        account_password_up     :["text", "enabled", "string", true, "", "Senha do usuário"],   
359                        account_re_password_up  :["text", "enabled", "string", true, "", "Confirmação do usuário"],     
360                        account_phone_up                :["text", "enabled", "string", true, "", "Telefone do usuário. Máscara padrão (00)0000-0000"], 
361                        account_cpf_up                  :["text", "enabled", "string", true, "", "CPF do usuário. Máscara padrão 000.000.000-00"],     
362                        account_rg_up                   :["text", "enabled", "string", true, "", "RG do usuário"],     
363                        account_rg_uf_up                :["text", "enabled", "string", true, "", "UF"],         
364                        account_description_up  :["text", "enabled", "string", true, "", "Descrição do usuário"]       
365                }
366        },
367
368        recurso_alexandre:
369        {
370                apps    : ["admin"],
371                id              : "recurso_alexandre",
372                description : "Um novo recurso do alexandre",
373                method  : ["POST"],
374                rest    : "Rec/Alexandre",
375                click   : "execute.ajax('recurso_alexandre')",
376                params  :
377                {
378                        auth :["text", "disabled", "string", true, "", "Chave de autenticação do usuário"],
379                        textMeu :["text", "enabled", "string", true, "", "Meu campo para ser enviado."],
380                        textMeu1 :["text", "enabled", "string", true, "", "Meu campo para ser enviado."]
381                }
382        }
383};
384// END Resources
Note: See TracBrowser for help on using the repository browser.