Search selectable Scenario Lab athletes

curl --request GET \
  --url http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-QA-Lab-Admin-Id: <x-qa-lab-admin-id>' \
  --header 'X-QA-Lab-Nonce: <x-qa-lab-nonce>' \
  --header 'X-QA-Lab-Permission: <x-qa-lab-permission>' \
  --header 'X-QA-Lab-Signature: <api-key>' \
  --header 'X-QA-Lab-Timestamp: <x-qa-lab-timestamp>'

import requests

url = "http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes"

headers = {
    "X-API-KEY": "<api-key>",
    "X-QA-Lab-Admin-Id": "<x-qa-lab-admin-id>",
    "X-QA-Lab-Timestamp": "<x-qa-lab-timestamp>",
    "X-QA-Lab-Nonce": "<x-qa-lab-nonce>",
    "X-QA-Lab-Permission": "<x-qa-lab-permission>",
    "X-QA-Lab-Signature": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-QA-Lab-Admin-Id': '<x-qa-lab-admin-id>',
    'X-QA-Lab-Timestamp': '<x-qa-lab-timestamp>',
    'X-QA-Lab-Nonce': '<x-qa-lab-nonce>',
    'X-QA-Lab-Permission': '<x-qa-lab-permission>',
    'X-QA-Lab-Signature': '<api-key>'
  }
};

fetch('http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>",
    "X-QA-Lab-Admin-Id: <x-qa-lab-admin-id>",
    "X-QA-Lab-Nonce: <x-qa-lab-nonce>",
    "X-QA-Lab-Permission: <x-qa-lab-permission>",
    "X-QA-Lab-Signature: <api-key>",
    "X-QA-Lab-Timestamp: <x-qa-lab-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("X-QA-Lab-Admin-Id", "<x-qa-lab-admin-id>")
	req.Header.Add("X-QA-Lab-Timestamp", "<x-qa-lab-timestamp>")
	req.Header.Add("X-QA-Lab-Nonce", "<x-qa-lab-nonce>")
	req.Header.Add("X-QA-Lab-Permission", "<x-qa-lab-permission>")
	req.Header.Add("X-QA-Lab-Signature", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes")
  .header("X-API-KEY", "<api-key>")
  .header("X-QA-Lab-Admin-Id", "<x-qa-lab-admin-id>")
  .header("X-QA-Lab-Timestamp", "<x-qa-lab-timestamp>")
  .header("X-QA-Lab-Nonce", "<x-qa-lab-nonce>")
  .header("X-QA-Lab-Permission", "<x-qa-lab-permission>")
  .header("X-QA-Lab-Signature", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-QA-Lab-Admin-Id"] = '<x-qa-lab-admin-id>'
request["X-QA-Lab-Timestamp"] = '<x-qa-lab-timestamp>'
request["X-QA-Lab-Nonce"] = '<x-qa-lab-nonce>'
request["X-QA-Lab-Permission"] = '<x-qa-lab-permission>'
request["X-QA-Lab-Signature"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 101,
      "name": "Jordan Smith",
      "email": "jordan@example.test",
      "role": "athlete",
      "status": "A",
      "is_test_account": true
    }
  ],
  "meta": {
    "per_page": 25,
    "next_cursor": "<string>",
    "previous_cursor": "<string>",
    "has_more": false
  }
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {}
}

GET

internal

qa-scenario-lab

athletes

Search selectable Scenario Lab athletes

curl --request GET \
  --url http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-QA-Lab-Admin-Id: <x-qa-lab-admin-id>' \
  --header 'X-QA-Lab-Nonce: <x-qa-lab-nonce>' \
  --header 'X-QA-Lab-Permission: <x-qa-lab-permission>' \
  --header 'X-QA-Lab-Signature: <api-key>' \
  --header 'X-QA-Lab-Timestamp: <x-qa-lab-timestamp>'

import requests

url = "http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes"

headers = {
    "X-API-KEY": "<api-key>",
    "X-QA-Lab-Admin-Id": "<x-qa-lab-admin-id>",
    "X-QA-Lab-Timestamp": "<x-qa-lab-timestamp>",
    "X-QA-Lab-Nonce": "<x-qa-lab-nonce>",
    "X-QA-Lab-Permission": "<x-qa-lab-permission>",
    "X-QA-Lab-Signature": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-QA-Lab-Admin-Id': '<x-qa-lab-admin-id>',
    'X-QA-Lab-Timestamp': '<x-qa-lab-timestamp>',
    'X-QA-Lab-Nonce': '<x-qa-lab-nonce>',
    'X-QA-Lab-Permission': '<x-qa-lab-permission>',
    'X-QA-Lab-Signature': '<api-key>'
  }
};

