github.com/voedger/voedger@v0.0.0-20240520144910-273e84102129/design/archive/0/requests-0.0.1/requests-examples.md (about)

     1  ### Просмотр проекции `inbox` (несортированные)
     2  
     3  `<user>/api/<wsid>/view/inbox`
     4  
     5  ```
     6  {
     7      "from": 123,
     8      "to": 456,
     9      "page" 3
    10  }
    11  ```
    12  
    13  ### Просмотр проекции `archive` (архив)
    14  `<user>/api/<wsid>/archive`
    15  
    16  
    17  ### Просмотр проекции `spam` (спам)
    18  `<user>/api/<wsid>/spam`
    19  
    20  
    21  ### Просмотр проекции `sent` (отправленные)
    22  `<user>/api/<wsid>/spam`
    23  
    24  
    25  ### Просмотр проекции `sent` (отправленные)
    26  `<user>/api/<wsid>/spam`
    27  
    28  ### Просмотр проекции `contacts`(адресной книги)
    29  `<user>/api/<wsid>/contacts`
    30  
    31  ### Создание объекта класса `email`
    32  `<user>/api/<wsid>/email` 
    33  
    34  ```
    35  {
    36      "from": 'yohanson@hmail.com',
    37      "to": 'gmp@hmail.com,smm@gmail.com',
    38      "bcc": 'ivs@gmail.com',
    39      "theme": 'Updated theme',
    40      "content": "..."
    41      "tags": [ ... ],
    42      "draft": null, 
    43      "send_date": 1575832455,
    44  }
    45  ```
    46  
    47  ### Изменение объекта класса `email`
    48  `<user>/api/<wsid>/email` 
    49  
    50  ```
    51  {
    52      "id": 123,
    53      "theme": 'Updated theme',
    54      "content": "New content"
    55  }
    56  ```
    57  
    58  ### Получение данных объекта класса `email`
    59  `<user>/api/<wsid>/email/<email id>` 
    60  
    61  ### Метод - изменяет статус email на 2 (удален)
    62  
    63  `<user>/api/<wsid>/email/status` 
    64  
    65  ```
    66  {
    67      "id": 987654321,
    68      "status": 2
    69  }
    70  ```
    71  
    72  ### Метод - отправка почтового сообщения
    73  `<user>/api/<wsid>/email/send` 
    74  
    75  ```
    76  {
    77      "id": 123
    78  }
    79  ```
    80  
    81  ### Соаздание/изменение объекта класса `accaunt`
    82  `<user>/api/<wsid>/accaunt`
    83  
    84  ### Метод - удаление аккаунта
    85  `<user>/api/<wsid>/accaunt/remove`
    86  
    87  ### Создание\изменение конфигурации
    88  
    89  Так как `config` определен как класс-синглетон, то для изменения его параметров не требует передавать id сущности
    90  
    91  `<user>/api/<wsid>/config`
    92  
    93  ```
    94  {
    95      "color": "#fff",
    96      "format": "dd.mm.yyyy"
    97  }
    98  ```
    99  
   100  ## Функции
   101  
   102  ### Добавить тег
   103  
   104  `<user>/api/<wsid>/addTag`
   105  
   106  ```
   107  {
   108      "tag": '<tag code>',
   109      "id": 13245, 
   110  }
   111  ```
   112  
   113  ### Удалить тег
   114  `<user>/api/<wsid>/removeTag`
   115  
   116  ```
   117  {
   118      "tag": '<tag code>',
   119      "id": 13245, 
   120  }
   121  ```
   122  
   123  ### Поиск по почте
   124  `<user>/api/<wsid>/search`
   125  
   126  ```
   127  {
   128      "text": 'Search string',
   129  }
   130  ```
   131  
   132  ### Массовое изменение состояния
   133  `<user>/api/<wsid>/changeState`
   134  
   135  ```
   136  {
   137      "id": [ <id>, <id>, ... ],
   138      "state": 2
   139  }
   140  ```