...

• external_id = Id externo ( si no lo tenía hay que incluirlo en una operación add)
  
• username = Nombre de usuario (String, opcional)
• firstName = Nombre  (String, opcional)
• lastName = Apellidos (String, opcional)
• preferredLanguage = Idioma predeterminado (String, opcional)
  
  • Valores permitidos = los idiomas de la plataforma:
    • en = Inglés, es = Español, pt = Portugués, it = Italiano, gl = Gallego,...
• personTimezoneId = Zona horaria (String, opcional)
  
  • Valor por defecto :
    • El correspondiente al campo "PlatformTimezone" en la tabla "configurationSettings", el valor actual es "Europe/Paris"
    • Si este no existe, se usa el valor definido en la variable de configuración "configuration.settings.default.timezone", el valor actual es "Etc/GMT"
  • Valores permitidos: 
    • Etc/GMT+12, Etc/GMT+11, Pacific/Honolulu, America/Anchorage, America/Tijuana, America/Los_Angeles, America/Phoenix, America/Chihuahua, America/Denver, America/Guatemala, America/Chicago, America/Mexico_City, America/Regina, America/Bogota, America/New_York, America/Indianapolis, America/Caracas, America/Asuncion, America/Halifax, America/Cuiaba, America/La_Paz, America/Santiago, America/St_Johns, America/Sao_Paulo, America/Buenos_Aires, America/Cayenne, America/Godthab, America/Montevideo, Etc/GMT+2, Etc/GMT+2, Atlantic/Azores, Atlantic/Cape_Verde, Africa/Casablanca, Etc/GMT, Europe/London, Atlantic/Reykjavik, Europe/Berlin, Europe/Budapest, Europe/Paris, Europe/Warsaw, Africa/Lagos, Africa/Windhoek, Asia/Amman, Europe/Istanbul, Asia/Beirut, Africa/Cairo, Asia/Damascus, Africa/Johannesburg, Europe/Kiev, Asia/Jerusalem, Europe/Minsk, Asia/Baghdad, Asia/Riyadh, Africa/Nairobi, Asia/Tehran, Europe/Moscow, Asia/Dubai, Asia/Baku, Indian/Mauritius, Asia/Tbilisi, Asia/Yerevan, Asia/Kabul, Asia/Karachi, Asia/Tashkent, Asia/Calcutta, Asia/Colombo, Asia/Katmandu, Asia/Yekaterinburg, Asia/Almaty, Asia/Dhaka, Asia/Rangoon, Asia/Novosibirsk, Asia/Bangkok, Asia/Krasnoyarsk, Asia/Shanghai, Asia/Singapore, Australia/Perth, Asia/Taipei, Asia/Ulaanbaatar, Asia/Irkutsk, Asia/Tokyo, Asia/Seoul, Australia/Adelaide, Australia/Darwin, Asia/Yakutsk, Australia/Brisbane, Australia/Sydney, Pacific/Port_Moresby, Australia/Hobart, Asia/Vladivostok, Pacific/Guadalcanal, Asia/Magadan, Pacific/Auckland, Etc/GMT-12, Pacific/Fiji, Asia/Kamchatka, Pacific/Tongatapu, Pacific/Apia
• roles = Roles del usuario (Lista de Strings, opcional)
  
  • Valores permitidos:
    • SYSTEM_TRAINER
    • SYSTEM_ADMINISTRATOR
    • SYSTEM_ADMINISTRATOR_TRAINING
    • SYSTEM_TEAM_MANAGER
    • SYSTEM_STUDENT
    • SYSTEM_SUPPORT
• status = Estado (String, opcional)
  
  • Valores permitidos:
    
    • ACTIVE
    • INACTIVE
• email = Correo electrónico del usuario  (String, opcional)
• officePhoneNumber = Teléfono de oficina (String, opcional)
• mobilePhoneNumber = Teléfono móvil (String, opcional)
• address = Dirección (String, opcional)
• jobTitle = Puesto (String, opcional)
• location = Departamento (String, opcional)
• organization = Compañía (String, opcional)
• aboutMe = Sobre mí (String, opcional)
• interests = Intereses (String, opcional)
• extendedField[nombre del campo extendido] (lista) = Nombre y valor de los campos extensibles (clave-valor de Strings, opcional*)
  * Solo son obligatorios aquellos campos extensibles que estén marcados como obligatorios y no tengan definido ningún valor por defecto
  
  • Valores permitidos:
    
    • Si el campo extendido es de tipo texto --> cualquier texto
    • Si el campo extendido es de tipo entero --> sólo números
    • Si el campo extendido es de tipo si/no --> valores "true" o "false"
    • Si el campo extendido es de tipo lista de valores --> un valor de la lista
• teamManagerUsername = Nombre de usuario de un jefe de equipo (String, opcional)

...

• No existe el usuario --> Error 404 (Not Found)
• Error inesperado --> Error 500 (Internal Server Error)
• Todo OK --> 200 (OK) + JSON

Obtener

...

Método: GET

URL: 

• Obtener resumen de notificaciones de usuario: 
  
  • /admin/rest/administration/api/users/id/{id}/notifications/summary
  • /admin/rest/administration/api/users/externalid/{external_id}/notifications/summary
  • /admin/rest/administration/api/users/username/{username}/notifications/summary

Ejemplo:

• https://demo.central-lms.com/admin/rest/administration/api/users/username/admin/notifications/summary
• https://demo.central-lms.com/admin/rest/administration/api/users/id/1/notifications/summary

Campos devueltos en el Json

• total = Número total de notificaciones del usuario
• unread = Número de notificaciones no leídas por el usuario

Validaciones

• No existe el usuario --> Error 404 (Not Found)
• Error en la generación del Json --> Error 503 (Service Unavailable)
• Todo OK --> 200 (OK) + JSON

Obtener los roles del usuario

Método: GET

...

• https://demo.central-lms.com/admin/rest/administration/api/users/id/1/roles
• https://demo.central-lms.com/admin/rest/administration/api/users/externalid/extuser1/roles
• https://demo.central-lms.com/admin/rest/administration/api/users/username/admin/roles

Campos devueltos en el Json

• SYSTEM_SUPPORT = True/False. Indica si el usuario tiene rol soporte.
• SYSTEM_ADMINISTRATOR = True/False. Indica si el usuario tiene rol administrador.
• SYSTEM_TRAINER = True/False. Indica si el usuario tiene rol formador o jefe de equipo.
• SYSTEM_STUDENT = True/False.Indica si el usuario tiene rol alumno.
• SYSTEM_ADMINISTRATOR_TRAINING = True/False. Indica si el usuario tiene rol administrador de la formación.

Validaciones

• No existe el usuario --> Error 404 (Not Found)
• No se le pasó el parámetro obligatorio /id/externalid/username --> Error 400
• Error inesperado --> Error 500 (Internal Server Error)
• Todo OK --> 200 (OK) + JSON

...