Skip to content
Developers

Create a theme profile

POST/v2/competitions/{competitionId}/theme-profiles

POST
/v2/competitions/{competitionId}/theme-profiles
curl --request POST \
  --url https://api.ligr.live/rest/v2/competitions/1/theme-profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "themeId": 1, "name": "example", "defaultControlRoomId": 1, "themeVariableValues": [ { "variableId": "example", "value": "example" } ] }'

Creates a theme profile. The first profile becomes the competition default. The theme must have an active version and support the competition sport.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
competitionId
required

Entity identifier

integer format: int32
>= 1

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Assign an organization-owned theme to a competition. The default control room must belong to this organization and use the same theme.

object
themeId
required

Entity identifier

integer format: int32
>= 1
name

Default Entity name

string
>= 6 characters <= 39 characters
defaultControlRoomId

Entity identifier

integer format: int32
>= 1
themeVariableValues

Values for variables declared by the active theme version.

Array<object>
object
variableId
required

Variable id from the theme schema.

string
value
required
Any of:
string
Examplegenerated
{
  "themeId": 1,
  "name": "example",
  "defaultControlRoomId": 1,
  "themeVariableValues": [
    {
      "variableId": "example",
      "value": "example"
    }
  ]
}

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
id
required

Entity identifier

integer format: int32
>= 1
competitionId
required

Entity identifier

integer format: int32
>= 1
themeId
required

Entity identifier

integer format: int32
>= 1
name
required
string
defaultControlRoomId
required
integer format: int32
>= 1
isDefault
required
boolean
themeVariableValues
required
Array<object>
object
variableId
required

Variable id from the theme schema.

string
value
required
Any of:
string
Examplegenerated
{
  "id": 1,
  "competitionId": 1,
  "themeId": 1,
  "name": "example",
  "defaultControlRoomId": 1,
  "isDefault": true,
  "themeVariableValues": [
    {
      "variableId": "example",
      "value": "example"
    }
  ]
}

400

Section titled “400”

Request is invalid

Media typeapplication/json
object
message
required
string
details
required
object
key
additional properties
Examplegenerated
{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

Competition, theme, control room, or profile not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

429

Section titled “429”

Api key has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

500

Section titled “500”

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}