Skip to main content

PaginatedResponse_SharingTagDto

Generic paginated response wrapper with HATEOAS links

data object[]required

The data items for this page

  • Array [
  • createdAtstring<date-time>required

    Creation timestamp

    Example: 2024-01-01T00:00:00Z
    descriptionstring | nullnullable

    Optional description

    Example: Content appropriate for children
    idstring<uuid>required

    Unique sharing tag identifier

    Example: 550e8400-e29b-41d4-a716-446655440000
    namestringrequired

    Display name of the sharing tag

    Example: Kids Content
    seriesCountinteger<int64>required

    Number of series tagged with this sharing tag

    Possible values: >= 0

    Example: 42
    updatedAtstring<date-time>required

    Last update timestamp

    Example: 2024-01-15T10:30:00Z
    userCountinteger<int64>required

    Number of users with grants for this sharing tag

    Possible values: >= 0

    Example: 5
  • ]
  • links objectrequired

    HATEOAS navigation links

    firststringrequired

    Link to the first page

    laststringrequired

    Link to the last page

    nextstring | nullnullable

    Link to the next page (null if on last page)

    prevstring | nullnullable

    Link to the previous page (null if on first page)

    selfstringrequired

    Link to the current page

    pageinteger<int64>required

    Current page number (1-indexed)

    Possible values: >= 0

    Example: 1
    pageSizeinteger<int64>required

    Number of items per page

    Possible values: >= 0

    Example: 50
    totalinteger<int64>required

    Total number of items across all pages

    Possible values: >= 0

    Example: 150
    totalPagesinteger<int64>required

    Total number of pages

    Possible values: >= 0

    Example: 3
    PaginatedResponse_SharingTagDto
    {
    "data": [
    {
    "createdAt": "2024-01-01T00:00:00Z",
    "description": "Content appropriate for children",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Kids Content",
    "seriesCount": 42,
    "updatedAt": "2024-01-15T10:30:00Z",
    "userCount": 5
    }
    ],
    "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
    },
    "page": 1,
    "pageSize": 50,
    "total": 150,
    "totalPages": 3
    }