CompSuite API
v4
  • v4
  • v3
  • v2
    CompSuite API
    v4
    • v4
    • v3
    • v2
    • API Usage Guidelines
    • Authentication
    • Errors
    • Divisions
      • List all divisions
        GET
    • Groups
      • List all groups
        GET
      • Retrieve a group
        GET
      • Create a Group
        POST
      • Update a group
        POST
    • Seasons
      • List all seasons
        GET
    • Events
      • List all events
        GET
      • Retrieve an event
        GET
      • Create an event
        POST
      • Create a Competition
        POST
    • Performances
      • Add a performance
        POST
      • Delete a performance
        DELETE
    • Schedule
      • Retrieve Schedule for Competition
        GET
    • Scores
      • Retrieve Competition Scores
        GET

    Errors

    HTTP Response Codes#

    CompetitionSuite uses standard HTTP response codes to indicate the success or failure of API requests.

    Response Code Ranges#

    2xx Success
    The request was successful and the server has processed it as expected.
    4xx Client Error
    The request contains an error or cannot be fulfilled due to client-side issues, such as missing required parameters, invalid authentication, or malformed requests.
    5xx Server Error
    An error occurred on CompetitionSuite's servers. These errors are rare and typically indicate temporary issues with our infrastructure.

    Error Handling#

    Client errors (4xx) may include additional error information to help with programmatic handling:
    Error Code: A brief identifier for the specific error type
    Error Message: A human-readable description of what went wrong
    Additional Context: When applicable, details about which parameters or fields caused the issue

    Common Response Codes#

    CodeStatusDescription
    200OKRequest successful
    201CreatedResource successfully created
    400Bad RequestInvalid request format or missing required parameters
    401UnauthorizedAuthentication required or invalid credentials
    403ForbiddenValid authentication but insufficient permissions
    404Not FoundRequested resource does not exist
    422Unprocessable EntityValid request format but contains semantic errors
    429Too Many RequestsRate limit exceeded
    500Internal Server ErrorUnexpected server error
    502Bad GatewayTemporary server issue
    503Service UnavailableServer temporarily unavailable

    Best Practices#

    Always check the HTTP status code before processing the response body
    Implement retry logic for 5xx errors with exponential backoff
    Parse error codes in 4xx responses for specific error handling
    Log unexpected errors for debugging purposes
    Modified at 2025-07-28 13:39:04
    Previous
    Authentication
    Next
    List all divisions
    Built with