Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Получение ссылки регистрации

Описание: Позволяет сгенерировать ссылку, которая привяжет пользователя к заведению

Адрес: https://api.cloudtips.ru/api/places/registration-url

Тип: POST

Запрос:

Наименование

Тип

Обязательность

Описание

placeId

string

Да

Идентификатор заведения

maxRegistrationCount

integer

Нет

Количество регистраций пользователей, доступных по ссылке. Минимальное значение 1, максимальное 100. По умолчанию значение 50

lifetime

integer

Нет

Время жизни ссылки в секундах. Минимальное значение 180 (3 минуты), максимальное 604800 (7 дней). По умолчанию значение 86400 (1 сутки)

Пример запроса:

Code Block
languagejson
{
  "placeId": "string",
  "maxRegistrationCount" : "integer",
  "lifetime" : "integer"
}

Ответ:

Наименование

Тип

Обязательность

Описание

succeed

String

Да

Статус запроса

url

String

Да

Ссылка регистрации пользователей

lifetime

integer

Да

Время жизни ссылки в секундах

errors

Array of string

Да

Возвращатеся список ошибок, относящихся целиком к запросу

validationErrors

Array of string

Да

Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

Пример ответа:

Code Block
languagejson
{
  "succeed": true,
  "statusCode": 0,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ]
  },
  "data": {
    "url": "string",
    "lifeTime": "integer"
  }
}