Get represented athletes, sending the filters in a body

curl --request POST \
  --url http://localhost/mogl/mogl-backend/api/agent/athletes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "item": 10,
  "isMedia": "Y",
  "isAudience": "Y",
  "job_id": 2740,
  "sort_column": "earnings",
  "sort_order": "desc",
  "filter": {
    "client": [
      {
        "id": 28550
      }
    ],
    "tax_documents": [
      {
        "id": "approved"
      }
    ],
    "instagram": {
      "filterType": "number",
      "type": "greaterThan",
      "filter": 10000
    }
  },
  "view": "removal",
  "is_all_selected": true,
  "excluded_athlete_id": [
    28552
  ]
}
'

import requests

url = "http://localhost/mogl/mogl-backend/api/agent/athletes"

payload = {
    "page": 1,
    "item": 10,
    "isMedia": "Y",
    "isAudience": "Y",
    "job_id": 2740,
    "sort_column": "earnings",
    "sort_order": "desc",
    "filter": {
        "client": [{ "id": 28550 }],
        "tax_documents": [{ "id": "approved" }],
        "instagram": {
            "filterType": "number",
            "type": "greaterThan",
            "filter": 10000
        }
    },
    "view": "removal",
    "is_all_selected": True,
    "excluded_athlete_id": [28552]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    page: 1,
    item: 10,
    isMedia: 'Y',
    isAudience: 'Y',
    job_id: 2740,
    sort_column: 'earnings',
    sort_order: 'desc',
    filter: {
      client: [{id: 28550}],
      tax_documents: [{id: 'approved'}],
      instagram: {filterType: 'number', type: 'greaterThan', filter: 10000}
    },
    view: 'removal',
    is_all_selected: true,
    excluded_athlete_id: [28552]
  })
};

