Sign in
Resources

Get all resources

Changed on

Retrieve all resources from the database

get/resources

Request

  • Base URL: http://localhost:8080/api/v1
  • URL: http://localhost:8080/api/v1/resources
  • Auth: none declared

Query parameters

theme_idstring uuid

Filter resources by theme ID

grade_levelinteger

Filter resources by grade level. 0 = kindergarten, 1-12 = grades 1-12

datestring date

Filter resources by date

typestring

Filter resources by type

titlestring

Filter resources by title

categorystring

Filter resources by category

contentstring

Filter resources by content/URL

theme_namestring

Filter resources by theme name

theme_monthinteger

Filter resources by theme month

theme_yearinteger

Filter resources by theme year

weekinteger

Filter resources by week (1-4)

pageinteger

Page Number of pagination

limitinteger

Number of Items per page in pagination

Response

List of resources

idstring uuid required

Unique identifier for the resource

theme_idstring uuid required

ID of the theme associated with the resource

grade_levelinteger nullable

Grade level for the resource (optional). 0 = kindergarten, 1-12 = grades 1-12

weekinteger nullable

Week associated with the resource (optional)

typestring nullable

Type of resource (optional)

titlestring nullable

Title of the resource (optional)

categorystring nullable

Category of the resource (optional)

contentstring nullable

Content/URL of the resource (optional)

presigned_urlstring url

The Presigned URL to access the resource

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "theme_id": "123e4567-e89b-12d3-a456-426614174000",
    "grade_level": 5,
    "week": 2,
    "title": "Reading Exercises: b vs d",
    "content": "https://example.com/resource",
    "theme": {
      "theme_name": "Jungle Adventure",
      "theme_month": 6,
      "theme_year": 2024,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:35:00Z"
    },
    "presigned_url": "https://some-bucket.s3.us-west.cloudprovider.org/bucket/year/month/somefile.pdf?X-Tmz-Algorithm=LOG4-HMAC-SHA256&X-Tmz-Checksum-Mode=ENABLED&X-Tmz-Credential=AKIAEXAMPLE%2F20251016%2Fus-west%2Fs3%2Faws4_request&X-Tmz-Date=20251016T000000Z&X-Tmz-Expires=900&X-Tmz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=EXAMPLESIGNATURE1234567890abcdef"
  }
]

Changes

  • 6b13211b9245Revision changes
    • ●

      removed the optional property / from the response with the status

    • ○

      added the new optional query request parameter week

    • ○

      added the optional property / to the response with the status

  • 8153547d782fRevision changes
    • ○

      added the optional property / to the response with the status