Метод Register Hero

Тип запроса

POST

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

application/json

URL

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

Описание

Используется для регистрации новых героев. Обязательное требование, чтобы введённые прозвище (nickname) и адрес электронной почты (email) ранее не были зарегистрированы. То есть необходимо вводить уникальные, ранее не использованные для регистрации параметры героя. Если вводить параметры, которые были использованы ранее, то регистрация закончится с ошибкой. Код ошибки указывает, какой параметр был введён неверно или какой параметр является копией уже существующего в системе (см. Ответ: 409 Conflict).

Запрос (request)

Обязательные параметры (в теле запроса):

  • nickname (прозвище) - произвольная строка длиной от 5 до 50 символов
  • email (электронная почта) - произвольная строка длиной от 6 до 50 символов
  • password (пароль) - произвольная строка длиной от 6 до 60 символов

Необязательные параметры (в теле запроса):

  • languageId (идентификатор языка) - целое число, сейчас доступны 1-русский, 2-английский
  • place (место нахождения или проживания) - строка длинной от 16 символов, это ID взятое из Google Maps, которое соответствует какому-то месту на карте google.

Ответ (response)

400 Bad Request

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

409 Conflict

Код ошибки (errorCode) AlreadyExistsError указывает, что герой с этими данными уже зарегистрирован. Параметр parameterName укажет какой параметр уже был использован в системе. Необходимо убедиться, что Вы ранее не регистрировались в системе, и если нет, то выбрать другое прозвище или зарегистрироваться с другим ящиком электронной почты.

Если код ошибки UnexpectedError, то необходимо связаться с нами, написав письмо на нашу электронную почту info@soopahero.com. В письме нужно указать время, и все данные, отправляемые Вами в теле запроса на сервер.

201 Created

Если запрос выполнен успешно, но вернется ответ, где в заголовке location будет URL, по которому можно получить сведения о пользователе. На электронную почту героя будет отправлено письмо с ссылкой для подтверждения электронной почты. При этом зарегистрированный герой будет заблокирован до тех пор пока он не подтвердит свою электронную почту.Также вернётся уникальный идентификатор token, который можно использовать в дальнейшем для авторизации и аутентификации. Этот идентификатор представляет собой строку из 16 символов.