Skip to main content

POST - Создание нового пользователя

Описание​

Метод POST /users позволяет создать нового пользователя в системе.

Запрос​

Пример тела запроса:​

{
  "firstName": "John",
  "middleName": "Lee",
  "lastName": "Fox",
  "employeeNo": "1234",
  "employeePin": "4321",
  "email": "[email protected]",
  "phone": "80291110099",
  "language": "ru",
  "role": "ADMIN",
  "locationIds": [
    "99b770c0-2396-43d3-b109-85a9d73df7b1",
    "e1dfeaba-4318-4411-be91-f8af5214dd02"
  ],
  "tags": [
    "tag1",
    "tag2"
  ]
}

Примечания:​

  • Роль: Это обязательное поле.
  • Тип контента: Данные запроса должны быть отправлены в формате application/json.
  • Формат UUID: Все ID (например, locationIds) должны быть в формате UUID.

Пример успешного ответа​

Тело ответа:​

{
  "id": "be63c536-6cf3-4866-8970-37a956e3f403",
  "firstName": "John",
  "middleName": "Lee",
  "lastName": "Fox",
  "employeeNo": "1234",
  "employeePin": "4321",
  "email": "[email protected]",
  "phone": "80291110099",
  "language": "ru",
  "role": "ADMIN",
  "status": "ACTIVE",
  "photoId": null,
  "locationIds": [
    "99b770c0-2396-43d3-b109-85a9d73df7b1",
    "e1dfeaba-4318-4411-be91-f8af5214dd02"
  ],
  "tags": [
    "tag1",
    "tag2"
  ],
  "userLinked": true
}

Примеры ошибок​

Ошибка валидации​

Возникает, когда отсутствуют обязательные поля или данные имеют неверный формат.

Пример ответа:​

{
  "message": "validation failed",
  "code": "validation.failed",
  "timestamp": "2023-03-07T05:57:59.315Z",
  "details": [
    {
      "message": "must not be null",
      "code": "validation.notnull.failed",
      "identifier": "role"
    }
  ]
}

Несоответствие типа контента​

Возникает, когда формат данных запроса не поддерживается.

Пример ответа:​

{
  "message": "mismatch in the types of content",
  "code": "not.acceptable",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Внутренняя ошибка сервера​

Возникает при неожиданной ошибке на сервере.

Пример ответа:​

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Резюме​

Метод POST /users позволяет создать нового пользователя, предоставив необходимые данные в теле запроса. Обязательные поля, такие как role, должны быть включены, а ID должны соответствовать формату UUID. Ошибки могут возникать из-за ошибок валидации, неподдерживаемых типов контента или проблем на сервере. Правильная обработка этих ошибок обеспечит надежную интеграцию с API.