Read a represented athlete's profile

curl --request GET \
  --url http://localhost/mogl/mogl-backend/api/agent/athletes/{athleteId}/profile \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost/mogl/mogl-backend/api/agent/athletes/{athleteId}/profile"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost/mogl/mogl-backend/api/agent/athletes/{athleteId}/profile', 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/agent/athletes/{athleteId}/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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/agent/athletes/{athleteId}/profile"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost/mogl/mogl-backend/api/agent/athletes/{athleteId}/profile")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "id": 28550,
    "first_name": "Ayden",
    "last_name": "Syal",
    "name": "Ayden Syal",
    "email": "ayden@example.edu",
    "contact_number": "4155551809",
    "jersey_no": "15",
    "DOB": "1998-04-29",
    "location": "Berkeley, CA, USA",
    "is_private": "N",
    "sport_category_id": 12,
    "sport_category_name": "Football",
    "bio": "Junior wide receiver.",
    "highlights": "All-American NCAA D1AA 2023",
    "university_id": 340,
    "school": "University of California",
    "height": 70,
    "weight": 200,
    "skills": "Cooking, Acting, Public Speaking",
    "hat_size": "7 1/2",
    "shirt_size": "XL",
    "pants_size": "34",
    "shoes_size": "11.5",
    "gender": "Male",
    "expected_graduation_date": "2027",
    "us_citizen": "Y",
    "profile_photo": "storage/images/profile_photo/28550.png",
    "UserSocialMediaStatistics": {},
    "jobs": []
  }
}

{
  "message": "You can only manage athletes you represent.",
  "error_code": "ATHLETE_NOT_LINKED"
}

Read a represented athlete's profile

What the Edit Profile modal prefills its inputs with (ENG-1474). The counterpart to the PUT below: every field that endpoint accepts is readable here, so the modal never shows a value it cannot save back. Authorization runs through the active agent_athletes relationship, so an agent can only read an athlete on their own roster, and an athlete they do not represent is reported the same way as one that does not exist. *

The response is the same body POST /getAthleteDetail returns for the athlete’s own edit screen, produced by the same resource, so both sides share one field mapping. Two names differ from the PUT: date of birth is returned as DOB and hometown as location.
Not returned: the athlete’s password, and nothing here lets an agent reach their login.

GET

agent

athletes

{athleteId}

profile

Read a represented athlete's profile

curl --request GET \
  --url http://localhost/mogl/mogl-backend/api/agent/athletes/{athleteId}/profile \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost/mogl/mogl-backend/api/agent/athletes/{athleteId}/profile"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost/mogl/mogl-backend/api/agent/athletes/{athleteId}/profile', 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/agent/athletes/{athleteId}/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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/agent/athletes/{athleteId}/profile"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost/mogl/mogl-backend/api/agent/athletes/{athleteId}/profile")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": {
    "id": 28550,
    "first_name": "Ayden",
    "last_name": "Syal",
    "name": "Ayden Syal",
    "email": "ayden@example.edu",
    "contact_number": "4155551809",
    "jersey_no": "15",
    "DOB": "1998-04-29",
    "location": "Berkeley, CA, USA",
    "is_private": "N",
    "sport_category_id": 12,
    "sport_category_name": "Football",
    "bio": "Junior wide receiver.",
    "highlights": "All-American NCAA D1AA 2023",
    "university_id": 340,
    "school": "University of California",
    "height": 70,
    "weight": 200,
    "skills": "Cooking, Acting, Public Speaking",
    "hat_size": "7 1/2",
    "shirt_size": "XL",
    "pants_size": "34",
    "shoes_size": "11.5",
    "gender": "Male",
    "expected_graduation_date": "2027",
    "us_citizen": "Y",
    "profile_photo": "storage/images/profile_photo/28550.png",
    "UserSocialMediaStatistics": {},
    "jobs": []
  }
}

{
  "message": "You can only manage athletes you represent.",
  "error_code": "ATHLETE_NOT_LINKED"
}

Authorizations

Authorization

string

header

required

JWT Bearer token authentication. Use the /api/login endpoint to obtain a token.

Path Parameters

athleteId

integer

required

Athlete user id. Must be on the authenticated agent's roster.

Example:

28550

Query Parameters

isJob

boolean

default:false

Whether to include the athlete's full job history in jobs. Off by default here because the modal never shows it and it is the one field that grows without bound. The key is always present and always an array.

Response

Athlete profile

data

object

Show child attributes

Core API

University API

Notifications API

Read a represented athlete's profile

Authorizations

Path Parameters

Query Parameters

Response