-
Notifications
You must be signed in to change notification settings - Fork 0
Server API
Описание протокола работы сервера.
Для вызова любого метода, кроме регистрации нужно авторизоваться с помощью Basic Auth
Все методы api лежат по пути domain// Актуальная версия - v1.0
Ошибки отправляют соответствующий код ошибки и ответ в виде json
Ошибка:
- timestamp string - время в сложном и страшном формате
- status int - код ошибки
- error string - описание ошибки
- path string - uri по которому произошла ошибка
- 500 - внутренняя ошибка сервера
- 401 - неправильный логин или пароль
- 404 - данные не найдены
- 400 - неправильный запрос (объект уже существует)
- 403 - нет прав
Точка на карте
- latitude double - широта
- longitude double - долгота
Место где применяется карты
- name string - Название локации
- isCustom boolean - Нужно ли искать это место по названию на карте
- coordinates Coordinate[] - список добавленных пользователем локаций
Карта с расстоянием до неё
- id long - id карты
- distance long - расстояние в метрах
Список карт
- nearest CardWithDistance[] - список карт с билжайшим местом применения
- other long[] - остальные карты
Карта
- id long - id карты
- name string - отображаемое название карты
- barcode string - штрихкод на карте
- images long[] - список привязанных изображений
- locations Location[] - список мест применения карты
Объект не созданной карты
- name string - название карты (может быть null)
- barcode string - штрихкод карты (может быть null)
Ошибка
- timestamp string - время возникновения некотором хитром формате
- status int - код ответа
- error string - описание ошибки
- path string - uri на котором возникла ошибка
POST
Заголовки
- Login - логин нового пользователя
- Password - пароль нового пользователя
{"code":"ACCEPTED", "reason":"OK"} - пользователь зарегестрирован
{"code":"INTERNAL_SERVER_ERROR", "reason":"can't create new user"} - пользователь зарегестрирован
GET/POST
Ничего
{"code":"ACCEPTED", "reason":"OK"} - пользователь авторизован
{"code":"UNAUTHORIZED", "reason":"Wrong password"} - неправильный пользователь
POST
заголовок
- Password string - новый пароль
{"code":"ACCEPTED", "reason":"OK"} - пароль изменен
{"code":"UNAUTHORIZED", "reason":"Wrong password"} - неправильный пользователь
GET
- latitude double - широта (опицонально)
- longitude double = долгота (опицонально)
- CardList CardList - список с всеми картами и расстояниями до карт с билжайшими точками применения
GET
Параметры запроса
- id string - id карты
- Card Card - объект карты
POST
json объект
- сardEditor CardEditor - объект с новым состоянием карты Если поле не задано, то оно не будет изменено.
- Card Card - измененная карта
POST
json объект
- receivedCard RecivedCard - объект создания карты
- Card Card - объект созданной карты
GET
- id long - id изображения
Фалй в формате multipart/form-data
POST
- file file - файл изображения
- cardId long - id карточки к которой добавляется изображение Фалй отправляется в формате multipart/form-data
Данные изображения {"id":"id изображения", "cardId":"id карты к которой оно привязано"}
POST
- file file - файл изображения
- id long - id редактируемового изображение Фалй отправляется в формате multipart/form-data
Данные изображения {"id":"id изображения", "cardId":"id карты к которой оно привязано"}