GET v3/me/leagues/{id}/freeagents

PARTICIPANT — the league free-agent pool (the SPA league freeagent page, member-visible there). Wraps the page-pure FreeAgentApi.Initialize league branch VERBATIM (it already guest-gates and shapes per-viewer affordances: ShowJoinBtn for the caller, CanInviteToTeam only for a captain in the league, contact visibility per free agent's own opt-in).

Request Information

Parameters

Name	Description	Additional information
id	league id	Define this parameter in the request URI.

Response Information

No documentation available.

Response body formats

application/json, text/json

Sample:

{
  "freeAgents": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "memberId": "sample string 3",
      "memberName": "sample string 4",
      "memberPhoto": "sample string 5",
      "text": "sample string 6",
      "paid": true,
      "isInAllDivision": true
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "memberId": "sample string 3",
      "memberName": "sample string 4",
      "memberPhoto": "sample string 5",
      "text": "sample string 6",
      "paid": true,
      "isInAllDivision": true
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "memberId": "sample string 3",
      "memberName": "sample string 4",
      "memberPhoto": "sample string 5",
      "text": "sample string 6",
      "paid": true,
      "isInAllDivision": true
    }
  ],
  "isSportAdmin": true,
  "isSchoolAdmin": true,
  "divisionIDForPage": "sample string 3",
  "canInviteToTeam": true,
  "canShowWillingPlay": true,
  "leagueNeedPay": true,
  "leagueID": "sample string 7",
  "schoolId": "sample string 8",
  "sportId": "sample string 9",
  "showJoinBtn": true,
  "memberId": "sample string 11",
  "memberName": "sample string 12",
  "freeagentFeeAmount": 13.1,
  "showRequirePaymentAlert": true,
  "freeAgentPolicy": "sample string 15",
  "isCanJoinAsFreeAgent": true,
  "enableConversation": true,
  "freeagentOnlyAcceptPackages": true,
  "canAddDivision": true
}

application/xml, text/xml

Sample:

<FreeAgentInitVMOutVO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/imLeagues.Internal.API.VO.Output.FreeAgent">
  <CanAddDivision>true</CanAddDivision>
  <CanInviteToTeam>true</CanInviteToTeam>
  <CanShowWillingPlay>true</CanShowWillingPlay>
  <DivisionIDForPage>sample string 3</DivisionIDForPage>
  <EnableConversation>true</EnableConversation>
  <FreeAgentPolicy>sample string 15</FreeAgentPolicy>
  <FreeAgents>
    <FreeAgentInfo>
      <Id>sample string 1</Id>
      <IsInAllDivision>true</IsInAllDivision>
      <MemberId>sample string 3</MemberId>
      <MemberName>sample string 4</MemberName>
      <MemberPhoto>sample string 5</MemberPhoto>
      <Name>sample string 2</Name>
      <Paid>true</Paid>
      <Text>sample string 6</Text>
    </FreeAgentInfo>
    <FreeAgentInfo>
      <Id>sample string 1</Id>
      <IsInAllDivision>true</IsInAllDivision>
      <MemberId>sample string 3</MemberId>
      <MemberName>sample string 4</MemberName>
      <MemberPhoto>sample string 5</MemberPhoto>
      <Name>sample string 2</Name>
      <Paid>true</Paid>
      <Text>sample string 6</Text>
    </FreeAgentInfo>
    <FreeAgentInfo>
      <Id>sample string 1</Id>
      <IsInAllDivision>true</IsInAllDivision>
      <MemberId>sample string 3</MemberId>
      <MemberName>sample string 4</MemberName>
      <MemberPhoto>sample string 5</MemberPhoto>
      <Name>sample string 2</Name>
      <Paid>true</Paid>
      <Text>sample string 6</Text>
    </FreeAgentInfo>
  </FreeAgents>
  <FreeagentFeeAmount>13.1</FreeagentFeeAmount>
  <FreeagentOnlyAcceptPackages>true</FreeagentOnlyAcceptPackages>
  <IsCanJoinAsFreeAgent>true</IsCanJoinAsFreeAgent>
  <IsSchoolAdmin>true</IsSchoolAdmin>
  <IsSportAdmin>true</IsSportAdmin>
  <LeagueID>sample string 7</LeagueID>
  <LeagueNeedPay>true</LeagueNeedPay>
  <SchoolId>sample string 8</SchoolId>
  <ShowJoinBtn>true</ShowJoinBtn>
  <ShowRequirePaymentAlert>true</ShowRequirePaymentAlert>
  <SportId>sample string 9</SportId>
  <memberId>sample string 11</memberId>
  <memberName>sample string 12</memberName>
</FreeAgentInitVMOutVO>

multipart/form-data

Sample:

Sample not available.