Find available deals - MOGL Developer Docs

Find available deals

curl --request POST \
  --url http://localhost/mogl/mogl-backend/api/findDeals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sort_order": "invited",
  "invited_only": "No",
  "school_specific": "No",
  "filterByMinPrice": 100,
  "filterByMaxPrice": 10000,
  "filterCategory": [],
  "filterByLocation": null,
  "filterByPaymentMode": null,
  "filterByJobTitle": [],
  "filterByLatLong": [],
  "filterByDistanceInMiles": 25,
  "allow_private": "Y",
  "job_id": 1,
  "serviceId": 1,
  "type": "All",
  "athlt_university_id": 1
}
'

import requests

url = "http://localhost/mogl/mogl-backend/api/findDeals"

payload = {
    "sort_order": "invited",
    "invited_only": "No",
    "school_specific": "No",
    "filterByMinPrice": 100,
    "filterByMaxPrice": 10000,
    "filterCategory": [],
    "filterByLocation": None,
    "filterByPaymentMode": None,
    "filterByJobTitle": [],
    "filterByLatLong": [],
    "filterByDistanceInMiles": 25,
    "allow_private": "Y",
    "job_id": 1,
    "serviceId": 1,
    "type": "All",
    "athlt_university_id": 1
}
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({
    sort_order: 'invited',
    invited_only: 'No',
    school_specific: 'No',
    filterByMinPrice: 100,
    filterByMaxPrice: 10000,
    filterCategory: [],
    filterByLocation: null,
    filterByPaymentMode: null,
    filterByJobTitle: [],
    filterByLatLong: [],
    filterByDistanceInMiles: 25,
    allow_private: 'Y',
    job_id: 1,
    serviceId: 1,
    type: 'All',
    athlt_university_id: 1
  })
};

fetch('http://localhost/mogl/mogl-backend/api/findDeals', 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/findDeals",
  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([
    'sort_order' => 'invited',
    'invited_only' => 'No',
    'school_specific' => 'No',
    'filterByMinPrice' => 100,
    'filterByMaxPrice' => 10000,
    'filterCategory' => [
        
    ],
    'filterByLocation' => null,
    'filterByPaymentMode' => null,
    'filterByJobTitle' => [
        
    ],
    'filterByLatLong' => [
        
    ],
    'filterByDistanceInMiles' => 25,
    'allow_private' => 'Y',
    'job_id' => 1,
    'serviceId' => 1,
    'type' => 'All',
    'athlt_university_id' => 1
  ]),
  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/findDeals"

	payload := strings.NewReader("{\n  \"sort_order\": \"invited\",\n  \"invited_only\": \"No\",\n  \"school_specific\": \"No\",\n  \"filterByMinPrice\": 100,\n  \"filterByMaxPrice\": 10000,\n  \"filterCategory\": [],\n  \"filterByLocation\": null,\n  \"filterByPaymentMode\": null,\n  \"filterByJobTitle\": [],\n  \"filterByLatLong\": [],\n  \"filterByDistanceInMiles\": 25,\n  \"allow_private\": \"Y\",\n  \"job_id\": 1,\n  \"serviceId\": 1,\n  \"type\": \"All\",\n  \"athlt_university_id\": 1\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/findDeals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sort_order\": \"invited\",\n  \"invited_only\": \"No\",\n  \"school_specific\": \"No\",\n  \"filterByMinPrice\": 100,\n  \"filterByMaxPrice\": 10000,\n  \"filterCategory\": [],\n  \"filterByLocation\": null,\n  \"filterByPaymentMode\": null,\n  \"filterByJobTitle\": [],\n  \"filterByLatLong\": [],\n  \"filterByDistanceInMiles\": 25,\n  \"allow_private\": \"Y\",\n  \"job_id\": 1,\n  \"serviceId\": 1,\n  \"type\": \"All\",\n  \"athlt_university_id\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"sort_order\": \"invited\",\n  \"invited_only\": \"No\",\n  \"school_specific\": \"No\",\n  \"filterByMinPrice\": 100,\n  \"filterByMaxPrice\": 10000,\n  \"filterCategory\": [],\n  \"filterByLocation\": null,\n  \"filterByPaymentMode\": null,\n  \"filterByJobTitle\": [],\n  \"filterByLatLong\": [],\n  \"filterByDistanceInMiles\": 25,\n  \"allow_private\": \"Y\",\n  \"job_id\": 1,\n  \"serviceId\": 1,\n  \"type\": \"All\",\n  \"athlt_university_id\": 1\n}"

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

POST

/

findDeals

Find available deals

curl --request POST \
  --url http://localhost/mogl/mogl-backend/api/findDeals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sort_order": "invited",
  "invited_only": "No",
  "school_specific": "No",
  "filterByMinPrice": 100,
  "filterByMaxPrice": 10000,
  "filterCategory": [],
  "filterByLocation": null,
  "filterByPaymentMode": null,
  "filterByJobTitle": [],
  "filterByLatLong": [],
  "filterByDistanceInMiles": 25,
  "allow_private": "Y",
  "job_id": 1,
  "serviceId": 1,
  "type": "All",
  "athlt_university_id": 1
}
'

import requests

url = "http://localhost/mogl/mogl-backend/api/findDeals"

payload = {
    "sort_order": "invited",
    "invited_only": "No",
    "school_specific": "No",
    "filterByMinPrice": 100,
    "filterByMaxPrice": 10000,
    "filterCategory": [],
    "filterByLocation": None,
    "filterByPaymentMode": None,
    "filterByJobTitle": [],
    "filterByLatLong": [],
    "filterByDistanceInMiles": 25,
    "allow_private": "Y",
    "job_id": 1,
    "serviceId": 1,
    "type": "All",
    "athlt_university_id": 1
}
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({
    sort_order: 'invited',
    invited_only: 'No',
    school_specific: 'No',
    filterByMinPrice: 100,
    filterByMaxPrice: 10000,
    filterCategory: [],
    filterByLocation: null,
    filterByPaymentMode: null,
    filterByJobTitle: [],
    filterByLatLong: [],
    filterByDistanceInMiles: 25,
    allow_private: 'Y',
    job_id: 1,
    serviceId: 1,
    type: 'All',
    athlt_university_id: 1
  })
};

