School
Search Schools
Search for Schools with filtering capabilities.
post/school/_search
Query parameters
limitinteger
Example:1
The maximum number of Schools to return (default: 50) when searching Schools
offsetinteger
The number of Schools to skip before starting to return results (default: 0) when searching Schools
Request body
Example request
{
"filter": {
"equals": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2024-01-15T10:30:00Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
},
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example",
"unitID": "123e4567-e89b-12d3-a456-426614174000",
"unitCode": "example",
"csnSchoolCode": "example",
"municipalityCode": "example"
},
"notEquals": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2024-01-15T10:30:00Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
},
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example",
"unitID": "123e4567-e89b-12d3-a456-426614174000",
"unitCode": "example",
"csnSchoolCode": "example",
"municipalityCode": "example"
},
"greaterThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"smallerThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"greaterOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"smallerOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"contains": {
"id": [
"123e4567-e89b-12d3-a456-426614174000"
],
"meta": {
"createdBy": [
"123e4567-e89b-12d3-a456-426614174000"
],
"updatedBy": [
"123e4567-e89b-12d3-a456-426614174000"
]
},
"external": {
"sourceID": [
"example"
],
"source": [
"example"
]
},
"title": [
"example"
],
"unitID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"unitCode": [
"example"
],
"csnSchoolCode": [
"example"
],
"municipalityCode": [
"example"
]
},
"notContains": {
"id": [
"123e4567-e89b-12d3-a456-426614174000"
],
"meta": {
"createdBy": [
"123e4567-e89b-12d3-a456-426614174000"
],
"updatedBy": [
"123e4567-e89b-12d3-a456-426614174000"
]
},
"external": {
"sourceID": [
"example"
],
"source": [
"example"
]
},
"title": [
"example"
],
"unitID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"unitCode": [
"example"
],
"csnSchoolCode": [
"example"
],
"municipalityCode": [
"example"
]
},
"like": {
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example",
"unitCode": "example",
"csnSchoolCode": "example",
"municipalityCode": "example"
},
"notLike": {
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example",
"unitCode": "example",
"csnSchoolCode": "example",
"municipalityCode": "example"
},
"null": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": {
"sourceID": true,
"source": true
},
"unitID": true,
"unitCode": true,
"csnSchoolCode": true,
"municipalityCode": true
},
"notNull": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": {
"sourceID": true,
"source": true
},
"unitID": true,
"unitCode": true,
"csnSchoolCode": true,
"municipalityCode": true
},
"orCondition": true,
"nestedFilters": [
{
"equals": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2024-01-15T10:30:00Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
},
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example",
"unitID": "123e4567-e89b-12d3-a456-426614174000",
"unitCode": "example",
"csnSchoolCode": "example",
"municipalityCode": "example"
},
"notEquals": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2024-01-15T10:30:00Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
},
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example",
"unitID": "123e4567-e89b-12d3-a456-426614174000",
"unitCode": "example",
"csnSchoolCode": "example",
"municipalityCode": "example"
},
"greaterThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"smallerThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"greaterOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"smallerOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
}
},
"contains": {
"id": [
"123e4567-e89b-12d3-a456-426614174000"
],
"meta": {
"createdBy": [
"123e4567-e89b-12d3-a456-426614174000"
],
"updatedBy": [
"123e4567-e89b-12d3-a456-426614174000"
]
},
"external": {
"sourceID": [
"example"
],
"source": [
"example"
]
},
"title": [
"example"
],
"unitID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"unitCode": [
"example"
],
"csnSchoolCode": [
"example"
],
"municipalityCode": [
"example"
]
},
"notContains": {
"id": [
"123e4567-e89b-12d3-a456-426614174000"
],
"meta": {
"createdBy": [
"123e4567-e89b-12d3-a456-426614174000"
],
"updatedBy": [
"123e4567-e89b-12d3-a456-426614174000"
]
},
"external": {
"sourceID": [
"example"
],
"source": [
"example"
]
},
"title": [
"example"
],
"unitID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"unitCode": [
"example"
],
"csnSchoolCode": [
"example"
],
"municipalityCode": [
"example"
]
},
"like": {
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example",
"unitCode": "example",
"csnSchoolCode": "example",
"municipalityCode": "example"
},
"notLike": {
"external": {
"sourceID": "example",
"source": "example"
},
"title": "example",
"unitCode": "example",
"csnSchoolCode": "example",
"municipalityCode": "example"
},
"null": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": {
"sourceID": true,
"source": true
},
"unitID": true,
"unitCode": true,
"csnSchoolCode": true,
"municipalityCode": true
},
"notNull": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": {
"sourceID": true,
"source": true
},
"unitID": true,
"unitCode": true,
"csnSchoolCode": true,
"municipalityCode": true
},
"orCondition": true
}
]
}
}Response
Response for School Search operation - returns filtered School results
Example response
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
"updatedAt": "2024-01-15T14:45:00Z",
"updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
},
"external": {
"sourceID": "12345678",
"source": "ExternalIntegrationAPI"
},
"title": "Meitner Grundskola",
"unitID": "123e4567-e89b-12d3-a456-426614174000",
"unitCode": "12345678",
"csnSchoolCode": "12345",
"municipalityCode": "0184",
"schoolType": "GR"
}
],
"pagination": {
"limit": 1,
"total": 100
}
}