Методы Get Last Heroes и Get Best Heroes

Тип запроса

GET

Тип сообщения

application/json

URL

http://www.soopahero.com/api/heroes/last

http://www.soopahero.com/api/heroes/best

Описание

Используются для формирования рейтинга героев. Существует страница героев, где можно сортировать героев по дате регистрации и по количеству полученной кармы. Эти методы позволяют извлекать героев из базы данных и возвращать, как по возрастанию, так и по убыванию. Для постраничного отображения (pagination) героев используются дополнительные параметры для коротких запросов. Каждый возвращаемый герой из списка содержит в себе следующие данные:

  • nickname - прозвище героя
  • description - описание героя
  • karma - количество кармы, полученное этим героем
  • created - время регистрации героя в милисекундах
  • place - место проживания или временного нахождения героя (строка длинной от 16 символов, что соответствует определенному месту на карте Google)
  • exploitsCount - количество совершенных подвигов

Запрос (request)

Параметры (в строке запроса):

  • limit (граница) - целое число от 0 до плюс бесконечности, по умолчанию 20
  • offset (отступ) - целое число от 0 до плюс бесконечности, по умолчанию 0
  • place (место нахождения или проживания героя) - строка длинной от 16 символов, это ID взято из Google Maps и соответствует какому-то месту на карте Google.
  • order (направление сортировки) - принимает одно из двух значений ASC (по возрастанию) или DESC (по убыванию)

Ответ (response)

400 Bad Request

Код ошибки (errorCode) InputParameterError указывает, что один из параметров в строке запроса имеет неверное значение. Параметр parameterName укажет какой параметр был передан неверно, parameterValue - текущее значение, violationMessage - какое правило было нарушено. Необходимо исправить значение, указанное в ошибке, проверить формат сообщения и отправить запрос снова.

200 OK

Запрос выполнен успешно, и в ответе возвращается список героев. Список будет отсортирован по одному из двух параметров: дата регистрации или количество заработанной кармы в зависимости от вызываемого метода. Если в запросе есть параметр указывающий на порядок сортировки, то список будет отсортирован согласно используемому параметру. При желании разделить список на несколько частей необходимо использовать параметры limit и/или offset.