Skip to content

Noticelists

get_all_noticelists async 

get_all_noticelists(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
) -> list[GetAllNoticelists]

Retrieve a list of all noticelists.

Input:

  • the user's authentification status

  • the current database

Output:

  • all notice lists as a list

get_noticelist async 

get_noticelist(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
    noticelist_id: Annotated[int, Path(alias=noticelistId)],
) -> NoticelistResponse

Retrieve details of a specific noticelist by its ID.

Input:

  • the user's authentification status

  • the current database

  • the notice list id

Output:

  • the details of the notice list

get_noticelist_depr async 

get_noticelist_depr(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.HYBRID))
    ],
    db: Annotated[Session, Depends(get_db)],
    noticelist_id: Annotated[int, Path(alias=noticelistId)],
) -> NoticelistResponse

Deprecated. Retrieve details of a specific noticelist by its ID using the old route.

Input:

  • the user's authentification status

  • the current database

  • the id of the notice list

Output:

  • the details of the notice list

post_toggleEnable_noticelist async 

post_toggleEnable_noticelist(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.HYBRID, [Permission.SITE_ADMIN]
            )
        ),
    ],
    db: Annotated[Session, Depends(get_db)],
    noticelist_id: Annotated[int, Path(alias=noticelistId)],
) -> StandardStatusIdentifiedResponse

Disable/Enable a specific noticelist by its ID.

Input:

  • the user's authentification status

  • the current database

  • the notice list id

Output:

  • the enabled/disabled notice list

update_noticelist_depr async 

update_noticelist_depr(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.HYBRID, [Permission.SITE_ADMIN]
            )
        ),
    ],
    db: Annotated[Session, Depends(get_db)],
) -> StandardStatusResponse

Deprecated. Update all noticelists.

Input:

  • the user's authentification status

  • the current database

Output:

  • all updated notice lists

update_noticelists async 

update_noticelists(
    auth: Annotated[
        Auth,
        Depends(
            authorize(
                AuthStrategy.HYBRID, [Permission.SITE_ADMIN]
            )
        ),
    ],
    db: Annotated[Session, Depends(get_db)],
) -> StandardStatusResponse

Update all noticelists.

Input:

  • the user's authentification status

  • the current database

Output:

  • all updated notice lists