API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Jan 19th, 2018
59
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 21.59 KB | None | 0 0
raw download clone embed print report
  1. ## API
  2.  
  3. Все запросы идут через sbs-api
  4.  
  5. ### Сохранение пользователя
  6.  
  7. ```
  8. POST /mrm/storeUser
  9. ```
  10.  
  11. Добавить mrm пользователя в справочник пользователей. Если пользователь уже был в справочнике, но был soft delete-нут, то он восстанавливается.
  12. Пользователю назначается роль, переданная в запросе.
  13.  
  14. **Маппинг запроса:**
  15.  
  16. | Параметр в<br/>REQUEST | Тип, длина | Обязательность | Описание |
  17. |-------------------------------------------------|------------|----------------|------------------------------|
  18. | tableNum | string | 1 | Табельный номер пользователя |
  19.  
  20. **Маппинг ответа:**
  21.  
  22. | Параметр в<br/>RESPONSE | Тип, длина | Обязательность | Описание |
  23. |----------------------------------------|---------------|----------------|------------------|
  24. | status | integer | 1 | Статус сообщения |
  25. | errorText | string / null | 1 | Текст ошибки |
  26.  
  27.  
  28. ### Видео
  29.  
  30. ```
  31. POST /mobile/videos/video/getTodayVideo
  32. ```
  33.  
  34. **Маппинг запроса:**
  35.  
  36. | Параметр в<br/>getTodayVideo-REQUEST | Тип, длина | Обязательность | Описание |
  37. |-----------------------------------|------------------------------------|----------------|------------------------------|
  38. | tableNum | string | 1 | Табельный номер пользователя |
  39. | currentDateTime | string:<br/>format:<br/>yyyy-MM-dd HH:mm:ss | 1 | Текущие дата и время |
  40. | videoId | integer | [0…1] | ID запрашиваемого видео |
  41.  
  42. **Маппинг ответа:**
  43.  
  44. | Параметр в<br/>list-profile-questions-RESPONSE | | | | Тип, длина | Обязательность | Описание |
  45. |--------------------------------------------|------------|--------------|------------|----------------|----------------|----------------------------------------------|
  46. | status | | | | integer | 1 | Статус сообщения |
  47. | errorText | | | | string / null | 1 | Текст ошибки |
  48. | videoInfoList | | | | array ofobject | [0…1] | Список видео-новостей к просмотру |
  49. | | bottomText | | | string | [0…1] | Подпись под видео-новостью |
  50. | | isRequired | | | boolean | [0…1] | Флаг обязательности |
  51. | | previewUrl | | | string | [0…1] | URL превьювидео-новости |
  52. | | title | | | string | [0…1] | Заголовок видео-новости |
  53. | | url | | | string | [0…1] | URL видео-новости |
  54. | | validFrom | | | string | [0…1] | Дата начала тестирования по видео-новости |
  55. | | validTo | | | string | [0…1] | Дата окончания тестирования по видео-новости |
  56. | | videoId | | | string | [0…1] | ID видео |
  57. | | questions | | | array ofobject | [0…1] | Массив вопросов тестирования |
  58. | | | questionId | | integer | [0…1] | ID вопроса |
  59. | | | questionText | | string | [0…1] | Текст вопроса |
  60. | | | videoId | | integer | [0…1] | ID видео-новости |
  61. | | | answers | | array ofobject | [0…1] | Массив ответов на вопрос тестирования |
  62. | | | | questionId | integer | [0…1] | ID вопроса |
  63. | | | | answerId | integer | [0…1] | ID ответа |
  64. | | | | answerText | string | [0…1] | Текст ответа |
  65. | | | | isCorrect | boolean | [0…1] | Флаг верного ответа |
  66.  
  67. ```
  68. POST /mobile/videos/video/getTodayVideoByVideoId
  69. ```
  70.  
  71. **Маппинг запроса:**
  72.  
  73. | Параметр в<br/>getTodayVideo-REQUEST | Тип, длина | Обязательность | Описание |
  74. |-----------------------------------|------------------------------------|----------------|------------------------------|
  75. | tableNum | string | 1 | Табельный номер пользователя |
  76. | currentDateTime | string:<br/>format:<br/>yyyy-MM-dd HH:mm:ss | 1 | Текущие дата и время |
  77. | videoId | integer | 1 | ID запрашиваемого видео |
  78.  
  79.  
  80. **Маппинг ответа:**
  81.  
  82. | Параметр в<br/>getTodayVideo-RESPONSE | | | | Тип, длина | Обязательность | Описание |
  83. |--------------------------------------------|------------|--------------|------------|----------------|----------------|----------------------------------------------|
  84. | status | | | | integer | 1 | Статус сообщения |
  85. | errorText | | | | string / null | 1 | Текст ошибки |
  86. | videoInfoList | | | | array ofobject | [0…1] | Список видео-новостей к просмотру |
  87. | | bottomText | | | string | [0…1] | Подпись под видео-новостью |
  88. | | isRequired | | | boolean | [0…1] | Флаг обязательности |
  89. | | previewUrl | | | string | [0…1] | URL превьювидео-новости |
  90. | | title | | | string | [0…1] | Заголовок видео-новости |
  91. | | url | | | string | [0…1] | URL видео-новости |
  92. | | validFrom | | | string | [0…1] | Дата начала тестирования по видео-новости |
  93. | | validTo | | | string | [0…1] | Дата окончания тестирования по видео-новости |
  94. | | videoId | | | string | [0…1] | ID видео |
  95. | | questions | | | array ofobject | [0…1] | Массив вопросов тестирования |
  96. | | | questionId | | integer | [0…1] | ID вопроса |
  97. | | | questionText | | string | [0…1] | Текст вопроса |
  98. | | | videoId | | integer | [0…1] | ID видео-новости |
  99. | | | answers | | array ofobject | [0…1] | Массив ответов на вопрос тестирования |
  100. | | | | questionId | integer | [0…1] | ID вопроса |
  101. | | | | answerId | integer | [0…1] | ID ответа |
  102. | | | | answerText | string | [0…1] | Текст ответа |
  103. | | | | isCorrect | boolean | [0…1] | Флаг верного ответа |
  104.  
  105. ```
  106. POST /mobile/videos/video/incorrectQA
  107. ```
  108.  
  109. **Маппинг запроса:**
  110.  
  111. | Параметр в<br/>video-incorrectQA-request | Тип, длина | Обязательность | Описание |
  112. |-----------------------------------|-----------------|----------------|-----------------------------------------------|
  113. | videoId | integer | 1 | ID Видео |
  114. | answerTime | string | 1 | Время окончания тестирования по видео-новости |
  115. | questionIds | array of integer | 1 | ID вопросов, на которые дан неверный ответ |
  116. | tableNum | string | 1 | Табельный номер пользователя |
  117.  
  118. **Маппинг ответа:**
  119.  
  120. | Параметр в log-videonews-view-RESPONSE | Тип, длина | Обязательность | Описание |
  121. |----------------------------------------|---------------|----------------|------------------|
  122. | status | integer | 1 | Статус сообщения |
  123. | errorText | string / null | 1 | Текст ошибки |
  124.  
  125. ```
  126. POST /mobile/videos/video/setCompleted
  127. ```
  128.  
  129. Пользователь просмотрел видео.
  130. Пусто/пройден(setCompleted), пропущен(skipped).
  131.  
  132. **Маппинг запроса:**
  133.  
  134. | Параметр в<br/>video-setCompleted-request | Тип, длина | Обязательность | Описание |
  135. |---------------------------------------|------------|----------------|------------------------------|
  136. | videoId | integer | 1 | ID видео |
  137. | tableNum | string | 1 | Табельный номер пользователя |
  138.  
  139. **Маппинг ответа:**
  140.  
  141. | Параметр в<br/>log-videonews-view-RESPONSE | Тип, длина | Обязательность | Описание |
  142. |----------------------------------------|---------------|----------------|------------------|
  143. | status | integer | 1 | Статус сообщения |
  144. | errorText | string / null | 1 | Текст ошибки |
  145.  
  146. ```
  147. POST /mobile/log/videonews/skipped
  148. ```
  149.  
  150. **Маппинг запроса:**
  151.  
  152. | Параметр в<br/>log-videonews-skipped-REQUEST | Тип, длина | Обязательность | Описание |
  153. |------------------------------------------|------------|----------------|-----------------------------------------|
  154. | startEventDatetime | string | 1 | Время начала просмотра видео-новости |
  155. | endEventDatetime | string | 1 | Время окончания просмотра видео-новости |
  156. | eventObjectId | integer | 1 | ID события |
  157. | tableNum | string | 1 | Табельный номер пользователя |
  158.  
  159. **Маппинг ответа:**
  160.  
  161. | Параметр в<br/>log-videonews-view-RESPONSE | Тип, длина | Обязательность | Описание |
  162. |----------------------------------------|---------------|----------------|------------------|
  163. | status | integer | 1 | Статус сообщения |
  164. | errorText | string / null | 1 | Текст ошибки |
  165.  
  166. ```
  167. POST /mobile/log/videonews/test/started
  168. ```
  169.  
  170. **Маппинг запроса:**
  171.  
  172. | Параметр в<br/>log-videonews-started-REQUEST | Тип, длина | Обязательность | Описание |
  173. |------------------------------------------|------------|----------------|-----------------------------------------|
  174. | startEventDatetime | string | 1 | Время начала просмотра видео-новости |
  175. | endEventDatetime | string | 1 | Время окончания просмотра видео-новости |
  176. | eventObjectId | integer | 1 | ID события |
  177. | tableNum | string | 1 | Табельный номер пользователя |
  178.  
  179. **Маппинг ответа:**
  180.  
  181. | Параметр в<br/>log-videonews-view-RESPONSE | Тип, длина | Обязательность | Описание |
  182. |----------------------------------------|---------------|----------------|------------------|
  183. | status | integer | 1 | Статус сообщения |
  184. | errorText | string / null | 1 | Текст ошибки |
  185.  
  186. ```
  187. POST /mobile/log/videonews/view
  188. ```
  189.  
  190. **Маппинг запроса:**
  191.  
  192. | Параметр в<br/>log-videonews-view-REQUEST | Тип, длина | Обязательность | Описание |
  193. |------------------------------------------|------------|----------------|-----------------------------------------|
  194. | startEventDatetime | string | 1 | Время начала просмотра видео-новости |
  195. | endEventDatetime | string | 1 | Время окончания просмотра видео-новости |
  196. | eventObjectId | integer | 1 | ID события |
  197. | tableNum | string | 1 | Табельный номер пользователя |
  198.  
  199.  
  200. **Маппинг ответа:**
  201.  
  202. | Параметр в<br/>log-videonews-view-RESPONSE | Тип, длина | Обязательность | Описание |
  203. |----------------------------------------|---------------|----------------|------------------|
  204. | status | integer | 1 | Статус сообщения |
  205. | errorText | string / null | 1 | Текст ошибки |
  206.  
  207.  
  208. ### Анкетирование
  209.  
  210. ```
  211. GET /mobile/profiles/profileQuestions/list
  212. ```
  213.  
  214. **Маппинг запроса:**
  215.  
  216. | Параметр | Тип, длина | Обязательность | Описание |
  217. |----------|------------|----------------|------------------------------|
  218. | tableNum | string | 1 | Табельный номер пользователя |
  219.  
  220. **Маппинг ответа:**
  221.  
  222. | Параметр в<br/>list-profile-questions-RESPONSE | | | Тип, длина | Обязательность | Описание |
  223. |--------------------------------------------|--------------------|------------|---------------------------|----------------|---------------------------------|
  224. | questions | | | array ofobject | [0…1] | Список вопросов |
  225. | | questionId | | integer | [0…1] | ID вопроса |
  226. | | questionText | | string | [0…1] | Текст вопроса |
  227. | | cdate | | string format: date-time | [0…1] | Дата создания вопроса |
  228. | | isDropdownQuestion | | boolean | [0…1] | Флаг выпадающего списка ответов |
  229. | | options | | array ofobject | [0…1] | Список вариантов ответа |
  230. | | | optionId | integer | [0…1] | ID варианта ответа |
  231. | | | questionId | integer | [0…1] | ID вопроса |
  232. | | | text | string | [0…1] | Текст варианта ответа |
  233.  
  234. ```
  235. POST /mobile/profiles/profileQuestions/saveAnswer
  236. ```
  237.  
  238. **Маппинг запроса:**
  239.  
  240. | Параметр в<br/>save-profile-question-answer-REQUEST | Тип, длина | Обязательность | Описание |
  241. |-------------------------------------------------|------------|----------------|------------------------------|
  242. | questionId | integer | [0…1] | ID вопроса |
  243. | answerText | string | [0…1] | Текст ответа |
  244. | tableNum | string | [0…1] | Табельный номер пользователя |
  245.  
  246. **Маппинг ответа:**
  247.  
  248. | Параметр в<br/>log-videonews-view-RESPONSE | Тип, длина | Обязательность | Описание |
  249. |----------------------------------------|---------------|----------------|------------------|
  250. | status | integer | 1 | Статус сообщения |
  251. | errorText | string / null | 1 | Текст ошибки |
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!