Skip to main content

Получить список рабочих мест организации

GET 
/v5/orgs/:org_guid/workplaces

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

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

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

Поиск по списку производится по полям: "name" и "number".

Request​

Path Parameters

    org_guid uuidrequired

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

Query Parameters

    created_from date-time

    Создание объекта произошло позже чем указанные дата и время (включая эти дату и время)

    created_to date-time

    Создание объекта произошло раньше чем указанные дата и время

    updated_from date-time

    Последнее изменение объекта произошло позже чем указанные дата и время (включая эти дату и время)

    updated_to date-time

    Последнее изменение объекта произошло раньше чем указанные дата и время

    query string

    Possible values: non-empty and <= 64 characters

    Поиск производится по полям: number, name, meta, metadata

    order_by WorkplaceOrderings

    Possible values: [created_at_asc, created_at_desc, updated_at_asc, updated_at_desc, number_asc, number_desc, name_asc, name_desc, workplace_type_asc, workplace_type_desc, activated_at_asc, activated_at_desc]

    Вариант сортировки результатов запроса

    page_token string

    Токен (курсор, ссылка) запрашиваемой страницы результатов списка. Если он не задан, то возвращается первая страница результатов. Размер страницы списка регулируется сервером.

    selection SelectionModes

    Possible values: [alive_only, archived_only, all]

    Режим выборки объектов из списка

    presentation PresentationModes

    Possible values: [compact, full]

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

Header Parameters

    Accept-Language stringrequired

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

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

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

    Example: 5aad0cb1-b141-4ade-b7be-b2b0cf0bd70d
    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

    items

    object[]

    nullable

    Список лементов типа <typeparamref name="T" />

  • Array [

    • number int32nullable

    Possible values: >= 1 and <= 99999

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

    name stringnullable

    Possible values: <= 128 characters

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

    workplace_type WorkplaceTypes (string)required

    Possible values: [Unknown, Mobile, Stationary, Automat]

    Типы рабочих мест

    activated_at date-timenullable

    Дата активации.Заполняется сервером автоматически при активации рабочего места

    organization

    object

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

    типа

    guid uuid

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

    type_of stringnullable

    Тип объекта

    extensions

    WorkplaceExtensions

    Расширения

    nadex_soft_pos

    object

    Расширение для настройки SoftPOS от Nadex на рабочем месте

    turned_on boolean

    Включен

    virtual_serial_number stringrequired

    Possible values: >= 19 characters and <= 19 characters, Value must match regular expression ^[a-zA-Z0-9]*$

    Виртуальный серийный номер

    version stringrequired

    Possible values: non-empty and <= 8 characters

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

    lifepay_smart_pos

    object

    Расширение, в котором хранятся настройки для работы с платежным решением SmartPOS от LIFE PAY на рабочих местах для которых было задано это расширение.

    emv_config stringnullable

    Possible values: <= 10485760 characters

    Конфигурация EMV

    tms_params

    object

    Lifepay Smart Pos Tms Params

    ip stringrequired

    Possible values: <= 64 characters

    TMS Host Address

    port int32required

    Possible values: <= 99999

    Port

    ca1 stringrequired

    Possible values: <= 4096 characters

    CA1 Certificate

    ca2 stringrequired

    Possible values: <= 4096 characters

    CA2 Certificate

    version stringrequired

    Possible values: non-empty and <= 8 characters

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

    lifepos_quick_payments

    object

    qr_registrar_guid stringrequired
    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

    Тип объекта

  • ]

    • next_page_token stringnullable

    Токен следующей страницы результатов списка

    page_number int32

    Номер текущей страницы. Если нумерация страниц не поддерживается, принимает значение -1 либо отсутствует. В остальных случаях принимает значения от 1 до total_pages включительно.

    pages_total int32

    общее кол-во страниц (>= 0)

    items_per_page int32

    кол-во элементов на странице (постоянное значение с сервера)

    items_total int32

    общее кол-во элементов списка

    type_of stringnullable

    Тип объекта

Loading...