Content Comparison

...

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

Тип: GET

Запрос:

Наименование	Тип	Обязательность	Описание
createdDateFrom	String	Нет	Поиск по дате создания с
createdDateTo	String	Нет	Посик по дате создания по
name	String	Нет	Поиск по названию
administratorId	Array of string	Нет	Поиск по администратору
ids	Array of string	Нет	Поиск по уникальному идентификатору заведения
externalPlaceId	String	Нет	Внешний идентификатор заведения
isHeadPlace	Boolean	Нет	Родительское заведение, значения true и false
page	Integer	Нет	Ппагинация
limit	Integer	Нет	Ограничение на количество записей

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

Code Block

{
    "createdDateFrom": "string",
    "createdDateTo": "string",
    "name": "string",
    "administratorId": [
        "string"
    ],
    "ids": [
        "string"
    ],
    "externalPlaceId": "string",
    "isHeadPlace": "bollen",
    "page": "integer",
    "limit": "integer"
}

Ответ:

Наименование	Тип	Обязательность	Описание
id	String	Да	Уникальный идентификатор заведения
externalPlaceId	String	Да	Внешний идентификатор заведения
createdDate	String	Да	Дата создания
updatedDate	String	Да	Дата обновления
name	String	Да	Поиск по названию
placeType	Integer	Да	Тип завдениея, значения:
managerId	String	Да	Уникальный идентификатор менеджера
placeAdministratorId	Array of string	Да	Администраторы заведения
isHead	Boolean	Да	Головное заведение, значения true и false
headPlace	Integer	Да	Головное заведение
id	String	Да	Уникальный идентификатор родительского заведения
name	String	Да	Название родительского заведения
employeeCount	Integer	Да	Количество сотрудников в заведении
hasPaymentPageSettings	Boolean	Да	Включена страница оплаты для заведения, значения true и false
rating		Да	Рейтинг
enabled	Boolean	Да	Включен, значения true и false
components		Да	Компоненты рейтинга
id	String	Да	Уникальный идентификатор компонента
title	String	Да	Название компонента
imageId	String	Да	Уникальный идентификатор картинки
imageUrl	String	Да	URL картинки
averageScore	Integer	Да	Средний рейтинг
scoreCount	Integer	Да	Количество оценок
totalCount	Integer	Да	Количество записей
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

Code Block

