User/Add
Descripción
Agrega un nuevo usuario con la información proporcionada
Request
Request Body
| Campos | Largo | Requerido | Tipo de dato | Descripción |
|---|---|---|---|---|
| Identifier | 16 | Sí | String | Identificador único del usuario |
| 200 | Sí | String | Correo electrónico del usuario | |
| Name | 256 | Sí | String | Nombre del usuario |
| Lastname | 100 | Sí | String | Apellido del usuario |
| TimeZone | 30 | No | String | Indica el identificador cifrado de la zona horaria del usuario |
| Address | 100 | No | String | Indica la dirección del usuario |
| Phone | 15 | No | String | Indica el número telefónico del usuario |
| CostCenterCode | 200 | No | String | Indica el código de centro de costos del grupo al que va a pertenecer el usuaro. |
| CustomColumn1 | 100 | No | String | Indica el contenido de la columna personalizada 1 |
| CustomColumn2 | 100 | No | String | Indica el contenido de la columna personalizada 2 |
| CustomColumn3 | 100 | No | String | Indica el contenido de la columna personalizada 3 |
| ContractDate | 14 | No | String | Indica la fecha de inicio de contrato del usuario en formato YYYYMMDDHHMMSS |
| EndContractDate | 14 | No | String> | Indica la fecha de fin de contrato del usuario en formato YYYYMMDDHHMMSS |
| ProfileId | 30 | No | String | Indica el identificador cifrado del perfil que posee el usuario |
| UserScheduler | 30 | No | String | Indica el identificador cifrado de la planificación que posee el usuario |
| StartSchedulerDate | 14 | No | String | Indica la fecha de inicio del planificador del usuario en formato YYYYMMDDHHMMSS |
| UserCompanyIdentifier | 30 | No | String | Indica la razón social cifrada externa del usuario. Permite asociar al usuario a una razón social. |
| WeeklyWorkingHoursCodeId | 30 | No | String | Indica el identificador cifrado del código de jornada del usuario |
| WeeklyWorkingHoursCodeDescription | 50 | No | String | Indica el nombre del código de jornada del usuario |
| PositionId | 30 | No | String | Indica identificador cifrado del cargo que posee el usuario |
| UserCard | 30 | No | String | Indica número de la tarjeta del usuario |
| LegalSundayIndicator | 1 | No | String | Indica si es que al usuario se le aplican los domingos legales. Si tiene un 1 se le aplican y si tiene 0 no se le aplica. |
| PIS | 12 | No | String | Indica el número de programa de integración social del usuario |
| IsHiddenForReports | 1 | No | String | Indica si el usuario esta oculto en los reportes. Si tiene un 1 está oculto y si es 0 no lo está. |
Importante
- Se pueden ver los cambios en Usuarios > Listado de usuarios.
- Para crear un usuario es necesario ingresar el campo «Identifier» o «Email», además del campo «Name» y «Lastname».
- El formato de fecha YYYYMMDDHHMMSS se descompone en:
YYYY: Año, por ejemplo: 1987
MM: Mes, por ejemplo: 01
DD: Día, por ejemplo: 13
HH: Hora, por ejemplo: 18
MM: Minuto, por ejemplo: 32
SS: Segundo, por ejemplo 54
En resumen: 19870113183254 - El usuario queda con estado «Activo» por defecto.
- La cantidad de usuarios de la empresa no debe superar el límite permitido (definido por empresa) para crear al usuario.
- No puede crear un usuario si ya existe en la empresa.
{
"Identifier": "String",
"Email": "String",
"Name": "String",
"LastName": "String",
"TimeZone": "String",
"Address": "String",
"Phone": "String",
"CostCenterCode": "String",
"CustomColumn1": "String",
"CustomColumn2": "String",
"CustomColumn3": "String",
"ContractDate": "String",
"EndContractDate": "String",
"ProfileId": "String",
"SchedulerId": "String",
"StartSchedulerDate": "String",
"UserCompanyIdentifier": "String",
"WeeklyWorkingHoursCodeId": "String",
"WeeklyWorkingHoursCodeDescription": "String",
"PositionId": "String",
"UserCard": "String",
"LegalSundayIndicator": "String",
"PIS": "String",
"IsHiddenForReports": "String"
}Response
Response Body
| Campos | Tipo de dato | Descripción |
|---|---|---|
| Success | Booleano | Indica el estado resultante de la operación |
| Response | Objeto | Indica campos asociados a la respuesta |
| UserId | String | Indica el identificador cifrado del usuario editado |
Importante
- En Response se devuelve un objeto que incluye el campo UserId.
Códigos
| Código | Descripción |
|---|---|
| 200 | Éxito |
| 400 | Error en el request |
| 500 | Error no controlado, contactar a GV |
{
"Success": boolean,
"Message": "string",
"Response": {
"UserId": "string"
}
}Postman
Ejemplo 1
Ejemplo 1
