Count

GET /v1/students/count

Count Student

Query parameters

search string

Global search
where object

App\Families\Students\Models\Student Filters: 0, 1, 2, 3, 4
Hide where attributes Show where attributes object
- id object
  
  Filter by id field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
- gender object
  
  Filter by gender field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
- dateOfBirth object
  
  Filter by dateOfBirth field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
- familyId object
  
  Filter by familyId field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
- createdAt object
  
  Filter by createdAt field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
onlyArchived boolean

Determines whether to return only archived records in the response.

Responses

200 application/json

successful operation
Hide response attribute Show response attribute object
- count integer Required
  
  count
403 application/json

Not authorized
Hide response attributes Show response attributes object
Error schema
- statusCode number Required
  
  Status Code
- messages array[string] Required
  
  List of error messages
- exception object
  
  Exception

GET /v1/students/count

curl \
 --request GET 'https://classmanager.test/v1/students/count'

Response examples (200)

{
  "count": 100
}

Response examples (403)

{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}

Count

Query parameters

id object

gender object

dateOfBirth object

familyId object

createdAt object

Responses