{
  "data": {
    "items": [
      {
        "id": "string",
        "externalPlaceId": "string",
        "createdDate": "2021-05-31T12:09:54.104Z",
        "updatedDate": "2021-05-31T12:09:54.104Z",
        "name": "string",
        "placeType": 0,
        "managerId": "string",
        "placeAdministratorIds": [
          "string"
        ],
        "isHead": true,
        "headPlace": {
          "id": "string",
          "name": "string"
        },
        "employeeCount": 0,
        "hasPaymentPageSettings": true,
        "rating": {
          "enabled": true,
          "components": [
            {
              "id": "string",
              "title": "string",
              "imageId": "string",
              "imageUrl": "string"
            }
          ],
          "averageScore": 0,
          "scoreCount": 0
        }
      }
    ],
    "totalCount": 0
  },
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

...

Запрос:

-

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

-

Ответ:

Наименование	Тип	Обязательность	Описание
id	String	Да	Уникальный идентификатор заведения
externalPlaceId	String	Да	Внешний идентификатор заведения
createdDate	String	Да	Дата создания
updatedDate	String	Да	Дата обновления
name	String	Да	Поиск по названию
placeType	Integer	Да	Тип завдениея, значения:
managerId	String	Да	Уникальный идентификатор менеджера
placeAdministrators		Да	Администраторы заведения
userId	String	Да	Уникальный идентификатор администратора
name	String	Да	Имя администратора
isHead	Boolean	Да	Головное заведение, значения true и false
headPlace		Да	Головное заведение
id	String	Да	Уникальный идентификатор родительского заведения
name	String	Да	Название родительского заведения
employeeCount	Integer	Да	Количество сотрудников в заведении
hasPaymentPageSettings	Boolean	Да	Включена страница оплаты для заведения, значения true и false
rating		Да	Рейтинг
enabled	Boolean	Да	Включен, значения true и false
components		Да	Компоненты рейтинга
id	String	Да	Уникальный идентификатор компонента
title	String	Да	Название компонента
imageId	String	Да	Уникальный идентификатор картинки
imageUrl	String	Да	URL картинки
averageScore	Integer	Да	Средний рейтинг
scoreCount	Integer	Да	Количество оценок
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

Code Block

{
  "data": {
    "id": "string",
    "createdDate": "2021-06-01T09:50:26.271Z",
    "updatedDate": "2021-06-01T09:50:26.271Z",
    "name": "string",
    "externalPlaceId": "string",
    "leadId": "string",
    "webSite": "string",
    "comment": "string",
    "placeType": 0,
    "managerId": "string",
    "isHead": true,
    "placeCode": "string",
    "placeAdministrators": [
      {
        "userId": "string",
        "name": "string"
      }
    ],
    "employeesPage": {
      "disabled": true,
      "url": "string",
      "qrLink": "string",
      "backgroundUrl": "string",
      "disabledEmployees": [
        {
          "userId": "string",
          "disabledDate": "2021-06-01T09:50:26.271Z"
        }
      ]
    },
    "rating": {
      "enabled": true,
      "components": [
        {
          "id": "string",
          "title": "string",
          "imageId": "string",
          "imageUrl": "string"
        }
      ],
      "averageScore": 0,
      "scoreCount": 0
    },
    "childPlaces": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "headPlace": {
      "id": "string",
      "name": "string"
    },
    "payerFee": {
      "enabled": true,
      "buttonPosition": "string"
    },
    "addressInfo": {
      "country": "string",
      "city": "string",
      "address": "string",
      "latitude": 0,
      "longitude": 0
    },
    "employeesCount": 0
  },
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

...

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

Тип: POST

Запрос:

Наименование	Тип	Обязательность	Описание
name	String	Да	Поиск по названию
externalPlaceId	String	Нет	Внешний идентификатор заведения
placeType	Integer	Нет	Тип завдениея, значения:
placeAdministratorId	Array of string	Нет	Администраторы заведения
employeesPage		Нет	Страница оплаты заведения
routeId	String	Нет	Уникальный идентификатор для URL
backgroundUrl	String	Нет	Картинка для страницы оплаты заведения
childPlaceIds	Array of string	Нет	Уникальный идентификаторы дочерних заведений
isHead	Boolean	Нет	Головное заведение, значения true и false
webSite	String	Нет	Адрес сайта
comment	String	Нет	Внутренний комментарий
addressInfo	String	Нет	Геоданные заведения
country	String	Нет	Страна
city	String	Нет	Город
address	String	Нет	Улица
latitude	Integer	Нет	Широта
longitude	Integer	Нет	Долгота

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

Code Block

{
  "name": "string",
  "externalPlaceId": "string",
  "placeType": 0,
  "managerId": "string",
  "placeAdministratorIds": [
    "string"
  ],
  "employeesPage": {
    "routeId": "string",
    "backgroundUrl": "string"
  },
  "childPlaceIds": [
    "string"
  ],
  "isHead": true,
  "webSite": "string",
  "comment": "string",
  "addressInfo": {
    "country": "string",
    "city": "string",
    "address": "string",
    "latitude": 0,
    "longitude": 0
  }
}

Ответ:

Наименование	Тип	Обязательность	Описание
id	String	Да	Уникальный идентификатор заведения
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

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

...

Адрес: https://api.cloudtips.ru/api/place-administrators

Тип: POST

Запрос:

Наименование	Тип	Обязательность	Описание
email	String	Да	Email управляющего
phoneNumber	String	Нет	Номер телефона управляющего
name	String	Да	Имя управляющего
managerId	String	Нет	Уникальный идентификатор менеджера
placeIds	Array of string	Нет	Уникальные идентификаторы заведений
permissions	Integer(int32)	Нет	Разрешения применяемые к управляющему Доступные значения(enum): Создание заведения - 1 Редактирование заведения - 2 Создание получателя - 4 Редактирование получателя - 8 Привязка получателя - 16 Отвязка получателя - 32 Создание управляющего - 64 Редактирование страницы сотрудников - 128 Редактирование платежной страницы заведения - 256 Редактирование настроек рейтинга заведения - 512

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

Code Block
{ "email": "user@example.com", "phoneNumber": "string", "name": "string", "managerId": "string", "placeIds": [ "string" ], "permissions": 1 }

Ответ:

Наименование	Тип	Обязательность	Описание
succeed	Boolean	Нет	Стату запроса
errors	Array of string	Нет	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Нет	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса
data	Array of string	Нет
id		Нет	Уникальный идентификатор управляющего

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

Code Block

{
  "succeed": true,
  "statusCode": 0,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  },
  "data": {
    "id": "string"
  }
}

...

Адрес: https://api.cloudtips.ru/api/images

Тип: POST

Запрос:

Наименование	Тип	Обязательность	Описание
file	-	Да	Файл с картинкой

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

-

Ответ:

Наименование	Тип	Обязательность	Описание
imageId	String	Да	Уникальный идентификатор изображения
url	String	Да	Ссылка на изображение

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

Code Block
{ "imageId": "string", "url": "string" }

...

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

Тип: PATCH

Запрос:

Наименование	Тип	Обязательность	Описание
name	String	Да	Поиск по названию
placeType	Integer	Нет	Тип завдениея, значения:
webSite	String	Нет	Адрес сайта
employeesPage		Нет	Страница оплаты заведения
disabled	Boolean	Нет	Отключает страницу оплаты заведения, значения true и false
routeId	String	Нет	Уникальный идентификатор для URL, получаем в Включение страницы со списком всех сотрудников заведения
backgroundld	String	Нет	Фоновая картинка для страницы оплаты заведения, получаем в Загрузка изображения
disabledEmployeeIds	Array of string	Нет	Уникальные идентификаторы сотрудников, которые не должны показываться на странице оплаты заведения
addressInfo		Нет	Геоданные заведения
country	String	Нет	Страна
city	String	Нет	Город
address	String	Нет	Улица
latitude	Double	Нет	Широта
longitude	Double	Нет	Долгота

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

Code Block

[
    {
        "op": "replace",
        "path": "/Name",
        "value": "string"
    },
    {
        "op": "replace",
        "path": "/PlaceType",
        "value": "integer"
    },
    {
        "op": "replace",
        "path": "/WebSite",
        "value": "string"
    },
    {
        "op": "replace",
        "path": "/EmployeesPage",
        "value":
        {
            "Disabled": "bool",
            "RouteId": "string",
            "BackgroundId": "string",
            "DisabledEmployeeIds": [array of string]
        }
    },
    {
        "op": "replace",
        "path": "/AddressInfo",
        "value":
        {
            "Country": "string",
            "City": "string",
            "Address": "string",
            "Latitude": "double",
            "Longitude": "double"
        }
    }
]

Ответ:

Наименование	Тип	Обязательность	Описание
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

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

...

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

Тип: PUTPATCH

Запрос:

Наименование	Тип	Обязательность	Описание
RatingSettings	string

enabled

Нет

Boolean

Возможные значения:

Да

Code Block

Включен, значения true и false

componentIds

False,
True

False - рейтинг отключен

True - включен

ComponentIds

Array of string

Нет

Компоненты рейтинга необходимо получить отдельно - Компоненты рейтинга

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

Code Block

[
  {
    "enabledop": true,"replace",
    "path": "componentIds/ComponentIds",
    "value":  ["5fe5dd73232c3d447c4eea64","624406cb51770b5d8441051e"]
  },
  {
    "op": "replace",
    "path": "/RatingSettings",
    "value":  "string"
  }
]
}

