Content Comparison

Получение списка заведений

...

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

Тип: GET

Запрос:

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

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

Ответ:

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

{
  "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,
        "headPlacecompany": {
          "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"
    ]
  }
}

...

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

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

Тип: GET

Запрос:

-

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

-

Ответ:

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

{
  "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",
    "isHeadplaceCode": true"string",
    "placeCodeplaceAdministrators": "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
    },
    "childPlacescompany": [
      {
 
      "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"externalInfo": {
    "id": "string"
  },
  "placeType": 0,
  "managerId": "string",
  "placeAdministratorIds": [
    "string"
  ],
  "employeesPage": {
    "routeId": "string",
    "backgroundUrl": "string"
  },
  "childPlaceIdscompanyId": [
    "string"
  ],
  "isHead": true,
  "webSite": "string",
  "comment": "string",
  "addressInfo": {
    "country": "string",
    "city": "string",
    "address": "string",
    "latitude": 0,
    "longitude": 0
  }
}

Ответ:

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

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

Включение страницы со списком всех сотрудников заведения

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

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

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

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

Загрузка изображения

Описание: Позволяет загружать изображения в систему

Тип: POST

Запрос:

...

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

...

Тип

...

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

...

Описание

...

file

...

String

...

Да

...

Файл с картинкой

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

-

Ответ:

...

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

...

Тип

...

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

...

Описание

...

imageId

...

String

...

Да

...

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

...

url

...

String

...

Да

...

Ссылка на изображение

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

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

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

...

Возможные ошибки

{
  "succeed": false,
  "errors": [],
  "validationErrors": {
    "Name": [
      "Необходимо указать название заведения"
    ]
  }
}

{
  "succeed": false,
  "errors": ["Заведение с названием "{имя заведения из запроса}" уже существует"],
  "validationErrors": {}
}

Создание управляющего заведения

Описание: создание управляющего для заведения

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

Тип: PATCHPOST

Запрос:

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

...

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

{
  "email": "user@example.com",
  "phoneNumber": "string",
  "name": "string",
  "managerId": "string",
  "placeIds": [
},    "string"
{  ],
      "oppermissions": "replace",
        "path": "/PlaceType",
   1
}

Ответ:

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

{
  "succeed": true,
  "statusCode": 0,
  "errors": [
    "valuestring":
"integer"  ],
  },
"validationErrors": {
   { "additionalProp1": [
      "opstring":
"replace",    ],
    "pathadditionalProp2": "/WebSite",
 [
      "value": "string"
    }],
    {"additionalProp3": [
       "opstring":
 "replace",   ]
  },
  "pathdata": "/EmployeesPage",{
        "value":
        {
            "Disabled"id": "bool",
            "RouteId": "string",
            "BackgroundId": "}
}

Включение страницы со списком всех сотрудников заведения

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

1. Сделать запрос GET /wiki/spaces/TIPS/pages/1787396098, передав уникальный идентификатор заведения

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

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

Загрузка изображения

Описание: Позволяет загружать изображения в систему

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

Тип: POST

Запрос:

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

-

Ответ:

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

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

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

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

Адрес: /wiki/spaces/TIPS/pages/1787396098, где placeId - уникальный идентификатор заведения

Тип: PATCH

Запрос:

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

[
    {
        "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": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

...

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

Тип: PUTPATCH

Запрос:

False,
True

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

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

Ответ:

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

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

...

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

Тип: GET

Запрос:

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

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

Ответ:

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

...

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

{
  "data": {
    "totalCount": 0,
    "items": [
      {
        "id": "string",
        "datatitle": { "string",
        "totalCountimageId": 0"string",
        "itemsimageUrl": "string"
 [     }
 {   ]
  },
  "idsucceed": true,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "titleadditionalProp1": "string",[
        "imageIdstring":
"string",    ],
    "imageUrladditionalProp2": "string"[
      }"string"
    ],
  },   "succeedadditionalProp3": true, [
      "errorsstring":
 [   ]
 "string" }
 ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
    "additionalProp2": [
      "string"
    ],
    "additionalProp3": [
      "string"
    ]
  }
}

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

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

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

Тип: DELETE

Запрос:

-

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

-

Ответ:

...

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

...

Тип

...

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

...

}

Получение списка сотрудников заведения

Описание: получить список получателей по заведению

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

Тип: GET

Запрос:

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

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

Ответ:

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

...

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

{
  "data": {
    "additionalProp3items": [
      "string"{
    ]   } }

Получение списка сотрудников заведения

Описание: получить список получателей по заведению

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

Тип: GET

Запрос:

...

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

...

Тип

...

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

...

Описание

...

placeId

...

String

...

Да

...

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

...

page

...

Integer

...

Нет

...

Пагинация

...

limit

...

Integer

...

Нет

...

Ограничение на количество записей

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

{
  "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

...

Да

...

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

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

{
  "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"
{    ],
    "userId": "string",
        "name": "string",
        "phoneNumber": "string",
        "layoutIds": [
          "string"
        ],
        "attachedDate": "2021-06-01T11:42:46.902Z"
      }
    ],
    "totalCount": 0
  },additionalProp3": [
      "string"
    ]
  }
}

Привязка получателя к заведению

Пользователь должен быть в двух заведениях

Чтобы привязать получателя из своего скоупа и при этом он осталс в старом заведении.

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

Тип: POST

Запрос:

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

{
  "userIds": [
    "string"
  ]
}

Ответ:

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

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

Привязка получателя к заведению

Пользователь должен быть только в

...

новом заведении

Чтобы привязать перенести получателя из своего скоупа и при этом он осталс в старом заведении.в новое заведение

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

Тип: POST

Запрос:

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

{
  "userIdslayoutIds": [
    "string"
  ]
}

Ответ:

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

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

Пользователь должен быть только в новом заведении

...

Отвязка получателя

Описание:Позволяет отвязать получателя от заведения

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

Тип: POSTDelete

Запрос:

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

{
  "layoutIdsuserIds": [
    "string"
  ]
}

Ответ:

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

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

...

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

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

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

Тип: DeletePOST

Запрос:

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

{
  "userIds": ["placeId": "string",
  "maxRegistrationCount" : "integer",
  "lifetime" : "stringinteger"
  ]
}

Ответ:

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

{
  "succeed": true,
  "statusCode": 0,
  "errors": [
    "string"
  ],
  "validationErrors": {
    "additionalProp1": [
      "string"
    ],
  },
  "additionalProp2data": [{
    "url":  "string"
    ],
    "additionalProp3lifeTime": [
      "string"
    ]"integer"
  }
}