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: 5d4c985b-6a2f-4189-88b2-5595e6f8c201
    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

  • 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

    guid uuid
    type_of stringnullable

    extensions

    WorkplaceExtensions

    Расширения

    nadex_soft_pos

    object

    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

    emv_config stringnullable

    Possible values: <= 10485760 characters

    tms_params

    object

    ip stringrequired

    Possible values: <= 64 characters

    port int32required

    Possible values: <= 99999

    ca1 stringrequired

    Possible values: <= 4096 characters

    ca2 stringrequired

    Possible values: <= 4096 characters

    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
    pages_total int32
    items_per_page int32
    items_total int32
    type_of stringnullable
Loading...