documentation-api/responses.yaml at master · bvladimir/documentation-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
4002001:
  description: |
    Ошибка в запросе.
  schema:
    type: object
    properties:
      errors:
         description: Массив объектов с информацией об ошибке.
         type: array
         items:
            type: object
            required:
              - code
            properties:
              code:
                description: |
                  Код ошибки в облаке Эвотор - 2001. Синтаксическая ошибка в запросе.
                type: integer
                default: 2001
40020012002:
  description: |
    Ошибка в запросе
  schema:
    type: object
    properties:
      errors:
        description: Массив объектов с информацией об ошибке.
        type: array
        items:
          type: object
          required:
            - code
          properties:
            code:
              description: |
                Код ошибки в облаке Эвотор. Возможные значения:
                  * 2001 - cинтаксическая ошибка в запросе.
                  * 2002 - в запросе отсутствует обязательное поле.
              type: integer
            reason:
              description: Причина возникновения ошибки.
              type: string
            subject:
              description: Название неизвестного или отсутствующего поля.
              type: string
  examples:
    application/json:
      errors:
        - code: 2002
          reason: missing
          subject: deviceUuid
        - code: 2002
          reason: unexpected
          subject: deviceUuid
40020012003:
  description: |
    Ошибка в запросе
  schema:
    type: object
    properties:
      errors:
         description: Массив объектов с информацией об ошибке.
         type: array
         items:
            type: object
            required:
              - code
            properties:
              code:
                description: |
                  Код ошибки в облаке Эвотор. Возможные значения:
                  * 2001 - cинтаксическая ошибка в запросе.
                  * 2003 - параметры запроса содержат недопустимые значения.
                type: integer
                example: 2001
              reason:
                description: Причина возникновения ошибки.
                type: string
                example: "incorrect"
              subject:
                description: Наименование поля
                type: string
                example: "deviceUuid"
              value:
                description: Значение.
                example: null
4011001:
  description: |
    Неверный токен облака Эвотор
  schema:
    type: object
    properties:
      errors:
         description: Массив объектов с информацией об ошибке.
         type: array
         items:
            type: object
            required:
              - code
            properties:
              code:
                description: |
                  Код ошибки в облаке Эвотор - 1001.
                type: integer
                example: 1001
40110011006:
  description: |
    Неверный токен
  schema:
    type: object
    properties:
      errors:
         description: Массив объектов с информацией об ошибке.
         type: array
         items:
            type: object
            required:
              - code
            properties:
              code:
                description: |
                  Код ошибки в облаке Эвотор. Возможные значения:
                  * 1001 - неверный токен облака Эвотор.
                  * 1006 - пользователь указал неверные данные при авторизации в стороннем сервисе.
                type: integer
                example: 1001
40110021003:
  description: |
    Неверный токен
  schema:
    type: object
    properties:
      errors:
         description: Массив объектов с информацией об ошибке.
         type: array
         items:
            type: object
            required:
              - code
            properties:
              code:
                description: |
                  Код ошибки в облаке Эвотор. Возможные значения:
                  * 1002 - неверный токен пользователя.
                  * 1003 - истёк срок действия токена пользователя.
                type: integer
                example: 1003
402:
  description: |
    Требуется оплата
  schema:
    type: object
    properties:
      errors:
         description: Массив объектов с информацией об ошибке.
         type: array
         items:
            type: object
            required:
              - code
            properties:
              code:
                description: |
                  Код ошибки в облаке Эвотор - 1004. Сторонний сервис возвращает этот код, если у пользователя приложения истекла подписка в стороннем сервисе.
                type: integer
                example: 1004
              reason:
                description: Причина возникновения ошибки.
                type: string
                default: "payment required"
              subject:
                description: Идентификатор пользователя в облаке Эвотор.
                type: string
                default: "userUuid"
              value:
                description: Значение идентификатора пользователя в облаке Эвотор.
                type: string
                example: "01-000000000015463"
404:
  description: |
    Отсутствует указанный ресурс
40510051007:
  description: |
    Терминал неактивен
  schema:
    type: object
    properties:
      errors:
         description: Массив объектов с информацией об ошибке.
         type: array
         items:
            type: object
            required:
              - code
            properties:
              code:
                description: |
                  Код ошибки в облаке Эвотор. Возможные значения:
                  * 1005 - на устройство не распространяется лицензия (reason: "not allowed").
                  * 1007 - лицензированных терминалов недостаточно для активации в рамках тарифа (reason: "license overhead").
                type: integer
                example: 1007
              reason:
                description: Причина возникновения ошибки.
                type: string
                example: "license overhead"
              subject:
                description: Идентификатор устройства в облаке Эвотор.
                type: string
                default: "deviceUuid"
              value:
                description: Значение идентификатора устройства в облаке Эвотор.
                type: string
                example: "93a9bfa3-7353-490d-aa54-8c6efe9d8a8f"
4051005:
  description: |
    Терминал неактивен
  schema:
    type: object
    properties:
      errors:
         description: Массив объектов с информацией об ошибке.
         type: array
         items:
            type: object
            required:
              - code
            properties:
              code:
                description: |
                  Код ошибки в облаке Эвотор - 1005. На устройство не распространяется лицензия (reason: "not allowed").
                type: integer
                default: 1005
              reason:
                description: Причина возникновения ошибки.
                type: string
                default: "not allowed"
              subject:
                description: Идентификатор устройства в облаке Эвотор.
                type: string
                default: "deviceUuid"
              value:
                description: Значение идентификатора устройства в облаке Эвотор.
                type: string
                example: "93a9bfa3-7353-490d-aa54-8c6efe9d8a8f"
4092004:
  description: |
    Ассоциация невозможна
  schema:
    type: object
    properties:
      errors:
         description: Массив объектов с информацией об ошибке.
         type: array
         required:
           -code
         items:
            type: object
            properties:
              code:
                description: Код ошибки в облаке Эвотор - 2004. В стороннем сервисе userUuid ассоциирован с другой учётной записью пользователя Эвотора.
                type: integer
                default: 2004
4092005:
  description: |
    Регистрация невозможна
  schema:
    type: object
    properties:
      errors:
         description: Массив объектов с информацией об ошибке.
         type: array
         required:
           - code
         items:
            type: object
            properties:
              code:
                description: Код ошибки в облаке Эвотор - 2005. В стороннем сервисе уже зарегистрирована учётная запись с указанными данными.
                type: integer
                default: 2005