POST api/FAAB/GetGlobalBidGroupUsingRef

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SessionID	string	None.
PrimaryPurposeCode	integer	None.
GlobalBidGroupID	integer	None.
GlobalBidGroupRef	string	None.
PositionFilter	string	None.
NFLTeamFilter	string	None.
SearchText	string	None.
SortOrderColumn	string	None.
SortDirection	string	None.
CurrentPageNumber	integer	None.
GlobalBidGroup	GlobalBidGroup	None.
OrderByUsersSortOrder	boolean	None.
HideProposedLeagueBidGroupsWithNoAvailableRequestedPlayers	boolean	None.
RedraftDynastyFilterValue	integer	None.
RosterFormatFilterValue	integer	None.
LeagueID	integer	None.
PlayerID	string	None.
BidAmount	integer	None.
DropPlayerList	string	None.
ExcludeFromBidGroupCreation	boolean	None.
RequestedPlayers	string	None.
DropPlayers	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SessionID": "sample string 1",
  "PrimaryPurposeCode": 2,
  "GlobalBidGroupID": 3,
  "GlobalBidGroupRef": "sample string 4",
  "PositionFilter": "sample string 5",
  "NFLTeamFilter": "sample string 6",
  "SearchText": "sample string 7",
  "SortOrderColumn": "sample string 8",
  "SortDirection": "sample string 9",
  "CurrentPageNumber": 10,
  "GlobalBidGroup": {
    "GlobalBidGroupID": 1,
    "GlobalBidGroupRef": "sample string 2",
    "SiteUserID": 3,
    "NFLWeek": 4,
    "PrimaryPurposeCode": 5,
    "RedraftDynastyFilter": 0,
    "RosterFormatFilter": 0,
    "LeagueBidGroupsCreated": true,
    "GlobalBidGroupRequestedPlayers": [
      {
        "GlobalBidGroupID": 1,
        "PlayerID": "sample string 2",
        "PrimaryPlayer": true,
        "Priority": 4,
        "BidAmount": 5,
        "FirstName": "sample string 6",
        "LastName": "sample string 7",
        "PositionCode": "sample string 8",
        "NFLTeam": "sample string 9",
        "NumLeaguesAvailableIn": 10,
        "PlayerName": "sample string 7, sample string 6 sample string 9 (sample string 8)",
        "PlayingBeforeSecondFAABLocks": true,
        "GameDay": "sample string 12"
      },
      {
        "GlobalBidGroupID": 1,
        "PlayerID": "sample string 2",
        "PrimaryPlayer": true,
        "Priority": 4,
        "BidAmount": 5,
        "FirstName": "sample string 6",
        "LastName": "sample string 7",
        "PositionCode": "sample string 8",
        "NFLTeam": "sample string 9",
        "NumLeaguesAvailableIn": 10,
        "PlayerName": "sample string 7, sample string 6 sample string 9 (sample string 8)",
        "PlayingBeforeSecondFAABLocks": true,
        "GameDay": "sample string 12"
      }
    ],
    "GlobalBidGroupDropPlayers": [
      {
        "GlobalBidGroupID": 1,
        "PlayerID": "sample string 2",
        "Priority": 3,
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PositionCode": "sample string 6",
        "NFLTeam": "sample string 7",
        "NumLeaguesOnUsersTeamRoster": 8,
        "PlayerName": "sample string 5, sample string 4 sample string 7 (sample string 6)"
      },
      {
        "GlobalBidGroupID": 1,
        "PlayerID": "sample string 2",
        "Priority": 3,
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PositionCode": "sample string 6",
        "NFLTeam": "sample string 7",
        "NumLeaguesOnUsersTeamRoster": 8,
        "PlayerName": "sample string 5, sample string 4 sample string 7 (sample string 6)"
      }
    ]
  },
  "OrderByUsersSortOrder": true,
  "HideProposedLeagueBidGroupsWithNoAvailableRequestedPlayers": true,
  "RedraftDynastyFilterValue": 13,
  "RosterFormatFilterValue": 14,
  "LeagueID": 15,
  "PlayerID": "sample string 16",
  "BidAmount": 17,
  "DropPlayerList": "sample string 18",
  "ExcludeFromBidGroupCreation": true,
  "RequestedPlayers": "sample string 20",
  "DropPlayers": "sample string 21"
}

text/html

Sample:

