Retire league policy membership

curl --request POST \
  --url https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Retired by user request."
}
'

import requests

url = "https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire"

payload = { "reason": "Retired by user request." }
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({reason: 'Retired by user request.'})
};

fetch('https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire', 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 => "https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire",
  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([
    'reason' => 'Retired by user request.'
  ]),
  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 := "https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire"

	payload := strings.NewReader("{\n  \"reason\": \"Retired by user request.\"\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("https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Retired by user request.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Retired by user request.\"\n}"

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

{
  "id": "<string>",
  "league": {
    "name": "<string>",
    "commissioner_key": "<string>",
    "id": "<string>",
    "game": {
      "name": "<string>",
      "owner_user_id": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "coworld_name": "<string>",
      "description": "<string>",
      "notes": "<string>",
      "default_league_id": "<string>",
      "coworld_id": "<string>",
      "canonical_coworld_id": "<string>",
      "coworld_tags": [
        "<string>"
      ]
    },
    "mod": {
      "name": "<string>",
      "owner_user_id": "<string>",
      "id": "<string>",
      "game": {
        "name": "<string>",
        "owner_user_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "coworld_name": "<string>",
        "description": "<string>",
        "notes": "<string>",
        "default_league_id": "<string>",
        "coworld_id": "<string>",
        "canonical_coworld_id": "<string>",
        "coworld_tags": [
          "<string>"
        ]
      },
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "notes": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "logs_reporter_id": "<string>",
    "handicaps": {},
    "handicap_dynamic": {
      "max_handicap": 0.5,
      "curve": 1,
      "min_entrants": 3,
      "dominance_ratio_for_max": 3,
      "winrate_for_max": 0.85
    },
    "short_name": "<string>",
    "description": "<string>",
    "commissioner_config": {},
    "commissioner_migration_version": "<string>",
    "rounds_paused_at": "2023-11-07T05:31:56Z",
    "submissions_locked_at": "2023-11-07T05:31:56Z",
    "settings": {},
    "filler_policy_version_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "seed_policy_version_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "seed_policy_number": 123,
    "rules": {},
    "public": false,
    "hidden": false,
    "is_game_of_week": false,
    "disabled_at": "2023-11-07T05:31:56Z",
    "notes": "<string>"
  },
  "division": {
    "id": "<string>",
    "name": "<string>",
    "level": 123,
    "type": "<string>",
    "hidden": true,
    "league": {
      "name": "<string>",
      "commissioner_key": "<string>",
      "id": "<string>",
      "game": {
        "name": "<string>",
        "owner_user_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "coworld_name": "<string>",
        "description": "<string>",
        "notes": "<string>",
        "default_league_id": "<string>",
        "coworld_id": "<string>",
        "canonical_coworld_id": "<string>",
        "coworld_tags": [
          "<string>"
        ]
      },
      "mod": {
        "name": "<string>",
        "owner_user_id": "<string>",
        "id": "<string>",
        "game": {
          "name": "<string>",
          "owner_user_id": "<string>",
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "coworld_name": "<string>",
          "description": "<string>",
          "notes": "<string>",
          "default_league_id": "<string>",
          "coworld_id": "<string>",
          "canonical_coworld_id": "<string>",
          "coworld_tags": [
            "<string>"
          ]
        },
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "notes": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "logs_reporter_id": "<string>",
      "handicaps": {},
      "handicap_dynamic": {
        "max_handicap": 0.5,
        "curve": 1,
        "min_entrants": 3,
        "dominance_ratio_for_max": 3,
        "winrate_for_max": 0.85
      },
      "short_name": "<string>",
      "description": "<string>",
      "commissioner_config": {},
      "commissioner_migration_version": "<string>",
      "rounds_paused_at": "2023-11-07T05:31:56Z",
      "submissions_locked_at": "2023-11-07T05:31:56Z",
      "settings": {},
      "filler_policy_version_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "seed_policy_version_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "seed_policy_number": 123,
      "rules": {},
      "public": false,
      "hidden": false,
      "is_game_of_week": false,
      "disabled_at": "2023-11-07T05:31:56Z",
      "notes": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "archived_at": "2023-11-07T05:31:56Z",
    "round_schedule": {},
    "notes": "<string>",
    "commissioner_description": {
      "round_schedule": "<string>",
      "round_structure": "<string>",
      "leaderboard_rules": "<string>",
      "next_round": "<string>",
      "scoring_mechanics": "<string>",
      "changelog": [
        {
          "date": "<string>",
          "title": "<string>",
          "detail": "<string>",
          "category": "<string>"
        }
      ]
    }
  },
  "policy_version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "version": 123,
    "label": "<string>",
    "player_id": "<string>"
  },
  "player": {
    "id": "<string>",
    "name": "<string>",
    "avatar_url": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "status": "competing",
  "substatus": "<string>",
  "is_champion": false,
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "notes": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

league-policy-memberships

{league_policy_membership_id}

retire

Retire league policy membership

curl --request POST \
  --url https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Retired by user request."
}
'

import requests

url = "https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire"

payload = { "reason": "Retired by user request." }
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({reason: 'Retired by user request.'})
};

fetch('https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire', 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 => "https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire",
  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([
    'reason' => 'Retired by user request.'
  ]),
  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 := "https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire"

	payload := strings.NewReader("{\n  \"reason\": \"Retired by user request.\"\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("https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Retired by user request.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://softmax.com/api/observatory/v2/league-policy-memberships/{league_policy_membership_id}/retire")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Retired by user request.\"\n}"

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

{
  "id": "<string>",
  "league": {
    "name": "<string>",
    "commissioner_key": "<string>",
    "id": "<string>",
    "game": {
      "name": "<string>",
      "owner_user_id": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "coworld_name": "<string>",
      "description": "<string>",
      "notes": "<string>",
      "default_league_id": "<string>",
      "coworld_id": "<string>",
      "canonical_coworld_id": "<string>",
      "coworld_tags": [
        "<string>"
      ]
    },
    "mod": {
      "name": "<string>",
      "owner_user_id": "<string>",
      "id": "<string>",
      "game": {
        "name": "<string>",
        "owner_user_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "coworld_name": "<string>",
        "description": "<string>",
        "notes": "<string>",
        "default_league_id": "<string>",
        "coworld_id": "<string>",
        "canonical_coworld_id": "<string>",
        "coworld_tags": [
          "<string>"
        ]
      },
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "notes": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "logs_reporter_id": "<string>",
    "handicaps": {},
    "handicap_dynamic": {
      "max_handicap": 0.5,
      "curve": 1,
      "min_entrants": 3,
      "dominance_ratio_for_max": 3,
      "winrate_for_max": 0.85
    },
    "short_name": "<string>",
    "description": "<string>",
    "commissioner_config": {},
    "commissioner_migration_version": "<string>",
    "rounds_paused_at": "2023-11-07T05:31:56Z",
    "submissions_locked_at": "2023-11-07T05:31:56Z",
    "settings": {},
    "filler_policy_version_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "seed_policy_version_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "seed_policy_number": 123,
    "rules": {},
    "public": false,
    "hidden": false,
    "is_game_of_week": false,
    "disabled_at": "2023-11-07T05:31:56Z",
    "notes": "<string>"
  },
  "division": {
    "id": "<string>",
    "name": "<string>",
    "level": 123,
    "type": "<string>",
    "hidden": true,
    "league": {
      "name": "<string>",
      "commissioner_key": "<string>",
      "id": "<string>",
      "game": {
        "name": "<string>",
        "owner_user_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "coworld_name": "<string>",
        "description": "<string>",
        "notes": "<string>",
        "default_league_id": "<string>",
        "coworld_id": "<string>",
        "canonical_coworld_id": "<string>",
        "coworld_tags": [
          "<string>"
        ]
      },
      "mod": {
        "name": "<string>",
        "owner_user_id": "<string>",
        "id": "<string>",
        "game": {
          "name": "<string>",
          "owner_user_id": "<string>",
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "coworld_name": "<string>",
          "description": "<string>",
          "notes": "<string>",
          "default_league_id": "<string>",
          "coworld_id": "<string>",
          "canonical_coworld_id": "<string>",
          "coworld_tags": [
            "<string>"
          ]
        },
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "notes": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "logs_reporter_id": "<string>",
      "handicaps": {},
      "handicap_dynamic": {
        "max_handicap": 0.5,
        "curve": 1,
        "min_entrants": 3,
        "dominance_ratio_for_max": 3,
        "winrate_for_max": 0.85
      },
      "short_name": "<string>",
      "description": "<string>",
      "commissioner_config": {},
      "commissioner_migration_version": "<string>",
      "rounds_paused_at": "2023-11-07T05:31:56Z",
      "submissions_locked_at": "2023-11-07T05:31:56Z",
      "settings": {},
      "filler_policy_version_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "seed_policy_version_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "seed_policy_number": 123,
      "rules": {},
      "public": false,
      "hidden": false,
      "is_game_of_week": false,
      "disabled_at": "2023-11-07T05:31:56Z",
      "notes": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "archived_at": "2023-11-07T05:31:56Z",
    "round_schedule": {},
    "notes": "<string>",
    "commissioner_description": {
      "round_schedule": "<string>",
      "round_structure": "<string>",
      "leaderboard_rules": "<string>",
      "next_round": "<string>",
      "scoring_mechanics": "<string>",
      "changelog": [
        {
          "date": "<string>",
          "title": "<string>",
          "detail": "<string>",
          "category": "<string>"
        }
      ]
    }
  },
  "policy_version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "policy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "version": 123,
    "label": "<string>",
    "player_id": "<string>"
  },
  "player": {
    "id": "<string>",
    "name": "<string>",
    "avatar_url": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "status": "competing",
  "substatus": "<string>",
  "is_champion": false,
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "notes": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer token issued by Softmax

Path Parameters

league_policy_membership_id

string

required

League policy membership to retire.

Pattern: ^lpm_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Body

application/json

reason

string

default:Retired by user request.

Reason recorded with the retirement event.

Required string length: 1 - 1000

Response

Successful Response

string

required

League membership ID.

league

LeaguePublic · object

required

League containing this membership.

Show child attributes

division

DivisionPublic · object

required

Division where this membership is currently placed.

Show child attributes

policy_version

PolicyVersionPublic · object

required

Policy version competing through this membership.

Show child attributes

player

PlayerPublic · object | null

required

Player represented by this membership, or null when none is assigned.

Show child attributes

created_at

string<date-time>

required

Time when the membership was created.

status

enum<string>

default:competing

Current competition state of the membership.

Available options:

submitted,

qualifying,

competing,

disqualified

substatus

string | null

More specific membership state, or null when no substatus applies.

is_champion

boolean

default:false

Whether this membership is the player's active league champion.

start_time

string<date-time>

Time when this membership began.

end_time

string<date-time> | null

Time when this membership ended, or null while it remains active.

notes

string | null

Notes about the membership.

Overview

Endpoints

Retire league policy membership

Authorizations

Path Parameters

Body

Response