Skip to main content

Widget Library

Params​

getTeam

Get a team by id

Get a team by id. The method returns a team object, and can be called with a team object.

Parameters​

id string

The id of the team

md_name allOf string or integer

The name of the team

md_name string

The name of the team

md_name integer

The name of the team

teamObject object

The team object

Show teamObject object

teamObject fields​

The team object

  • name string

    The name of the user

  • age integer

    The age of the user

  • nickname string

    The nickname of the user

  • config object

    Show config object

    config fields​

    • id string

      The id of the config

    • name string

      The name of the config

    • retry_count integer

      The retry count of the config

    • timeout_ms integer

      The timeout in milliseconds of the config

    • altConfig object

      Show altConfig object

      altConfig fields​

      • id string

        The id of the super config

      • name string

        The name of the super config

      • retry_count integer

        The retry count of the super config

      • timeout_ms integer

        The timeout in milliseconds of the super config

Result​

teamObject object

The team object

Show teamObject object

teamObject fields​

The team object

  • name string

    The name of the user

  • age integer

    The age of the user

  • nickname string

    The nickname of the user

  • config object

    Show config object

    config fields​

    • id string

      The id of the config

    • name string

      The name of the config

    • retry_count integer

      The retry count of the config

    • timeout_ms integer

      The timeout in milliseconds of the config

    • altConfig object

      Show altConfig object

      altConfig fields​

      • id string

        The id of the super config

      • name string

        The name of the super config

      • retry_count integer

        The retry count of the super config

      • timeout_ms integer

        The timeout in milliseconds of the super config

Errors​

Error code: 4000

  • code

    4000

  • message

    Bad Request

  • data

    {"message":"Team not found"}

Error code: 5000

  • code

    5000

  • message

    Internal Server Error

  • data

    asdfjkalsgj;awigejoa null pointer Stack Trace

Examples​

getTeam

Get a team by id

Request​

{
  "params": {
    "id": "123",
    "teamObject": {
      "id": "123",
      "name": "Team 1"
    }
  }
}

Response​

{
  "teamObject": {
    "id": "123",
    "name": "Team 1"
  }
}

getTeam

Get a team by id

Request​

{
  "params": {
    "id": "456"
  }
}

Response​

{
  "teamObject": {
    "id": "456"
  }
}

getTeam

Get a team by id

Get a team by id. The method returns a team object, and can be called with a team object.

Parameters​

id string

The id of the team

md_name allOf string or integer

The name of the team

Show Option 1 md_name string

md_name fields​

The name of the team

md_name string

The name of the team

Show Option 2 md_name integer

md_name fields​

The name of the team

md_name integer

The name of the team

teamObject object

The team object

Show teamObject object

teamObject fields​

The team object

  • name string

    The name of the user

  • age integer

    The age of the user

  • nickname string

    The nickname of the user

  • config object

    Show config object

    config fields​

    • id string

      The id of the config

    • name string

      The name of the config

    • retry_count integer

      The retry count of the config

    • timeout_ms integer

      The timeout in milliseconds of the config

    • altConfig object

      Show altConfig object

      altConfig fields​

      • id string

        The id of the super config

      • name string

        The name of the super config

      • retry_count integer

        The retry count of the super config

      • timeout_ms integer

        The timeout in milliseconds of the super config

Result​

teamObject object

The team object

Show teamObject object

teamObject fields​

The team object

  • name string

    The name of the user

  • age integer

    The age of the user

  • nickname string

    The nickname of the user

  • config object

    Show config object

    config fields​

    • id string

      The id of the config

    • name string

      The name of the config

    • retry_count integer

      The retry count of the config

    • timeout_ms integer

      The timeout in milliseconds of the config

    • altConfig object

      Show altConfig object

      altConfig fields​

      • id string

        The id of the super config

      • name string

        The name of the super config

      • retry_count integer

        The retry count of the super config

      • timeout_ms integer

        The timeout in milliseconds of the super config

Errors​

Error code: 4000

  • code

    4000

  • message

    Bad Request

  • data

    {"message":"Team not found"}

Error code: 5000

  • code

    5000

  • message

    Internal Server Error

  • data

    asdfjkalsgj;awigejoa null pointer Stack Trace

Examples​

getTeam

Get a team by id

Request​

{
  "params": {
    "id": "123",
    "teamObject": {
      "id": "123",
      "name": "Team 1"
    }
  }
}

Response​

{
  "teamObject": {
    "id": "123",
    "name": "Team 1"
  }
}

getTeam

Get a team by id

Request​

{
  "params": {
    "id": "456"
  }
}

Response​

{
  "teamObject": {
    "id": "456"
  }
}

age number
Age of the person. between 0 and 2000.

name string

Name of the coach.

teamMetadata oneof object or object or string

The team metadata

Show Option 1 teamMetadata object

teamMetadata fields​

  • id string

    Unique identifier for the team.

  • name string

    Unique name for the team.

Show Option 2 teamMetadata object

teamMetadata fields​

  • label string

    Unique label for the team.

  • funnyName string

    Unique funny name for the team.

Show Option 3 teamMetadata string

string

An arbitrary json string

team object

The contents of the team.

Show team object

team fields​

  • id string

    Unique identifier for the team.

  • name string

    Unique name for the team.

  • members array<object>

    Members belonging to the team.

    Show member object

    member fields​

    • id string

      Unique identifier for the member.

      Schema Details
      {
        field: "therawschema"
      }

    • email string

      Email address of the member.

    • role string

      Role of the member within the team.

  • config object

    Configuration object.

    Show config object

    config fields​

    • id string

      Unique identifier for the config.

    • name string

      Unique name for the config.

    • retry_count number

      Number of retry attempts.

    • timeout_ms number

      Timeout in milliseconds.

Result​

success number
Indicates whether the call was successful. 1 if successful, 0 if not.

new_team boolean

Indicates whether a new team was created.

team object

The contents of the team.

Show team object

team fields​

  • id string

    Unique identifier for the team.

  • name string

    Unique name for the team.

  • members array<object>

    Members belonging to the team.

    Show member object

    member fields​

    • id string

      Unique identifier for the member.

    • email string

      Email address of the member.

    • role string

      Role of the member within the team.

  • config object

    Configuration object.

    Show config object

    config fields​

    • id string

      Unique identifier for the config.

    • name string

      Unique name for the config.

    • retry_count number

      Number of retry attempts.

    • timeout_ms number

      Timeout in milliseconds.

Errors​

Error code: 2000

  • msg

    "Bad team member not found"

Error code: 4000

Error for missing team member injured

  • msg

    "Bad data"

  • data

    "Data was missing

Examples​

ListTeamExample

List team example lists the entire team

Request​

{
  "params": [
    {
      "name": "limit",
      "value": 1
    }
  ]
}

Response​

{
  "id": 7,
  "name": "fluffy",
  "tag": "poodle"
}