fetch('http://localhost/mogl/mogl-backend/api/findDeals', 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/findDeals",
  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([
    'sort_order' => 'invited',
    'invited_only' => 'No',
    'school_specific' => 'No',
    'filterByMinPrice' => 100,
    'filterByMaxPrice' => 10000,
    'filterCategory' => [
        
    ],
    'filterByLocation' => null,
    'filterByPaymentMode' => null,
    'filterByJobTitle' => [
        
    ],
    'filterByLatLong' => [
        
    ],
    'filterByDistanceInMiles' => 25,
    'allow_private' => 'Y',
    'job_id' => 1,
    'serviceId' => 1,
    'type' => 'All',
    'athlt_university_id' => 1
  ]),
  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/findDeals"

	payload := strings.NewReader("{\n  \"sort_order\": \"invited\",\n  \"invited_only\": \"No\",\n  \"school_specific\": \"No\",\n  \"filterByMinPrice\": 100,\n  \"filterByMaxPrice\": 10000,\n  \"filterCategory\": [],\n  \"filterByLocation\": null,\n  \"filterByPaymentMode\": null,\n  \"filterByJobTitle\": [],\n  \"filterByLatLong\": [],\n  \"filterByDistanceInMiles\": 25,\n  \"allow_private\": \"Y\",\n  \"job_id\": 1,\n  \"serviceId\": 1,\n  \"type\": \"All\",\n  \"athlt_university_id\": 1\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/findDeals")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sort_order\": \"invited\",\n  \"invited_only\": \"No\",\n  \"school_specific\": \"No\",\n  \"filterByMinPrice\": 100,\n  \"filterByMaxPrice\": 10000,\n  \"filterCategory\": [],\n  \"filterByLocation\": null,\n  \"filterByPaymentMode\": null,\n  \"filterByJobTitle\": [],\n  \"filterByLatLong\": [],\n  \"filterByDistanceInMiles\": 25,\n  \"allow_private\": \"Y\",\n  \"job_id\": 1,\n  \"serviceId\": 1,\n  \"type\": \"All\",\n  \"athlt_university_id\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"sort_order\": \"invited\",\n  \"invited_only\": \"No\",\n  \"school_specific\": \"No\",\n  \"filterByMinPrice\": 100,\n  \"filterByMaxPrice\": 10000,\n  \"filterCategory\": [],\n  \"filterByLocation\": null,\n  \"filterByPaymentMode\": null,\n  \"filterByJobTitle\": [],\n  \"filterByLatLong\": [],\n  \"filterByDistanceInMiles\": 25,\n  \"allow_private\": \"Y\",\n  \"job_id\": 1,\n  \"serviceId\": 1,\n  \"type\": \"All\",\n  \"athlt_university_id\": 1\n}"

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

Authorizations

Authorization

string

header

required

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

Query Parameters

page

integer

Page number

Example:

1

limit

integer

Items per page

Example:

10

page_limit

integer

Alias for limit

Example:

10

Body

application/json

sort_order

enum<string> | null

Available options:

name_asc,

name_desc,

pay_high,

pay_low,

invited,

recommended,

location_nearest

Example:

"invited"

invited_only

enum<string> | null

Available options:

Yes,

No

Example:

"No"

school_specific

enum<string> | null

Available options:

Yes,

No

Example:

"No"

filterByMinPrice

number | null

Example:

100

filterByMaxPrice

number | null

Example:

10000

filterCategory

integer[] | null

Category IDs

Example:

[]

filterByLocation

string | null

Example:

null

filterByPaymentMode

enum<string> | null

Available options:

Cash,

Product

Example:

null

filterByJobTitle

string[] | null

Exact job title match

Example:

[]

filterByLatLong

number[] | null

[longitude, latitude]

Example:

[]

filterByDistanceInMiles

number | null

Example:

25

allow_private

string | null

Example:

"Y"

job_id

integer | null

Filter to a single job

Example:

1

serviceId

integer | null

Filter to a fan service request

Example:

1

type

string | null

Filter type

Example:

"All"

athlt_university_id

integer | null

Athlete university ID

Example:

1

Response

200

Available deals