API: Пользователи - MCODEDOTSU/panorama.back GitHub Wiki

API: Пользователи

Для всех запросов, не отмеченных как NOAUTH, необходимо добавить в заголовок Authorization:

"Bearer {TOKEN}"

TOKEN получается на этапе аутентификации в системе

Получить список всех пользователей контрагента

METHOD: GET

NAME: api/user/CONTRACTOR_ID

RESPONSES:

[
    {
        id: integer,
        name: string,
        email: string,
        email_verified_at: datetime | null,
        contractor_id: integer,
        created_at: datetime | null,
        updated_at: datetime | null,
        role: string,
        post: string | null,
        photo: string | null,
        person_id: integer | null
    },
]

Создать пользователя

METHOD: POST

NAME: api/user

QUERY PARAMETERS:

  • email * [Адрес электронной почты]
  • post [Должность]
  • photo [Пусть к изображению]
  • role * [Роль]
  • password * [Пароль]
  • contractor_id * [ИД контрагента]
  • person_id [ИД физического лица]

RESPONSES:

{
    name: string,
    email: string,
    post: string | null,
    photo: string | null,
    contractor_id: integer,
    updated_at: datetime | null,
    created_at: datetime | null,
    id: integer
}

Изменить пользователя

METHOD: PUT

NAME: api/user

QUERY PARAMETERS:

  • id * [ИД пользователя]
  • email * [Адрес электронной почты]
  • post [Должность]
  • photo [Пусть к изображению]
  • role * [Роль]
  • password [Пароль]
  • person_id [ИД физического лица]

RESPONSES:

{
    name: string,
    email: string,
    post: string | null,
    photo: string | null,
    contractor_id: integer,
    updated_at: datetime | null,
    created_at: datetime | null,
    id: integer
}

Удалить пользователя

METHOD: DELETE

NAME: api/user/ID

RESPONSES:

{
    id: integer
}

Загрузить фото пользователя

METHOD: POST

NAME: api/user/upload

QUERY PARAMETERS:

  • file * [Файл] FormData

RESPONSES:

{
    filename: string,
}