StudentPlacement
Search StudentPlacements
Search for StudentPlacements with filtering capabilities.
post/student-placement/_search
Query parameters
limitinteger
Example:1
The maximum number of StudentPlacements to return (default: 50) when searching StudentPlacements
offsetinteger
The number of StudentPlacements to skip before starting to return results (default: 0) when searching StudentPlacements
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"
},
"studentID": "123e4567-e89b-12d3-a456-426614174000",
"schoolID": "123e4567-e89b-12d3-a456-426614174000",
"hasChildcare": true,
"childcareMaxHours": 42,
"motherTongue": "example",
"swedishAsSecondLanguage": true,
"motherTongueParticipates": true,
"modernLanguageInSchoolChoice": "example",
"modernLanguageInLanguageChoice": "example",
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archiveYear": "example",
"archivedAt": "2024-01-15T10:30:00Z"
},
"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"
},
"studentID": "123e4567-e89b-12d3-a456-426614174000",
"schoolID": "123e4567-e89b-12d3-a456-426614174000",
"hasChildcare": true,
"childcareMaxHours": 42,
"motherTongue": "example",
"swedishAsSecondLanguage": true,
"motherTongueParticipates": true,
"modernLanguageInSchoolChoice": "example",
"modernLanguageInLanguageChoice": "example",
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archiveYear": "example",
"archivedAt": "2024-01-15T10:30:00Z"
},
"greaterThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"childcareMaxHours": 42,
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archivedAt": "2024-01-15T10:30:00Z"
},
"smallerThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"childcareMaxHours": 42,
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archivedAt": "2024-01-15T10:30:00Z"
},
"greaterOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"childcareMaxHours": 42,
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archivedAt": "2024-01-15T10:30:00Z"
},
"smallerOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"childcareMaxHours": 42,
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archivedAt": "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"
]
},
"studentID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"schoolID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"hasChildcare": [
true
],
"childcareMaxHours": [
42
],
"motherTongue": [
"example"
],
"swedishAsSecondLanguage": [
true
],
"motherTongueParticipates": [
true
],
"modernLanguageInSchoolChoice": [
"example"
],
"modernLanguageInLanguageChoice": [
"example"
],
"startDate": [
"2024-01-15"
],
"endDate": [
"2024-01-15"
],
"archiveYear": [
"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"
]
},
"studentID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"schoolID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"hasChildcare": [
true
],
"childcareMaxHours": [
42
],
"motherTongue": [
"example"
],
"swedishAsSecondLanguage": [
true
],
"motherTongueParticipates": [
true
],
"modernLanguageInSchoolChoice": [
"example"
],
"modernLanguageInLanguageChoice": [
"example"
],
"startDate": [
"2024-01-15"
],
"endDate": [
"2024-01-15"
],
"archiveYear": [
"example"
]
},
"like": {
"external": {
"sourceID": "example",
"source": "example"
},
"motherTongue": "example",
"modernLanguageInSchoolChoice": "example",
"modernLanguageInLanguageChoice": "example",
"archiveYear": "example"
},
"notLike": {
"external": {
"sourceID": "example",
"source": "example"
},
"motherTongue": "example",
"modernLanguageInSchoolChoice": "example",
"modernLanguageInLanguageChoice": "example",
"archiveYear": "example"
},
"null": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": {
"sourceID": true,
"source": true
},
"schoolYear": true,
"childcareMaxHours": true,
"motherTongue": true,
"modernLanguageAlternative": true,
"modernLanguageInSchoolChoice": true,
"modernLanguageInLanguageChoice": true,
"endDate": true,
"archiveYear": true,
"archivedAt": true
},
"notNull": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": {
"sourceID": true,
"source": true
},
"schoolYear": true,
"childcareMaxHours": true,
"motherTongue": true,
"modernLanguageAlternative": true,
"modernLanguageInSchoolChoice": true,
"modernLanguageInLanguageChoice": true,
"endDate": true,
"archiveYear": true,
"archivedAt": 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"
},
"studentID": "123e4567-e89b-12d3-a456-426614174000",
"schoolID": "123e4567-e89b-12d3-a456-426614174000",
"hasChildcare": true,
"childcareMaxHours": 42,
"motherTongue": "example",
"swedishAsSecondLanguage": true,
"motherTongueParticipates": true,
"modernLanguageInSchoolChoice": "example",
"modernLanguageInLanguageChoice": "example",
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archiveYear": "example",
"archivedAt": "2024-01-15T10:30:00Z"
},
"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"
},
"studentID": "123e4567-e89b-12d3-a456-426614174000",
"schoolID": "123e4567-e89b-12d3-a456-426614174000",
"hasChildcare": true,
"childcareMaxHours": 42,
"motherTongue": "example",
"swedishAsSecondLanguage": true,
"motherTongueParticipates": true,
"modernLanguageInSchoolChoice": "example",
"modernLanguageInLanguageChoice": "example",
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archiveYear": "example",
"archivedAt": "2024-01-15T10:30:00Z"
},
"greaterThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"childcareMaxHours": 42,
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archivedAt": "2024-01-15T10:30:00Z"
},
"smallerThan": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"childcareMaxHours": 42,
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archivedAt": "2024-01-15T10:30:00Z"
},
"greaterOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"childcareMaxHours": 42,
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archivedAt": "2024-01-15T10:30:00Z"
},
"smallerOrEqual": {
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
"childcareMaxHours": 42,
"startDate": "2024-01-15",
"endDate": "2024-01-15",
"archivedAt": "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"
]
},
"studentID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"schoolID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"hasChildcare": [
true
],
"childcareMaxHours": [
42
],
"motherTongue": [
"example"
],
"swedishAsSecondLanguage": [
true
],
"motherTongueParticipates": [
true
],
"modernLanguageInSchoolChoice": [
"example"
],
"modernLanguageInLanguageChoice": [
"example"
],
"startDate": [
"2024-01-15"
],
"endDate": [
"2024-01-15"
],
"archiveYear": [
"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"
]
},
"studentID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"schoolID": [
"123e4567-e89b-12d3-a456-426614174000"
],
"hasChildcare": [
true
],
"childcareMaxHours": [
42
],
"motherTongue": [
"example"
],
"swedishAsSecondLanguage": [
true
],
"motherTongueParticipates": [
true
],
"modernLanguageInSchoolChoice": [
"example"
],
"modernLanguageInLanguageChoice": [
"example"
],
"startDate": [
"2024-01-15"
],
"endDate": [
"2024-01-15"
],
"archiveYear": [
"example"
]
},
"like": {
"external": {
"sourceID": "example",
"source": "example"
},
"motherTongue": "example",
"modernLanguageInSchoolChoice": "example",
"modernLanguageInLanguageChoice": "example",
"archiveYear": "example"
},
"notLike": {
"external": {
"sourceID": "example",
"source": "example"
},
"motherTongue": "example",
"modernLanguageInSchoolChoice": "example",
"modernLanguageInLanguageChoice": "example",
"archiveYear": "example"
},
"null": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": {
"sourceID": true,
"source": true
},
"schoolYear": true,
"childcareMaxHours": true,
"motherTongue": true,
"modernLanguageAlternative": true,
"modernLanguageInSchoolChoice": true,
"modernLanguageInLanguageChoice": true,
"endDate": true,
"archiveYear": true,
"archivedAt": true
},
"notNull": {
"meta": {
"createdBy": true,
"updatedAt": true,
"updatedBy": true
},
"external": {
"sourceID": true,
"source": true
},
"schoolYear": true,
"childcareMaxHours": true,
"motherTongue": true,
"modernLanguageAlternative": true,
"modernLanguageInSchoolChoice": true,
"modernLanguageInLanguageChoice": true,
"endDate": true,
"archiveYear": true,
"archivedAt": true
},
"orCondition": true
}
]
}
}Response
Response for StudentPlacement Search operation - returns filtered StudentPlacement 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"
},
"studentID": "123e4567-e89b-12d3-a456-426614174000",
"schoolID": "123e4567-e89b-12d3-a456-426614174000",
"schoolType": "GR",
"schoolYear": "1",
"hasChildcare": true,
"childcareMaxHours": 15,
"motherTongue": "SWE",
"modernLanguageAlternative": "EN",
"swedishAsSecondLanguage": false,
"motherTongueParticipates": false,
"modernLanguageInSchoolChoice": "deu",
"modernLanguageInLanguageChoice": "fra",
"startDate": "2024-08-01",
"endDate": "2025-08-01",
"archiveYear": "2024_2025",
"archivedAt": "2024-08-01T00:00:00Z"
}
],
"pagination": {
"limit": 1,
"total": 100
}
}