Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 28 Next »

Estado

EN USO

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 periodicidad.

Situación actual

Descripción

Consulta o actualiza un Staff por su id

Referencia BDCPersona
Referencia SIFUNOStaff (Lista).
Tipo de PeticiónGET para consultar, PUT para actualizar y POST para insertar
Parámetros o Campos
CamposDescripciónReglas 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>

CampoDescripciónReglas de Negocio
unoStaff refId
  • Obligatorio para actualizar
  • Cuando se inserta va en blanco.

 

firstName
  • Nombre

 

 

 

middleName
  • Apellido paterno

 

lastName
  • Apellido materno

 

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.
language 
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 
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
Ejemplo de llamada o de formulario

En caso de consultar o actualizar un solo identificador:

http://desenv.uno-internacional.com/sif/unoStaff/00000000-0000-1000-0000-000001363444

En caso de insertar solo un staff o actualizar varios:

http://desenv.uno-internacional.com/sif/unoStaff

Respuesta o XML Payload

Se 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)

<unoStaffList>

<unoStaff refId="00000000-0000-1000-0000-000001363444"> persona.persona_id (Identificador único en la BDC). En caso de insertar refId="".
<name>
<firstName>Bricho</firstName> Nombre
<middleName>Velazquez</middleName>  Primer apellido
<lastName>Hernandez</lastName> Segundo apellido
</name>
<birthDate>1987-10-06</birthDate> Fecha de nacimiento
<sex>Male</sex>  (Male, Female, Not selected)
<userId>Bricio.21</userId>  Username
<language>ES</language> Idioma
<curp></curp> Curp
<addressList>  Listado de domicilios
<address addressType="Physical"> Tipo de dirección (Physical, Mailing, Shipping)
<street>
<line1></line1> Calle
</street>
<city></city> Ciudad
<neighborhood></neighborhood> Colonia
<postalCode></postalCode> Código postal
<buildingSiteNumber>0</buildingSiteNumber> Número
<county>ZINACANTEPEC</county> Municipio
<stateProvince>Estado de México</stateProvince> Estado
<countyRefId>00000000-0000-1000-0000-000000011240</countyRefId> municipio.municipio_id (Identificador único en la BDC)
</address>
</addressList>
<phoneNumberList></phoneNumberList>  Listado de teléfonos
<schoolEmailList> Listado de correos electrónicos
<schoolEmail>
<email>Briciovh@bricioonline.com</email> Correo electrónico
</schoolEmail>
</schoolEmailList>
</unoStaff>

</unoStaffList>

¿Quién lo utiliza y cómo?

 

  
  • No labels