Skip to main content

Получить данные организации

GET 
/v5/orgs/:org_guid

Коды возможных ошибок:​

[500]: "InternalServerError" - внутренняя ошибка сервера [429]: "TooManyRequests" - превышено ограничение на количество запросов в секунду [401]: "Unauthorized" - для выполнения операции требуется авторизация [403]: "NoPermissions" - нет прав на выполнение этой операции [404]: "NotFound" - запрашиваемый объект не найден [422]: "RequestIsNotValid" - параметры запроса не прошли валидацию

Важная информация!​

Если указанный объект удален (помещен в архив) данный метод всё равно вернет данные по нему.

Request​

Path Parameters

    org_guid uuidrequired

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

Query Parameters

    presentation PresentationModes

    Possible values: [compact, full]

    Режим представления результатов запроса

Header Parameters

    Accept-Language stringrequired

    Язык используемый для ответов

    Example: ru-RU
    X-LP-Client-Identifier stringrequired

    Идентификатор клиента

    Example: 37f4b0de-836d-4840-a8e6-4e5b5144750b
    X-LP-Client-Type stringrequired

    Possible values: [Unknown, App, WebApp, Service]

    Тип клиента

    Example: App
    X-LP-Client-Name string

    Имя клиента

    Example: Swagger
    X-LP-Client-OS-Name string

    ОС клиента

    Example: SwaggerDoc
    X-LP-Client-OS-Version string

    Версия ОС клиента

    Example: 1.0
    X-LP-Client-Screen-Resolution string

    Разрешение экрана ОС клиента

    Example: 1280x0900
    X-LP-Client-Model string

    Модель оборудования клиента

    Example: Chrome 75
    X-LP-Organization-Alias string

    Организация по умолчанию

    X-LP-Client-Extensions csv

    Поддерживаемые клиентом расширения моделей

Responses​

Success

Schema

    name stringrequired

    Possible values: >= 2 characters and <= 24 characters

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

    alias stringrequired

    Possible values: >= 2 characters and <= 24 characters, Value must match regular expression ^[a-zA-Z0-9_-]{2,24}$

    Псевдоним

    owner

    object

    Ссылка на объект типа <typeparamref name="T" />. По совместительству базовый класс для всех объектов ссылочного

    типа

    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

    support

    object

    Контакты технической поддержки

    line stringrequired

    Possible values: >= 2 characters and <= 24 characters

    Линия технической поддержки

    responsibility stringrequired

    Possible values: >= 2 characters and <= 128 characters

    Зона ответственности

    phone stringnullable

    Possible values: >= 10 characters and <= 18 characters, Value must match regular expression ((8|\+7)-?)?\(?\d{3,5}\)?-?\d{1}-?\d{1}-?\d{1}-?\d{1}-?\d{1}((-?\d{1})?-?\d{1})?

    Телефон

    email stringnullable

    Possible values: >= 6 characters and <= 64 characters, Value must match regular expression ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

    Электронная почта

    opening_hours stringnullable

    Possible values: >= 2 characters and <= 128 characters

    Часы работы

    whatsapp stringnullable

    Possible values: >= 2 characters and <= 64 characters

    WhatsApp

    viber stringnullable

    Possible values: >= 2 characters and <= 64 characters

    Viber

    telegram stringnullable

    Possible values: >= 2 characters and <= 64 characters

    Telegram

    type_of stringnullable

    Тип объекта

    extensions

    OrganizationExtensions

    Расширения

    notification_service

    object

    Расширение Сервиса нотификаций LIFE POS для организации

    turned_on booleanrequired

    Включен

    primary_url_for_notifications urirequired

    Основной URL для отправки уведомлений

    secondary_url_for_notifications urinullable

    Резервный URL для отправки уведомлений

    version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    lifepay_auth

    object

    Расширение для быстрой аутентификации в сервисах LIFE PAY для организации.

    signature stringrequired

    Possible values: >= 8 characters and <= 128 characters

    Подпись

    version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    unified_personal_account

    object

    Расширение для настройки версии личного кабинета. На этапе MVP добавляется

    всем существующим организациям с turned_on = false. При регистрации организации

    с любой формы регистрации (старой и новой) расширение добавляется с аналогичным

    значением. Управление расширением доступно только для Internal User

    turned_on boolean

    Флаг использования единого личного кабинета. На этапе MVP по умолчанию проставляется в false для существующих и регистрирующихся организаций. Управление флагом доступно только для Internal User

    version stringrequired

    Possible values: non-empty and <= 8 characters

    Версия расширения

    created_at date-time

    Дата создания

    updated_at date-time

    Дата последнего обновления

    deleted_at date-timenullable

    Дата удаления (архивации)

    meta stringnullable

    Possible values: <= 128 characters

    Метаданные объекта (нарпимер, идентификатор в сторонней системе)

    meta_data

    object

    nullable

    Метаданные объекта в формате ключ-значение

    property name* string
    guid uuid

    Глобальный уникальный идентификатор объекта

    type_of stringnullable

    Тип объекта

Loading...