Versions Compared

Version Old Version 3 New Version Current
Changes made by

Samara Carmona. CCORP

Tania Romo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Import Link Fixer


Panel
titleEstado

<

Status
colourGreen
titleEn uso
>

Info
titleEn 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 consultar los colegios que pertenecen a un ciclo escolar y empresa determinados en la BDC.


Situación actual

DescripciónConsulta los colegios que pertenecen a un ciclo escolar y empresa determinados.
Referencia SIFExtensión de SIF 3.0.1
Entidad BDCcontrato
Entidad SIFcontracts
Tipo de PeticiónGET
Parámetros


Campos
Descripción
Reglas de negocio
country
 Clave
  • Clave del pais.
Ver
  • Si no se especifica el parámetro, como es obligatorio devuelve:
    • <code>400</code>
      <message>Debe especificar un país para consultar.</message>
  • Debe existir la clave del país, en caso de no ser válido devuelve:

    • <code>404</code>
      <message>No se encontraron datos con los parámetros especificados.</message>

schoolYear
  • Si no se especifica el parámetro, como es obligatorio devuelve:
    •  <code>400</code>
      <message>Debe especificar un ciclo para consultar.</message>
business
  • La empresa a la que pertenecen los colegios que se quieren consultar
  • Obligatorio
  • Ver maestro de empresa.
  • El identificador debe existir.
  • En caso de ser una empresa no válida entrega el siguiente mensaje:

    <code>404</code>
    <message>No se encontraron datos con los parámetros especificados.</message>

keys
  • Indicador de regresar solo llaves de entidades.
Default: false.
  • Opcional
    •  
    • Obligatorio
    • Valores: true

     El servicio sólo devolverá los refId correspondientes a los colegios cuando el valor es true, si se indica un valor diferente la respuesta será:

    <unoSchoolList></unoSchoolList>


    Ejemplo de llamada o de formulario
    http

    https://

    desenv

    homol.uno-internacional.com/sif/unoSchool/schools;contextId=

     

    {"country":"MX", "business":"COMP", "schoolYear":2017, "keys":

    "

    true

    "

    }

    Respuesta

    <unoSchoolList>
    <unoSchool refId="00000000-0000-1000-0000-000000004846" /> colegio.colegio_id (Identificador único en la BDC)
    <unoSchool refId="00000000-0000-1000-0000-000000003828" />
    <unoSchool refId="00000000-0000-1000-0000-000000003599" />
    <unoSchool refId="00000000-0000-1000-0000-000000001595" />
    <unoSchool refId="00000000-0000-1000-0000-000000003644" />
    <unoSchool refId="00000000-0000-1000-0000-000000003714" />
    <unoSchool refId="00000000-0000-1000-0000-000000003577" />
    <unoSchool refId="00000000-0000-1000-0000-000000003865" />
    <unoSchool refId="00000000-0000-1000-0000-000000002387" />
    <unoSchool refId="00000000-0000-1000-0000-000000002370" />
    <unoSchool refId="00000000-0000-1000-0000-000000003558" />
    <unoSchool refId="00000000-0000-1000-0000-000000002421" />
    <unoSchool refId="00000000-0000-1000-0000-000000002463" />
    <unoSchool refId="00000000-0000-1000-0000-000000003781" />
    <unoSchool refId="00000000-0000-1000-0000-000000002307" />
    <unoSchool refId="00000000-0000-1000-0000-000000003570" />
    <unoSchool refId="00000000-0000-1000-0000-000000003569" />

    ........

    <unoSchool refId="00000000-0000-1000-0000-000000005907" />
    <unoSchool refId="00000000-0000-1000-0000-000000005908" />
    <unoSchool refId="00000000-0000-1000-0000-000000005911" />
    <unoSchool refId="00000000-0000-1000-0000-000000005912" />
    <unoSchool refId="00000000-0000-1000-0000-000000005916" />
    <unoSchool refId="00000000-0000-1000-0000-000000005936" />
    <unoSchool refId="00000000-0000-1000-0000-000000005937" />
    </unoSchoolList>

    ¿Quién lo utiliza y cómo?

     

    ...