fetch('http://localhost/mogl/mogl-backend/api/agent/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/agent/athletes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'page' => 1,
    'item' => 10,
    'isMedia' => 'Y',
    'isAudience' => 'Y',
    'job_id' => 2740,
    'sort_column' => 'earnings',
    'sort_order' => 'desc',
    'filter' => [
        'client' => [
                [
                                'id' => 28550
                ]
        ],
        'tax_documents' => [
                [
                                'id' => 'approved'
                ]
        ],
        'instagram' => [
                'filterType' => 'number',
                'type' => 'greaterThan',
                'filter' => 10000
        ]
    ],
    'view' => 'removal',
    'is_all_selected' => true,
    'excluded_athlete_id' => [
        28552
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost/mogl/mogl-backend/api/agent/athletes"

	payload := strings.NewReader("{\n  \"page\": 1,\n  \"item\": 10,\n  \"isMedia\": \"Y\",\n  \"isAudience\": \"Y\",\n  \"job_id\": 2740,\n  \"sort_column\": \"earnings\",\n  \"sort_order\": \"desc\",\n  \"filter\": {\n    \"client\": [\n      {\n        \"id\": 28550\n      }\n    ],\n    \"tax_documents\": [\n      {\n        \"id\": \"approved\"\n      }\n    ],\n    \"instagram\": {\n      \"filterType\": \"number\",\n      \"type\": \"greaterThan\",\n      \"filter\": 10000\n    }\n  },\n  \"view\": \"removal\",\n  \"is_all_selected\": true,\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost/mogl/mogl-backend/api/agent/athletes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"page\": 1,\n  \"item\": 10,\n  \"isMedia\": \"Y\",\n  \"isAudience\": \"Y\",\n  \"job_id\": 2740,\n  \"sort_column\": \"earnings\",\n  \"sort_order\": \"desc\",\n  \"filter\": {\n    \"client\": [\n      {\n        \"id\": 28550\n      }\n    ],\n    \"tax_documents\": [\n      {\n        \"id\": \"approved\"\n      }\n    ],\n    \"instagram\": {\n      \"filterType\": \"number\",\n      \"type\": \"greaterThan\",\n      \"filter\": 10000\n    }\n  },\n  \"view\": \"removal\",\n  \"is_all_selected\": true,\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"page\": 1,\n  \"item\": 10,\n  \"isMedia\": \"Y\",\n  \"isAudience\": \"Y\",\n  \"job_id\": 2740,\n  \"sort_column\": \"earnings\",\n  \"sort_order\": \"desc\",\n  \"filter\": {\n    \"client\": [\n      {\n        \"id\": 28550\n      }\n    ],\n    \"tax_documents\": [\n      {\n        \"id\": \"approved\"\n      }\n    ],\n    \"instagram\": {\n      \"filterType\": \"number\",\n      \"type\": \"greaterThan\",\n      \"filter\": 10000\n    }\n  },\n  \"view\": \"removal\",\n  \"is_all_selected\": true,\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}"

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

{
  "data": [
    {
      "athlete_id": 28550,
      "profile_photo": "<string>",
      "name": "Brandon Wimbaush",
      "university": "University of Notre Dame"
    }
  ],
  "meta": {
    "total": 42
  },
  "links": {
    "next": "<string>"
  }
}

Get represented athletes, sending the filters in a body

The same roster as GET /agent/athletes, served by the same handler. It exists only so a client can send the column filters in a JSON body instead of spelling them out in a query string, which gets long once several columns are filtered at once. *

Nothing behaves differently: the parameter names, the filter shapes, the pagination and the response are identical, and a parameter may be sent in the body or the query string. Read the GET for what each one means.
Sending view: removal switches it to the Confirm Client Removal list instead (ENG-1465). That exists because Select All cannot be listed from what the grid loaded: the agent may have selected rows across pages they never opened. It resolves the selection exactly the way DELETE /agent/athletes will, taking the same filter and excluded_athlete_id, so the modal can only ever name the athletes the removal would actually take off the roster.
Rows ticked by hand do not need it. The client already has those rows and can send their ids straight to the delete.

POST

agent

athletes

Get represented athletes, sending the filters in a body

curl --request POST \
  --url http://localhost/mogl/mogl-backend/api/agent/athletes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "page": 1,
  "item": 10,
  "isMedia": "Y",
  "isAudience": "Y",
  "job_id": 2740,
  "sort_column": "earnings",
  "sort_order": "desc",
  "filter": {
    "client": [
      {
        "id": 28550
      }
    ],
    "tax_documents": [
      {
        "id": "approved"
      }
    ],
    "instagram": {
      "filterType": "number",
      "type": "greaterThan",
      "filter": 10000
    }
  },
  "view": "removal",
  "is_all_selected": true,
  "excluded_athlete_id": [
    28552
  ]
}
'

import requests

url = "http://localhost/mogl/mogl-backend/api/agent/athletes"

payload = {
    "page": 1,
    "item": 10,
    "isMedia": "Y",
    "isAudience": "Y",
    "job_id": 2740,
    "sort_column": "earnings",
    "sort_order": "desc",
    "filter": {
        "client": [{ "id": 28550 }],
        "tax_documents": [{ "id": "approved" }],
        "instagram": {
            "filterType": "number",
            "type": "greaterThan",
            "filter": 10000
        }
    },
    "view": "removal",
    "is_all_selected": True,
    "excluded_athlete_id": [28552]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    page: 1,
    item: 10,
    isMedia: 'Y',
    isAudience: 'Y',
    job_id: 2740,
    sort_column: 'earnings',
    sort_order: 'desc',
    filter: {
      client: [{id: 28550}],
      tax_documents: [{id: 'approved'}],
      instagram: {filterType: 'number', type: 'greaterThan', filter: 10000}
    },
    view: 'removal',
    is_all_selected: true,
    excluded_athlete_id: [28552]
  })
};