fetch('http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>",
    "X-QA-Lab-Admin-Id: <x-qa-lab-admin-id>",
    "X-QA-Lab-Nonce: <x-qa-lab-nonce>",
    "X-QA-Lab-Permission: <x-qa-lab-permission>",
    "X-QA-Lab-Signature: <api-key>",
    "X-QA-Lab-Timestamp: <x-qa-lab-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("X-QA-Lab-Admin-Id", "<x-qa-lab-admin-id>")
	req.Header.Add("X-QA-Lab-Timestamp", "<x-qa-lab-timestamp>")
	req.Header.Add("X-QA-Lab-Nonce", "<x-qa-lab-nonce>")
	req.Header.Add("X-QA-Lab-Permission", "<x-qa-lab-permission>")
	req.Header.Add("X-QA-Lab-Signature", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes")
  .header("X-API-KEY", "<api-key>")
  .header("X-QA-Lab-Admin-Id", "<x-qa-lab-admin-id>")
  .header("X-QA-Lab-Timestamp", "<x-qa-lab-timestamp>")
  .header("X-QA-Lab-Nonce", "<x-qa-lab-nonce>")
  .header("X-QA-Lab-Permission", "<x-qa-lab-permission>")
  .header("X-QA-Lab-Signature", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost/mogl/mogl-backend/api/internal/qa-scenario-lab/athletes")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-QA-Lab-Admin-Id"] = '<x-qa-lab-admin-id>'
request["X-QA-Lab-Timestamp"] = '<x-qa-lab-timestamp>'
request["X-QA-Lab-Nonce"] = '<x-qa-lab-nonce>'
request["X-QA-Lab-Permission"] = '<x-qa-lab-permission>'
request["X-QA-Lab-Signature"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": 101,
      "name": "Jordan Smith",
      "email": "jordan@example.test",
      "role": "athlete",
      "status": "A",
      "is_test_account": true
    }
  ],
  "meta": {
    "per_page": 25,
    "next_cursor": "<string>",
    "previous_cursor": "<string>",
    "has_more": false
  }
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {}
}

Authorizations

X-API-KEY

string

header

required

Server-to-Server API Key for internal/lambda/cron calls

X-QA-Lab-Signature

string

header

required

HMAC-SHA256 signature for a one-use, short-lived Back Office administrator envelope. Used together with the dedicated X-API-KEY credential and the signed administrator, timestamp, nonce, and permission headers.

Headers

X-API-KEY

string

required

Dedicated QA Scenario Lab service credential.

X-QA-Lab-Admin-Id

integer

required

Positive initiating Back Office administrator ID included in the signature.

Required range: x >= 1

Example:

42

X-QA-Lab-Timestamp

integer<int64>

required

Ten-digit Unix timestamp. Default maximum age is 300 seconds.

Example:

1791194024

X-QA-Lab-Nonce

string<uuid>

required

One-use UUID included in the signature.

X-QA-Lab-Permission

enum<string>

required

Signed permission claim.

Available options:

qa_scenario_lab

X-QA-Lab-Signature

string

required

Lowercase hexadecimal HMAC-SHA256 of the canonical request envelope.

Required string length: 64

Pattern: ^[a-f0-9]{64}$

Query Parameters

string

Maximum string length: 100

cursor

string

Maximum string length: 2048

limit

integer

default:25

Required range: 1 <= x <= 100

Response

Cursor-paginated selectable athletes.

data

object[]

required

Show child attributes

Core API

University API

Notifications API

Search selectable Scenario Lab athletes

Authorizations

Headers

Query Parameters

Response