Page Comparison

Panel

title	Estado

Status

colour	Green
title	En Uso

Info

title	En Uso

Cuando un requisito de sistema software tenga el estado En Uso significa que está disponible para su uso.

...

Este servicio será consultado por las aplicaciones que necesiten sincronizar o actualizar datos del Staff con la BDC con cierta periodicidadMIM.

Situación actual

Nombre
Apellido paterno
Apellido materno
Ejemplo de llamada o de formulario

Descripción

Consulta o actualiza un Staff por su id

Referencia BDC

Persona

Referencia SIF

UNOStaff (Lista).

Tipo de Petición

GET para consultar, PUT para actualizar y POST para insertar.

Parámetros o Campos

Campos	Descripción	Reglas de negocio
UUID del Staff que se consulta	Es obligatorio el Id del Staff cuando se consulta o actualiza. No se indica en caso de insertar o actualizar varios staffs.	El identificador del staff debe existir, en caso de no ser válido o con borrado lógico devuelve: <code>404</code> <message>No se encontraron datos con los parámetros especificados.</message> La actualización (PUT) de los datos del staff solo es permitida para los usuarios de colegios SIS, usuarios de colegios de la Empresa Moderna Compartilha o cuando aún no han sido vinculados a algún colegio. En caso de no cumplirse la regla el servicio devuelve: <code>401</code> <message>No está autorizado para ejecutar esta acción.</message> En caso que el usuario que invoca el servicio (generatorId) no tenga permisos en la empresa donde esta relacionado el personal, devuelve: <code>403</code> <message>No tiene permiso para insertar o modificar en la empresa a la que pertenece el staff.</message>

Parámetros en XML payload

Valida payload para PUT y POST. En caso de no ser correcto manda mensaje de error.
- <code>400</code>
  <message>El xml del payload no se encuentra bien formado.</message>

Campo

Descripción

Reglas de Negocio

unoStaff refId

Obligatorio para actualizar
Cuando se inserta va en blanco.

firstName

middleName

lastName

birthDate

Fecha de nacimiento
Formato: aaaa-mm-dd
Obligatorio

En caso de no indicar valor con el formato correcto entrega el siguiente mensaje:
<code>400</code>
<message>El formato de la fecha es incorrecto.</message>

sex

Valores: Male, Female, Not selected

userId

Username
En caso de indicarlo, debe tener 6 o más caracteres.

Antes de insertar, valida que no exista otro usuario con el mismo username, entregando mensaje:
<creates>
<create id="" statusCode="409" >
<error id="00000000-0000-1000-0000-001682490178" >
<code>409</code>
<message>Ya existe una persona con el login proporcionado.</message>
</error>
</create>
</creates>
Si el usuario previamente tiene login y no se indica valor entonces entrega mensaje:
<code>409</code>
<message>Ocurrió un error al guardar la información de login.</message>
En caso de ser indicado y tener menos de 6 caracteres entrega el siguiente mensaje:
<code>400</code>
<message>El userId no es válido. Debe tener 6 o más caracteres.</message>
Los campos userId y password deben tener valor para que sea creado el login.

password

Contraseña

En caso de tener valor el campo userId, debe indicar password para que sea creado el login.
El valor debe ser enviado codificado en base64

language

Idioma
Valores: ver maestro de Catálogos_generales_BDC

zona_horaria_id

Identificador único en la BDC zona_horaria.zona_horaria_id
Obligatorio
Valores: ver maestro de zona_horaria.

personRefId

Identificador único en la BDC persona.persona_id

curp

Curp

addressType

Tipo domicilio
Valores: Physical, Mailing, Shipping

line1

Calle

city

Ciudad

neighborhood

Colonia

postalCode

Código postal

buildingSiteNumber

Número

county

Municipio
Valores: ver maestro de municipios.

stateProvince

Estado

countyRefId

Identificador único en la BDC municipio.municipio_id
Obligatorio
Valores: ver maestro de municipios.

phoneNumberType

Tipo
Valores: Home, Mobile

number

Teléfono

email

Correo electrónico

personRoleId

UUID del Staff que se consulta Persona Rol Id del usuario que realiza el cambio.
Opcional

Si el cambio en una entidad se realizó en alguna herramienta administrativa (Acuerdo, Censo, SINCROBDC, etc), el valor almacenado corresponde al usuario con rol administrativo que realizó el cambio (Administrador, Staff, Administrador de Colegio)

En caso de consultar o actualizar un solo identificador:

https://homol.uno-internacional.com/sif/unoStaffunoStaffExt/00000000-0000-1000-0000-000001363444

En caso de insertar solo un staff o actualizar varios:

https://homol.uno-internacional.com/sif/unoStaff

Respuesta o XML PayloadSe agrega la etiqueta "<unoStaffList>" cuando se actualizan varios: (cómo máximo permitimos como buena práctica que se añadan máximo 15 entidades)

Code Block

language	xml

<unoStaffList>
<unoStaff<unoStaffExt refIdpersonRefId="00000000-0000-1000-0000-000001363444">
    <name>
        <firstName>Staff<<firstName>Bricho</firstName>
        <middleName>Prueba<<middleName>Velazquez</middleName>
        <lastName>Sif<<lastName>Hernandez</lastName>
   
</name>
    <birthDate>2014-06<birthDate>1987-10-06</birthDate>
    <sex>Male</sex>
    <userId>new.staff.1</userId>
    <password>bmV3LnN0YWZmLjE=</password>
    <userId>Bricio.21</userId>
<language>ES</language>
	<zona_horaria_id>16</zona_horaria_id>
    <curp></curp>
    <addressList>
        <hash>*6405F8C201A9DA85CE3D31168CA4221DE605D9FA</hash>
<schoolRefId></schoolRefId>
<addressList>
<address addressType="Physical">
  
         <street>
                <line1>CALLE 8 DE MAYO</line1>
            </street>
            <city>MEXICO</city>
            <neighborhood>PLANETARIO LINDAVISTA</neighborhood>
            <postalCode>07300</postalCode>
            <buildingSiteNumber>2</buildingSiteNumber>
            <county>GUSTAVO A MADERO</county>
            <stateProvince>Distrito Federal</stateProvince>
            <street>
<line1></line1>
</street>
<city></city>
<neighborhood></neighborhood>
<postalCode></postalCode>
<buildingSiteNumber>0</buildingSiteNumber>
<county>ZINACANTEPEC</county>
<stateProvince>Estado de México</stateProvince>
<countyRefId>00000000-0000-1000-0000-000000011302<000000011240</countyRefId>
  
     </address>
    </addressList>
    <phoneNumberList>
        <phoneNumber phoneNumberType="Home">
            <number>53956782</number>
        </phoneNumber>
        <phoneNumber phoneNumberType="Mobile">
            <number>5537651829</number>
        </phoneNumber>
    </phoneNumberList>
    <schoolEmailList>
        <schoolEmail>
            <email>new.staff.1@correo.com</email>
        </schoolEmail>
    </schoolEmailList>
	<personRoleId>00000000-0000-1000-0000-000000526589</personRoleId>
</unoStaff>
</unoStaffList><phoneNumberList></phoneNumberList>
<schoolEmailList></schoolEmailList>
</unoStaffExt>

¿Quién lo utiliza y cómo?

...

Version	Old Version 1	New Version 2
Changes made by	Tania Romo	Tania Romo
Saved on	Nov 18, 2020	Nov 18, 2020

Versions Compared

Key

Situación actual