Filtros para integracion OneRoster
Descripción:
Para el uso de filtros en los servicios SIF, se propone implementar la siguiente manera para filtrar y consumir:
Descripcion | Operador | Valor |
---|---|---|
Equals | = | EQ |
Not Equal | != | NEQ |
Greater Than | > | GT |
Lesser than | < | LT |
Greater than equals | >= | GTE |
Lesser than equals | <= | LTE |
Contains | ~ | CONTAINS |
Ejemplo Json para filtros:
{
"filters": [
{
"field": "alias",
"value": "30",
"_operator": "EQ"
}
]
}
Importante: Para el uso correcto de los filtros, es necesario enviar el parámetro ‘filter', y en su valor, la estructura del json anterior minimizado.
Ejemplo:
https://homol.uno-internacional.com/sif/v3/empresas/00000000-0000-1000-0000-000000000008/sessions/00000000-0000-1000-0000-000000000033/getClassesForCourse?filter={"filters":[{"field":"alias","value":"30","_operator":"EQ"}]}
Para agregar mas campos a la busqueda, es necesario agregar al array 'filters', la informacion del campo a buscar.
Ejemplo:
{
"_logicOperator": "AND",
"filters": [
{
"field": "alias",
"value": "30",
"_operator": "EQ"
},
{
"field": "schoolRefId",
"value": "00000000-0000-1000-0000-000000000033",
"_operator": "EQ"
}
]
}
De esta manera, filtrará los datos que pertenezcan a un ‘schoolRefId' con el valor indicado, y el 'alias’ indicado.
Para el campo __logicOperator, es necesario inidicar que tipo de anidacion tendran las consultas.
_logicOperator |
---|
AND |
OR |
Ejemplo:
https://homol.uno-internacional.com/sif/v3/empresas/00000000-0000-1000-0000-000000000008/sessions/00000000-0000-1000-0000-000000000033/getClassesForCourse?filter={"_logicOperator":"AND","filters":[{"field":"alias","value":"30","_operator":"EQ"}]}