Skip to content

cg api featured-event

The featured-event service endpoint. See cg api for how these relate to the higher-level commands.

Every command also accepts -h / --help.

Command Summary
cg api featured-event FeaturedEvent service commands.
cg api featured-event find-upcoming-and-ongoing-featured-events Find upcoming and ongoing site-wide featured events.
cg api featured-event is-codingamer-auto-registered Check whether a codingamer is auto-registered for featured events.
cg api featured-event find-new-featured-event-count Count featured events published since a given point in time.
cg api featured-event find-clash-slots Find the individual scheduled Clash of Code slots belonging to a featured event.
cg api featured-event find-by-handle Find a featured event by its opaque handle.

FeaturedEvent service commands.

usage: cg api featured-event [-h] COMMAND ...

Subcommands

Find upcoming and ongoing site-wide featured events.

usage: cg api featured-event find-upcoming-and-ongoing-featured-events [-h] [--codingamer-id ID]

Options

  • -g, --codingamer-id ID — Codingamer to check registration status for. Defaults to the logged-in codingamer's ID.

Check whether a codingamer is auto-registered for featured events.

usage: cg api featured-event is-codingamer-auto-registered [-h] [--codingamer-id ID]

Options

  • -g, --codingamer-id ID — Codingamer to check. Must be the logged-in codingamer's own ID (server-enforced). Defaults to the logged-in codingamer's ID.

Count featured events published since a given point in time.

usage: cg api featured-event find-new-featured-event-count [-h] [--since TIMESTAMP]

Options

  • --since TIMESTAMP — Count featured events published after this point in time. Can be milliseconds since epoch (e.g., '1680000000000'), a duration string (e.g., '1h30m'), a relative duration from now (e.g., '-1h30m'), or an ISO 8601 datetime string. Defaults to now.

Find the individual scheduled Clash of Code slots belonging to a featured event.

usage: cg api featured-event find-clash-slots [-h] FEATURED-EVENT-ID

Arguments

  • FEATURED-EVENT-ID — The numeric 'id' of a CLASH_OF_CODE-type featured event (not its 'handle').

Find a featured event by its opaque handle.

usage: cg api featured-event find-by-handle [-h] HANDLE

Arguments

  • HANDLE — Opaque featured event handle string.

Generated from the parser itself. For when to use these, see the CLI guides.