{"SessionID":"sample string 1","PrimaryPurposeCode":2,"GlobalBidGroupID":3,"GlobalBidGroupRef":"sample string 4","PositionFilter":"sample string 5","NFLTeamFilter":"sample string 6","SearchText":"sample string 7","SortOrderColumn":"sample string 8","SortDirection":"sample string 9","CurrentPageNumber":10,"GlobalBidGroup":{"GlobalBidGroupID":1,"GlobalBidGroupRef":"sample string 2","SiteUserID":3,"NFLWeek":4,"PrimaryPurposeCode":5,"RedraftDynastyFilter":0,"RosterFormatFilter":0,"LeagueBidGroupsCreated":true,"GlobalBidGroupRequestedPlayers":[{"GlobalBidGroupID":1,"PlayerID":"sample string 2","PrimaryPlayer":true,"Priority":4,"BidAmount":5,"FirstName":"sample string 6","LastName":"sample string 7","PositionCode":"sample string 8","NFLTeam":"sample string 9","NumLeaguesAvailableIn":10,"PlayerName":"sample string 7, sample string 6 sample string 9 (sample string 8)","PlayingBeforeSecondFAABLocks":true,"GameDay":"sample string 12"},{"GlobalBidGroupID":1,"PlayerID":"sample string 2","PrimaryPlayer":true,"Priority":4,"BidAmount":5,"FirstName":"sample string 6","LastName":"sample string 7","PositionCode":"sample string 8","NFLTeam":"sample string 9","NumLeaguesAvailableIn":10,"PlayerName":"sample string 7, sample string 6 sample string 9 (sample string 8)","PlayingBeforeSecondFAABLocks":true,"GameDay":"sample string 12"}],"GlobalBidGroupDropPlayers":[{"GlobalBidGroupID":1,"PlayerID":"sample string 2","Priority":3,"FirstName":"sample string 4","LastName":"sample string 5","PositionCode":"sample string 6","NFLTeam":"sample string 7","NumLeaguesOnUsersTeamRoster":8,"PlayerName":"sample string 5, sample string 4 sample string 7 (sample string 6)"},{"GlobalBidGroupID":1,"PlayerID":"sample string 2","Priority":3,"FirstName":"sample string 4","LastName":"sample string 5","PositionCode":"sample string 6","NFLTeam":"sample string 7","NumLeaguesOnUsersTeamRoster":8,"PlayerName":"sample string 5, sample string 4 sample string 7 (sample string 6)"}]},"OrderByUsersSortOrder":true,"HideProposedLeagueBidGroupsWithNoAvailableRequestedPlayers":true,"RedraftDynastyFilterValue":13,"RosterFormatFilterValue":14,"LeagueID":15,"PlayerID":"sample string 16","BidAmount":17,"DropPlayerList":"sample string 18","ExcludeFromBidGroupCreation":true,"RequestedPlayers":"sample string 20","DropPlayers":"sample string 21"}

application/xml, text/xml

Sample:

<GlobalBidGroupInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FantasyCoverage.BusinessObjects">
  <BidAmount>17</BidAmount>
  <CurrentPageNumber>10</CurrentPageNumber>
  <DropPlayerList>sample string 18</DropPlayerList>
  <DropPlayers>sample string 21</DropPlayers>
  <ExcludeFromBidGroupCreation>true</ExcludeFromBidGroupCreation>
  <GlobalBidGroup>
    <GlobalBidGroupDropPlayers>
      <GlobalBidGroupDropPlayer>
        <FirstName>sample string 4</FirstName>
        <GlobalBidGroupID>1</GlobalBidGroupID>
        <LastName>sample string 5</LastName>
        <NFLTeam>sample string 7</NFLTeam>
        <NumLeaguesOnUsersTeamRoster>8</NumLeaguesOnUsersTeamRoster>
        <PlayerID>sample string 2</PlayerID>
        <PositionCode>sample string 6</PositionCode>
        <Priority>3</Priority>
      </GlobalBidGroupDropPlayer>
      <GlobalBidGroupDropPlayer>
        <FirstName>sample string 4</FirstName>
        <GlobalBidGroupID>1</GlobalBidGroupID>
        <LastName>sample string 5</LastName>
        <NFLTeam>sample string 7</NFLTeam>
        <NumLeaguesOnUsersTeamRoster>8</NumLeaguesOnUsersTeamRoster>
        <PlayerID>sample string 2</PlayerID>
        <PositionCode>sample string 6</PositionCode>
        <Priority>3</Priority>
      </GlobalBidGroupDropPlayer>
    </GlobalBidGroupDropPlayers>
    <GlobalBidGroupID>1</GlobalBidGroupID>
    <GlobalBidGroupRef>sample string 2</GlobalBidGroupRef>
    <GlobalBidGroupRequestedPlayers>
      <GlobalBidGroupRequestedPlayer>
        <BidAmount>5</BidAmount>
        <FirstName>sample string 6</FirstName>
        <GameDay>sample string 12</GameDay>
        <GlobalBidGroupID>1</GlobalBidGroupID>
        <LastName>sample string 7</LastName>
        <NFLTeam>sample string 9</NFLTeam>
        <NumLeaguesAvailableIn>10</NumLeaguesAvailableIn>
        <PlayerID>sample string 2</PlayerID>
        <PlayingBeforeSecondFAABLocks>true</PlayingBeforeSecondFAABLocks>
        <PositionCode>sample string 8</PositionCode>
        <PrimaryPlayer>true</PrimaryPlayer>
        <Priority>4</Priority>
      </GlobalBidGroupRequestedPlayer>
      <GlobalBidGroupRequestedPlayer>
        <BidAmount>5</BidAmount>
        <FirstName>sample string 6</FirstName>
        <GameDay>sample string 12</GameDay>
        <GlobalBidGroupID>1</GlobalBidGroupID>
        <LastName>sample string 7</LastName>
        <NFLTeam>sample string 9</NFLTeam>
        <NumLeaguesAvailableIn>10</NumLeaguesAvailableIn>
        <PlayerID>sample string 2</PlayerID>
        <PlayingBeforeSecondFAABLocks>true</PlayingBeforeSecondFAABLocks>
        <PositionCode>sample string 8</PositionCode>
        <PrimaryPlayer>true</PrimaryPlayer>
        <Priority>4</Priority>
      </GlobalBidGroupRequestedPlayer>
    </GlobalBidGroupRequestedPlayers>
    <LeagueBidGroupsCreated>true</LeagueBidGroupsCreated>
    <NFLWeek>4</NFLWeek>
    <PrimaryPurposeCode>5</PrimaryPurposeCode>
    <RedraftDynastyFilter>AllLeagues</RedraftDynastyFilter>
    <RosterFormatFilter>AllLeagues</RosterFormatFilter>
    <SiteUserID>3</SiteUserID>
  </GlobalBidGroup>
  <GlobalBidGroupID>3</GlobalBidGroupID>
  <GlobalBidGroupRef>sample string 4</GlobalBidGroupRef>
  <HideProposedLeagueBidGroupsWithNoAvailableRequestedPlayers>true</HideProposedLeagueBidGroupsWithNoAvailableRequestedPlayers>
  <LeagueID>15</LeagueID>
  <NFLTeamFilter>sample string 6</NFLTeamFilter>
  <OrderByUsersSortOrder>true</OrderByUsersSortOrder>
  <PlayerID>sample string 16</PlayerID>
  <PositionFilter>sample string 5</PositionFilter>
  <PrimaryPurposeCode>2</PrimaryPurposeCode>
  <RedraftDynastyFilterValue>13</RedraftDynastyFilterValue>
  <RequestedPlayers>sample string 20</RequestedPlayers>
  <RosterFormatFilterValue>14</RosterFormatFilterValue>
  <SearchText>sample string 7</SearchText>
  <SessionID>sample string 1</SessionID>
  <SortDirection>sample string 9</SortDirection>
  <SortOrderColumn>sample string 8</SortOrderColumn>
</GlobalBidGroupInputModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GlobalBidGroupInputModel'.

Response Information

Resource Description

ResponseModel

Name	Type	Additional information
Message	string	None.
Status	boolean	None.
Data	Object	None.
ResultCode	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "Status": true,
  "Data": {},
  "ResultCode": 4
}

text/html

Sample:

{"Message":"sample string 1","Status":true,"Data":{},"ResultCode":4}

application/xml, text/xml

Sample:

<ResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FantasyCoverage.BusinessObjects">
  <Data />
  <Message>sample string 1</Message>
  <ResultCode>4</ResultCode>
  <Status>true</Status>
</ResponseModel>