Versions Compared

Version Old Version 29 New Version 30
Changes made by

Fidel Aquino. CCORP

Fidel Aquino. CCORP

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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


Code Block
languagexml
<unoStaffList>
<unoStaff refId="">

<name>

    <name>
        <firstName>Staff</firstName>


        <middleName>Prueba</middleName>


        <lastName>Sif</lastName>


    </name>


    <birthDate>2014-06-06</birthDate>


    <sex>Male</sex>


    <userId>new.staff.1</userId>


    <password> bmV3LnN0YWZmLjE=</password>


    <language>ES</language>


    <curp></curp>

<addressList>
<address 

    <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>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>
            <countyRefId>00000000-0000-1000-0000-000000011302</countyRefId>


        </address>


    </addressList>

<phoneNumberList>
<phoneNumber 

    <phoneNumberList>
        <phoneNumber phoneNumberType="Home">


            <number>53956782</number>


        </phoneNumber>

<phoneNumber 

        <phoneNumber phoneNumberType="Mobile">


            <number>5537651829</number>


        </phoneNumber>


    </phoneNumberList>

<schoolEmailList>
<schoolEmail>

    <schoolEmailList>
        <schoolEmail>
            <email>new.staff.
1@correo
1@correo.
com<
com</email>


        </schoolEmail>


    </schoolEmailList>


</unoStaff>

</unoStaffList>


¿Quién lo utiliza y cómo?

 

  

...