Draft Config v2.0

Summary
Draft Config
Resource
Draft ConfigThe draft configurations of the fantasy league.
HTTP Methods
GETRetrieve Draft Config
Example
Retrieve Draft Config
XML field definitions
/draftA container element for the draft configuration.
/draft/auction_reserve_draftWhether reserve players will be included in the auction draft, as a Boolean using the values 1 and 0.
/draft/auction_to_bid_onSpecifies whether the auction will include active players only or both active and reserve players.
/draft/auction_supplemental_roundsIf the auction_to_bid_on value is active they may choose to use a supplemental draft to fill the reserve spots on their roster.
/draft/bid_time_limitThe amount of time owners will have to bid on a player, in seconds, as an integer.
/draft/dateThe date that the draft will begin, in the format YYYYMMDD.
/draft/timeThe time that the draft will begin (ET), in the format HHMM.
/draft/draft_scheduleSpecifies whether the draft has been scheduled.
/draft/nomination_time_limitThe amount of time an owner will have to nominate a player for auction, in seconds, as an integer.
/draft/order_sourceThe source of the draft pick order.
/draft/order_typeSpecifies how the order of picks will progress on round-by-round basis.
/draft/pick_emailWhether email notifications will be sent for Online Extended Drafts, as a Boolean using the values 1 and 0.
/draft/roundsThe number of rounds in the draft, and thus the number of players each team will select during the draft.
/draft/salary_capThe total amount that owners will have to bid on players, as an integer.
/draft/time_limitThe time limit for an owner to make a pick in a draft when the draft robot is in use, in seconds, as an integer.
/draft/type
/draft/use_robotWhether or not the draft uses the draft robot, as a Boolean.
/draft/timer_startFor Extended Drafts, the time of day at which the robot starts running, in the format HHMM.
/draft/timer_endFor Extended Drafts, the time of day at which the robot stops running, in the format HHMM.

Resource

Draft Config

Description

The draft configurations of the fantasy league.  The resource contains information that describes the configuration of a draft, including the type of the draft, number of rounds, draft day and time, salary cap (for auction drafts), bid time limit (for auction drafts), and nomination time limit (for auction drafts).

HTTP Methods

GET

Retrieve Draft Config

URL

http://api.cbssports.com/fantasy/league/draft/config?version=2.0

Parameters

response_format(optional) Specifies the format in which the requested resource should be returned.  Valid values are XML and JSON.  The default is XML.

Example

Retrieve Draft Config

Sample URL

http://api.cbssports.com/fantasy/league/draft/config?version=2.0

XML Response

Sample for Online Auction

<?xml version="1.0"?>
<result uriAlias="/league/draft/config" uri="/league/draft/config" statusCode="200" statusMessage="OK">
  <body>
    <draft>
      <use_robot>1</use_robot>
      <date>20120208</date>
      <time>0800</time>
      <auction_supplemental_rounds>4</auction_supplemental_rounds>
      <auction_reserve_draft>1</auction_reserve_draft>
      <nomination_time_limit>30</nomination_time_limit>
      <auction_to_bid_on>active</auction_to_bid_on>
      <bid_time_limit>60</bid_time_limit>
      <pick_email>0</pick_email>
      <draft_schedule>scheduled</draft_schedule>
      <rounds>23</rounds>
      <type>live</type>
      <time_limit>30</time_limit>
      <salary_cap>350</salary_cap>
    </draft>
  </body>
</result>

JSON Response

Sample for Online Auction

{
   "body" : {
      "draft" : {
         "use_robot" : 1,
         "date" : "20120208",
         "time" : "0800",
         "auction_supplemental_rounds" : "4",
         "auction_reserve_draft" : 1,
         "nomination_time_limit" : "30",
         "auction_to_bid_on" : "active",
         "bid_time_limit" : "60",
         "pick_email" : 0,
         "draft_schedule" : "scheduled",
         "rounds" : "23",
         "type" : "live",
         "time_limit" : "30",
         "salary_cap" : "350"
      }
   },
   "uriAlias" : "/league/draft/config",
   "statusMessage" : "OK",
   "uri" : "/league/draft/config",
   "statusCode" : 200
}

XML Response

Sample for Online Draft

