ES
Español
English
Português
    Creación de Usuarios

    Detalles de la petición

    • URL Base: {host}/ASMSAPI/
    • Uri: /api/v9/user
    • Tipo: POST

    • Encabezados requeridos:

      • content-type: application/json
      • X-Authorization: Bearer {token}

    Descripción de la URL

    • {host}: Representa el dominio del ambiente en el que se encuentra la API.
    • ASMSAPI/: Prefijo fijo de la API.
    • Uri: Endpoint específico para la petición.


    ⚐ EJEMPLO URL:

    https://{host}/ASMSAPI/api/v9/user


    Parámetros

    Nombre Tipo de dato Obligatorio Descripción
    active Número Si Indica si usuario está activo o no
    name Texto Si Nombre completo del usuario
    userName Texto Si  
    password Texto Si Contraseña
    projectId Número Si Identificador del proyecto
    stateId Número Si Identificador del estado
    listAdditionalField Lista Si Listado de campos adicionales
    consoleType Enumerador Si dentificador del tipo de consola - Specialist = 1, - Client = 2, - Administrator - 3
    registerType Enumerador Si Identificador del tipo de registro - Client = 37, - Specialist = 53,
    chiefId Número No Identificador del jefe inmediato
    address1 Texto No Dirección 1
    address2 Texto No Dirección 2
    address3 Texto No Dirección 3
    birthDate Número (Tiempo UNIX en milisegundos) No Fecha de nacimiento
    buildingId Número No Identificador del edificio
    cityId Número No Identificador de la ciudad
    companyId Número No Identificador de la sucursal
    countryId Número No Identificador del país
    departmentCode Número No Identificador del departamento
    departmentNumber Número No Identificador del n° de departamento
    documentNumber Número No Número de documento
    documentTypeId Número No Identificador del tipo de documento
    email Texto No Correo electrónico
    ext Texto No Número de extensión
    fax Texto No Número de Fax
    floorId Número No Identificador del piso
    guidLDAP Texto No  
    jobId Número No Identificador del cargo
    mobil Texto No Número de teléfono celular
    phone1 Texto No Número de teléfono 1
    phone2 Texto No Número de teléfono 2
    phone3 Texto No Número de teléfono 3
    siteId Número No Identificador de la sede
    chiefId Número No Identificador jefe inmediato

    Cuerpo de la petición

    {

      "active": 1,

      "birthDate": 315122400000,

      "name": "Usuario ASMS",

      "userName": "usuario.asms",

      "chiefId": 1,

      "consoleType": "Administrator",

      "registerType": "specialist",

      "projectId": 19,

      "stateId": 1,

      "email": "test@gmail.com",     
      
      "password": "Aranda123",

      "listAdditionalField": []

}

    Respuesta

    {

      "id": 4848,

      "result": true 
      
}

    Parámetros de respuesta

    Nombre Tipo de dato Descripción
    id Número Identificador del usuario
    result Boleano Resultado de la operación

    Mensajes de error

    Código Estado HTTP Mensaje de error
    500 InternalServerError FailureAddUser
    400 BadRequest InvalidConsole
    400 BadRequest InvalidRegisterType
    400 BadRequest InvalidStateId
    400 BadRequest InvalidProjectId
    400 BadRequest InvalidAdditionalFieldValue
    400 BadRequest AdditionalFieldIsRequired