Skip to main content

Добавить нового сотрудника

POST 
/v5/orgs/:org_guid/employees

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

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

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

Номер телефона сотрудника и его логин должны быть уникальными в рамках одной организации (включая сотрудников, котрые были отправлены в архив)

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: e9b3f41d-88f2-4692-9216-0213162d3404
    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

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

Body

Данные нового сотрудника

    name stringrequired

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

    Фамилия, Имя, Отчество

    role

    object

    required

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

    типа

    guid uuid

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

    type_of stringnullable

    Тип объекта

    phone stringrequired

    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})?

    Телефон

    username stringrequired

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

    Логин для создаваемого аккаунта (его часть до "@")

    inn stringnullable

    ИНН

    pin_code_hash stringnullable

    Хэш пин-кода

    email emailnullable

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

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

    meta stringnullable

    Possible values: <= 128 characters

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

    meta_data

    object

    nullable

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

    property name* string
    guid uuid

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

Responses​

Created

Schema

    name stringrequired

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

    Фамилия, Имя, Отчество

    role

    object

    required

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

    типа

    guid uuid

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

    type_of stringnullable

    Тип объекта

    phone stringrequired

    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})?

    Телефон

    username stringrequired

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

    Логин для создаваемого аккаунта (его часть до "@")

    inn stringnullable

    ИНН

    pin_code_hash stringnullable

    Хэш пин-кода

    organization

    object

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

    типа

    guid uuid

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

    type_of stringnullable

    Тип объекта

    email emailnullable

    Possible values: >= 6 characters and <= 64 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...