<?xml version="1.0"?>
<result uriAlias="/league/draft/config" uri="/league/draft/config" statusCode="200" statusMessage="OK">
  <body>
    <draft>
      <use_robot>1</use_robot>
      <time>0800</time>
      <date>20120214</date>
      <order_type>snake</order_type>
      <order_source>random</order_source>
      <auction_supplemental_rounds>0</auction_supplemental_rounds>
      <timer_start>1000</timer_start>
      <pick_email>0</pick_email>
      <type>extended</type>
      <draft_schedule>scheduled</draft_schedule>
      <rounds>26</rounds>
      <time_limit>5</time_limit>
      <timer_end>2100</timer_end>
    </draft>
  </body>
</result>

JSON Response

Sample for Online Draft

{
   "body" : {
      "draft" : {
         "use_robot" : 1,
         "time" : "0800",
         "date" : "20120214",
         "order_type" : "snake",
         "order_source" : "random",
         "auction_supplemental_rounds" : 0,
         "timer_start" : "1000",
         "pick_email" : 0,
         "type" : "extended",
         "draft_schedule" : "scheduled",
         "rounds" : "26",
         "time_limit" : "5",
         "timer_end" : "2100"
      }
   },
   "uriAlias" : "/league/draft/config",
   "statusMessage" : "OK",
   "uri" : "/league/draft/config",
   "statusCode" : 200
}

XML field definitions

/draft

A container element for the draft configuration.

/draft/auction_reserve_draft

Whether reserve players will be included in the auction draft, as a Boolean using the values 1 and 0.

/draft/auction_to_bid_on

Specifies whether the auction will include active players only or both active and reserve players.  Possible values are active and all.

/draft/auction_supplemental_rounds

If the auction_to_bid_on value is active they may choose to use a supplemental draft to fill the reserve spots on their roster.  If they choose to use the supplemental draft, the number of rounds will be displayed here.

/draft/bid_time_limit

The amount of time owners will have to bid on a player, in seconds, as an integer.  0nce the time limit goes under 10 seconds, it will reset to 10 seconds each time a bid is entered in order to allow other owners a chance to place a higher bid.

/draft/date

The date that the draft will begin, in the format YYYYMMDD.  The time the draft will begin is specified by the /draft/time field.

/draft/time

The time that the draft will begin (ET), in the format HHMM.  The day the draft will begin is specified by the /draft/date field.  It will automatically adjust for Daylight Savings Time.

/draft/draft_schedule

Specifies whether the draft has been scheduled.  Possible values are *scheduled” and none.

/draft/nomination_time_limit

The amount of time an owner will have to nominate a player for auction, in seconds, as an integer.

/draft/order_source

The source of the draft pick order.  Possible values are random, manual, and custom.

/draft/order_type

Specifies how the order of picks will progress on round-by-round basis.  Possible values are snake and nonsnaking.  For snaking order types, pick order reverses each round.

/draft/pick_email

Whether email notifications will be sent for Online Extended Drafts, as a Boolean using the values 1 and 0.

/draft/rounds

The number of rounds in the draft, and thus the number of players each team will select during the draft.

/draft/salary_cap

The total amount that owners will have to bid on players, as an integer.

/draft/time_limit

The time limit for an owner to make a pick in a draft when the draft robot is in use, in seconds, as an integer.  To determine if the draft robot is in use, check /draft/use_robot.

/draft/type

The type of the draft.  Possible values and their meanings are as follows

noneNot sure yet
liveOnline, Live Draft (all in one day)
auctionOnline, Live Auction Draft (all in one day)
extendedOnline, Extended Draft (over a period of several days)
autoBy Automated Draft
offlineBy Entering Offline Draft Results (manual rosters entry)

/draft/use_robot

Whether or not the draft uses the draft robot, as a Boolean.  If the robot is used, there is time limit for each pick in each round (specified by /draft/time_limit).  If any owner does not make a draft selection, the draft robot will pick for them.  If the robot is not used, the draft will pause until the owner makes a draft pick or the commissioner picks in their place.  The draft robot will pick the first player listed in the team’s draft queue.  If there is no player in the draft queue, the draft robot will pick the top player on the team’s rank list.

/draft/timer_start

For Extended Drafts, the time of day at which the robot starts running, in the format HHMM.

/draft/timer_end

For Extended Drafts, the time of day at which the robot stops running, in the format HHMM.

The time that the draft will begin (ET), in the format HHMM.
The date that the draft will begin, in the format YYYYMMDD.
Whether or not the draft uses the draft robot, as a Boolean.
The time limit for an owner to make a pick in a draft when the draft robot is in use, in seconds, as an integer.