fetch('http://localhost/mogl/mogl-backend/api/agent/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/agent/athletes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'page' => 1,
    'item' => 10,
    'isMedia' => 'Y',
    'isAudience' => 'Y',
    'job_id' => 2740,
    'sort_column' => 'earnings',
    'sort_order' => 'desc',
    'filter' => [
        'client' => [
                [
                                'id' => 28550
                ]
        ],
        'tax_documents' => [
                [
                                'id' => 'approved'
                ]
        ],
        'instagram' => [
                'filterType' => 'number',
                'type' => 'greaterThan',
                'filter' => 10000
        ]
    ],
    'view' => 'removal',
    'is_all_selected' => true,
    'excluded_athlete_id' => [
        28552
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://localhost/mogl/mogl-backend/api/agent/athletes"

	payload := strings.NewReader("{\n  \"page\": 1,\n  \"item\": 10,\n  \"isMedia\": \"Y\",\n  \"isAudience\": \"Y\",\n  \"job_id\": 2740,\n  \"sort_column\": \"earnings\",\n  \"sort_order\": \"desc\",\n  \"filter\": {\n    \"client\": [\n      {\n        \"id\": 28550\n      }\n    ],\n    \"tax_documents\": [\n      {\n        \"id\": \"approved\"\n      }\n    ],\n    \"instagram\": {\n      \"filterType\": \"number\",\n      \"type\": \"greaterThan\",\n      \"filter\": 10000\n    }\n  },\n  \"view\": \"removal\",\n  \"is_all_selected\": true,\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost/mogl/mogl-backend/api/agent/athletes")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"page\": 1,\n  \"item\": 10,\n  \"isMedia\": \"Y\",\n  \"isAudience\": \"Y\",\n  \"job_id\": 2740,\n  \"sort_column\": \"earnings\",\n  \"sort_order\": \"desc\",\n  \"filter\": {\n    \"client\": [\n      {\n        \"id\": 28550\n      }\n    ],\n    \"tax_documents\": [\n      {\n        \"id\": \"approved\"\n      }\n    ],\n    \"instagram\": {\n      \"filterType\": \"number\",\n      \"type\": \"greaterThan\",\n      \"filter\": 10000\n    }\n  },\n  \"view\": \"removal\",\n  \"is_all_selected\": true,\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"page\": 1,\n  \"item\": 10,\n  \"isMedia\": \"Y\",\n  \"isAudience\": \"Y\",\n  \"job_id\": 2740,\n  \"sort_column\": \"earnings\",\n  \"sort_order\": \"desc\",\n  \"filter\": {\n    \"client\": [\n      {\n        \"id\": 28550\n      }\n    ],\n    \"tax_documents\": [\n      {\n        \"id\": \"approved\"\n      }\n    ],\n    \"instagram\": {\n      \"filterType\": \"number\",\n      \"type\": \"greaterThan\",\n      \"filter\": 10000\n    }\n  },\n  \"view\": \"removal\",\n  \"is_all_selected\": true,\n  \"excluded_athlete_id\": [\n    28552\n  ]\n}"

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

{
  "data": [
    {
      "athlete_id": 28550,
      "profile_photo": "<string>",
      "name": "Brandon Wimbaush",
      "university": "University of Notre Dame"
    }
  ],
  "meta": {
    "total": 42
  },
  "links": {
    "next": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

page

integer

Example:

1

item

integer

Example:

10

isMedia

enum<string>

Available options:

Y,

N

Example:

"Y"

isAudience

enum<string>

Available options:

Y,

N

Example:

"Y"

job_id

integer | null

Example:

2740

sort_column

enum<string>

Same as the GET. Ignored under view: removal.

Available options:

client,

profile,

tax_documents,

in_progress_deals,

earnings,

instagram,

tiktok,

twitter

Example:

"earnings"

sort_order

enum<string>

Available options:

asc,

desc

Example:

"desc"

filter

object

Keyed by column, same shapes the GET documents. Under view: removal this is what Select All means, so send the filter the grid is showing. Omitting it while a column is filtered widens the selection to the entire roster and the modal will name athletes the agent never saw.

Example:

{
  "client": [{ "id": 28550 }],
  "tax_documents": [{ "id": "approved" }],
  "instagram": {
    "filterType": "number",
    "type": "greaterThan",
    "filter": 10000
  }
}

view

enum<string>

Omit for the roster. removal returns only athlete_id, profile_photo, name and university, with no audience, social or activity data, which is what makes paging the whole selection cheap.

Available options:

removal

Example:

"removal"

is_all_selected

any

Whether Select All was used. The boolean, the strings true and 1, and the number 1 are all accepted, matching DELETE /agent/athletes.

Example:

true

excluded_athlete_id

integer[]

Athletes the agent unticked after Select All. Read only when is_all_selected is set, and taken out of meta.total as well as data, so the page count shrinks as the agent unticks.

Example:

[28552]

Response

200 - application/json

Roster page. Same body as GET /agent/athletes, or the four-field removal rows under view: removal, paged the same way in either case.

data

object[]

Shown for view: removal. Without it the rows are the full roster shape.

Show child attributes

Core API

University API

Notifications API

Get represented athletes, sending the filters in a body

Authorizations

Body

Response