Versions Compared

Key

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

...

Описание: Получить информацию по одному заведению

Адрес: https:/wiki/api.cloudtips.ru/api/places​/{id}spaces/TIPS/pages/1787396098

Тип: GET

Запрос:

-

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

...

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

Тип

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

Описание

name

String

Да

Поиск по названию

externalPlaceIdexternalInfo.id

String

Нет

Внешний идентификатор заведения

placeType

Integer

Нет

Тип заведения

placeAdministratorId

Array of string

Нет

Администраторы заведения

employeesPage

 

Нет

Страница оплаты заведения

routeId

String

Нет

Уникальный идентификатор для URL

backgroundUrl

String

Нет

Картинка для страницы оплаты заведения

companyId

String

Нет

Идентификатор компании

webSite

String

Нет

Адрес сайта

comment

String

Нет

Внутренний комментарий

addressInfo

String

Нет

Геоданные заведения

country

String

Нет

Страна

city

String

Нет

Город

address

String

Нет

Улица

latitude

Integer

Нет

Широта

longitude

Integer

Нет

Долгота

...

Code Block
{
  "name": "string",
  "externalPlaceIdexternalInfo": {
    "id": "string"
  },
  "placeType": 0,
  "managerId": "string",
  "placeAdministratorIds": [
    "string"
  ],
  "employeesPage": {
    "routeId": "string",
    "backgroundUrl": "string"
  },
  "companyId": "string",
  "webSite": "string",
  "comment": "string",
  "addressInfo": {
    "country": "string",
    "city": "string",
    "address": "string",
    "latitude": 0,
    "longitude": 0
  }
}

...

Описание: Позволяет включить страницу со списком всех сотрудников заведения. Для включения необходимо:

  1. Сделать запрос GET https:/wiki/api.cloudtips.ru/api​/places​/{placeId}​/payment-pages​/urls​/generatespaces/TIPS/pages/1787396098, передав уникальный идентификатор заведения

  2. Полученный URL необходимо передать. в поле routeId при Редактировании заведения

  3. По желанию на страницу можно загрузить фоновое изображение размером 600х300 рх. Картинка загружается в Загрузка изображения. Id загруженной картинки необходимо передать в поле backgroundld при Редактировании заведения

...

Описание: Позволяет отредактировать заведение. Можно передавать одно значение из списка, а не весь список.

Адрес: https:/wiki/api.cloudtips.ru/api/places​/{placeId}spaces/TIPS/pages/1787396098, где placeId - уникальный идентификатор заведения

...

Code Block
{
  "data": {
    "totalCount": 0,
    "items": [
      {
        "id": "string",
        "title": "string",
        "imageId": "string",
        "imageUrl": "string"
      }
    ]
  },
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

Отключение рейтинга

Описание: Отключает на странице оплаты блок с рейтингом

Адрес: https://api.cloudtips.ru/api/places/{placeId}/rating, где placeId - уникальный идентификатор заведения

Тип: DELETE

Запрос:

-

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

-

Ответ:

...

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

...

Тип

...

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

...

Описание

...

succeed

...

String

...

Да

...

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

...

errors

...

Array of string

...

Да

...

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

...

validationErrors

...

Array of string

...

Да

...

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

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

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

...