Retrieve MMY levels by depth
Retrieves the collection of MMY Level resources.
Authorizations:Token, JWT
Query Parameters
depth required | integerEnum: 1 2 3 4 Level depth (1, 2, 3 or 4) |
page | integerDefault: 1 The collection page number |
itemsPerPage | integer[0 .. 100]Default: 30 The number of items per page |
pagination | booleanEnable or disable pagination |
filter.firstLetter | stringFilter for "firstLetter" field |
filter.substring | stringFilter for "substring" field |
filter.parent | integer>= 1Filter for "parent" field |
filter.showOnFrontPage | booleanFilter for "showOnFrontPage" field |
Query Parameters
depth required | integerEnum: 1 2 3 4 Level depth (1, 2, 3 or 4) |
page | integerDefault: 1 The collection page number |
itemsPerPage | integer[0 .. 100]Default: 30 The number of items per page |
pagination | booleanEnable or disable pagination |
filter.firstLetter | stringFilter for "firstLetter" field |
filter.substring | stringFilter for "substring" field |
filter.parent | integer>= 1Filter for "parent" field |
filter.showOnFrontPage | booleanFilter for "showOnFrontPage" field |
Responses
200MMY Level collection
Response schema:
MMY Level collection Array
name | string |
depth | string |
title | string |
description | string |
parent_level_id | integer |
logo_url | string |
banner_urls | Array of strings |
id | integer>= 1 |
parentLevelId | integer |
logoUrl | string |
bannerUrls | Array of strings |
401Unauthorized
Response schema:
Unauthorized type | stringExample: "https://tools.ietf.org/html/rfc2616#section-10" |
title | stringExample: "An error occurred" |
detail | string or nullExample: "Cannot find entity" |
instance | string or null |
500Internal error
Response schema:
Internal error type | stringExample: "https://tools.ietf.org/html/rfc2616#section-10" |
title | stringExample: "An error occurred" |
detail | string or nullExample: "Cannot find entity" |
instance | string or null |