...
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" ] } } |
Возможные ошибки
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Получение информации по заведению
Описание: Получить информацию по одному заведению
Адрес: https://api.cloudtips.ru/api/places/{id}
Тип: GET
Запрос:
-
Пример запроса:
-
Ответ:
...
Наименование
...
Тип
...
Обязательность
...
Описание
...
id
...
String
...
Да
...
Уникальный идентификатор заведения
...
externalPlaceId
...
String
...
Да
...
Внешний идентификатор заведения
...
createdDate
...
String
...
Да
...
Дата создания
...
updatedDate
...
String
...
Да
...
Дата обновления
...
name
...
String
...
Да
...
Поиск по названию
...
placeType
...
Integer
...
Да
Тип завдениея, значения:
Получение информации по заведению
Описание: Получить информацию по одному заведению
Адрес: https://api.cloudtips.ru/api/places/{id}
Тип: GET
Запрос:
-
Пример запроса:
-
Ответ:
Наименование | Тип | Обязательность | Описание |
---|---|---|---|
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 | Да | Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса |
...
Наименование | Тип | Обязательность | Описание |
---|---|---|---|
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 | Нет | Долгота |
Пример запроса:
...
Улица | |||
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": { "externalPlaceIdcountry": "string", "placeTypecity": 0"string", "managerIdaddress": "string", "placeAdministratorIdslatitude": [0, "stringlongitude": 0 ], } "employeesPage": { "routeId": "string",} |
Ответ:
Наименование | Тип | Обязательность | Описание |
---|---|---|---|
id | String | Да | Уникальный идентификатор заведения |
succeed | String | Да | Стату запроса |
errors | Array of string | Да | Возвращатеся список ошибок, относящихся целиком к запросу |
validationErrors | Array of string | Да | Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса |
Пример ответа:
Code Block |
---|
{ "data": { "backgroundUrlid": "string" }, "childPlaceIdssucceed": [ "string" ], "isHead": true, "webSite": "string", "comment": "string", "addressInfo": { "country": "string", "city": "string", "errors": [ "address": "string", ], "latitudevalidationErrors": 0,{ "longitudeadditionalProp1": 0[ } } |
Ответ:
...
Наименование
...
Тип
...
Обязательность
...
Описание
...
id
...
String
...
Да
...
Уникальный идентификатор заведения
...
succeed
...
String
...
Да
...
Стату запроса
...
errors
...
Array of string
...
Да
...
Возвращатеся список ошибок, относящихся целиком к запросу
...
validationErrors
...
Array of string
...
Да
...
Поле представлено в формате ключ-значение и содержит ошибки, которые отнести к конкретному полю запроса
Пример ответа:
Code Block |
---|
{ "data": { "string" ], "additionalProp2": [ "string" ], "idadditionalProp3": [ "string" ] }, } } |
Возможные ошибки
Expand | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Создание управляющего заведения
...