Servicio /sif/unoSchool

Estado

En Uso

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

Este servicio será utilizado por las aplicaciones que necesiten consultar o actualizar colegios con la BDC.

Situación actual

Descripción

Consulta o Actualiza un Colegio por su id.

Referencia SIF

Extensión de SIF 3.0.1

Entidad BDC

Colegio

Entidad SIF

Extensión de la entidad k12school (CEDS_K12.xsd).

Tipo de Petición

GET para consultar y PUT para actualizar

Parámetros

Campos en URL	Descripción	Reglas de negocio
UUID del Colegio que se consulta	UUID del Colegio que se consulta Los valores se puede consultar con el servicio /sif/unoSchool/schools. Obligatorio	El identificador debe existir. En caso de ser un ID de colegio no válido entrega el siguiente mensaje: <code>404</code> <message>No se encontraron datos con los parámetros especificados.</message>

Campos en Payload	Descripción	Reglas de negocio
unoSchool refId	UUID del Colegio que se consulta Obligatorio	El identificador debe existir. En caso de ser un ID de colegio no válido entrega el siguiente mensaje: <code>400</code> <message>El parámetro 'id' es requerido.</message>
schoolIdSystem	Clave del colegio
name	Descripción
country	Clave del País	Se pueden obtener los valores con el servicio sif/catalogs/country.
addressType	Tipo domicilio Valores: Physical, Mailing, Shipping
street line1	Calle
city	Ciudad
neighborhood	Colonia
postalCode	Código postal
buildingSiteNumber	Número Obligarotio
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: Main, Administrative
number	Teléfono
email	Correo electrónico

Ejemplo de llamada o de formulario

https://homol.uno-internacional.com/sif/unoSchool/00000000-0000-1000-0000-000000001135

<unoSchool refId="00000000-0000-1000-0000-000000001135" >
    <schoolIdSystem>IEDIS</schoolIdSystem>
    <name>IEDIS PRIMARIA METEPEC</name>
    <country>MX</country>
    <addressList>
        <address addressType="Physical">
            <street>
                <line1>MARIANO MATAMOROS</line1>
            </street>
            <city>METEPEC</city>
            <neighborhood>BARRIO DE SAN MATEO</neighborhood>
            <postalCode>52149</postalCode>
            <buildingSiteNumber>1201</buildingSiteNumber>
            <county>METEPEC</county>
            <stateProvince>Estado de México</stateProvince>
            <countyRefId>00000000-0000-1000-0000-000000011121</countyRefId>
        </address>
        <address addressType="Mailing">
            <street>
                <line1>AV. JUAREZ</line1>
            </street>
            <city>TOLUCA</city>
            <neighborhood>SAN MATEO OXTOTITLAN</neighborhood>
            <postalCode>50100</postalCode>
            <buildingSiteNumber>207</buildingSiteNumber>
            <county>TOLUCA</county>
            <stateProvince>Estado de México</stateProvince>
            <countyRefId>00000000-0000-1000-0000-000000011235</countyRefId>
        </address>
        <address addressType="Shipping">
            <street>
                <line1>MARIANO MATAMOROS</line1>
            </street>
            <city>METEPEC</city>
            <neighborhood>BARRIO DE SAN MATEO</neighborhood>
            <postalCode>52149</postalCode>
            <buildingSiteNumber>1201</buildingSiteNumber>
            <county>METEPEC</county>
            <stateProvince>Estado de México</stateProvince>
            <countyRefId>00000000-0000-1000-0000-000000011121</countyRefId>
        </address>
    </addressList>
    <phoneNumberList>
        <phoneNumber phoneNumberType="Main">
            <number>(722)319-0286 (722)318-4843 (722) 271-3148</number>
        </phoneNumber>
        <phoneNumber phoneNumberType="Administrative">
            <number>(044) (722) 408 89 64</number>
        </phoneNumber>
    </phoneNumberList>
    <schoolEmailList>
        <schoolEmail>
            <email>contabilidad@casitaiedis.edu.mx</email>
        </schoolEmail>
    </schoolEmailList>
</unoSchool>

Respuesta

¿Quién lo utiliza y cómo?