Ответ:

Наименование	Тип	Обязательность	Описание
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

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

...

Адрес: https://api.cloudtips.ru/api/ratingcomponents

Тип: GET

Запрос:

Наименование	Тип	Обязательность	Описание
page	Integer	Нет	Пагинация
limit	Integer	Нет	Ограничение на количество записей

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

Code Block
{ "page" : "integer", "limit" : "integer" }

Ответ:

Наименование	Тип	Обязательность	Описание
totalCount	Integer	Да	Количество записей
items		Да	Записи
id	String	Да	Уникальный идентификатор
title	String	Да	Название
imageId	String	Да	Уникальный идентификатор картинки
imageUrl	String	Да	URL картинки
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

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"
    ]
  }
}

...

Запрос:

-

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

-

Ответ:

Наименование	Тип	Обязательность	Описание
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

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

...

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

Тип: GET

Запрос:

Наименование	Тип	Обязательность	Описание
placeId	String	Да	Уникальный идентификатор заведения
page	Integer	Нет	Пагинация
limit	Integer	Нет	Ограничение на количество записей

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

Code Block
{ "placeId": "sring", "page" : "integer", "limit" : "integer" }

Ответ:

Наименование	Тип	Обязательность	Описание
userId	String	Да	Уникальный идентификатор получателя
name	String	Да	Имя получателя
phoneNumber	String	Да	Телефон получателя
layoutIds	Array of string	Да	Уникальный идентификаторы страниц оплаты получателя
layoutId	String	Да	Уникальный идентификатор визитки
confirmationStatus	Integer	Да	Статус подтверждения привязки
attachedDate	String	Да	Дата и вреямя добавления в заведение
totalCount	Integer	Да	Количество записей
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

Code Block

{
  "data": {
    "items": [
      {
        "userId": "string",
        "name": "string",
        "phoneNumber": "string",
        "layoutIds": [
          "string"
        ],
        "attachedDate": "2021-06-01T11:42:46.902Z"
      }
    ],
    "totalCount": 0
  },
  "succeed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

...

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

Тип: POST

Запрос:

Наименование	Тип	Обязательность	Описание
userIds	Array of string	Да	Уникальный идентификаторы получателя

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

Code Block
{ "userIds": [ "string" ] }

Ответ:

Наименование	Тип	Обязательность	Описание
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

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

...

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

Тип: POST

Запрос:

Наименование	Тип	Обязательность	Описание
layoutsIds	Array of string	Да	Уникальный идентификаторы визито получателя

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

Code Block
{ "layoutIds": [ "string" ] }

Ответ:

Наименование	Тип	Обязательность	Описание
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

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

...

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

Тип: Delete

Запрос:

Наименование	Тип	Обязательность	Описание
userId	Array of string	Да	Уникальный идентификатор получателя

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

Code Block
{ "userIds": [ "string" ] }

Ответ:

Наименование	Тип	Обязательность	Описание
succeed	String	Да	Стату запроса
errors	Array of string	Да	Возвращатеся список ошибок, относящихся целиком к запросу
validationErrors	Array of string	Да	Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса

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

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

...

Version	Old Version 9	New Version 10
Changes made by	Anton Sukhorukov	Anton Sukhorukov
Saved on	Aug 18, 2023	Oct 09, 2023

Versions Compared

Key