Message

Summary

Message
Resource
Message	A message on the fantasy league’s message baord.
HTTP Methods
GET	Retrieve a Message
POST	Create a new Message
DELETE	Delete a Message By ID
Example
Retrieve a Message	GET
Create a Message	POST
Delete a Message	DELETE
XML field definitions
/message	A container element for the message.
/message/@id	The message ID.
/message/body	The body of the message.
/message/views	The number of times that the message has been viewed.
/message/timestamp	The timestamp of the message in UNIX timestamp format.
/message/subject	The subject of the message.
/message/author	The name of the author of the message.

Resource

Message

Description

A message on the fantasy league’s message baord. You can create, retrieve, or delete a message.

The message information includes the message ID, subject, author, body, timestamp, and the number of time the message has been viewed.

The message may be either in text format or in valid HTML. If HTML is provided, it will be used to display the message.

HTTP Methods

GET

Retrieve a Message

URL

http://api.cbssports.com/fantasy/league/message-board/message

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.
id	The ID of the message to be returned. You can get message IDs by requesting the Message List resource. The message ID is found in the field /message_list/message/@id.

Response

An XML or JSON encoding of the requested message. (See Examples below.)

POST

Create a new Message

URL

http://api.cbssports.com/fantasy/league/message-board/message

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.

Body

To be sent as payload=JSON

payload={"reply_to": "<reply_to_id>", "quote_original":"<quote_original>", "subject": "<subject>", "body":"<body>"}

where

<reply_to_id> = ID of the message the new message is a reply to (optional)
<quote_original> = 1 to quote the original message as part of the body of the new message, 0 otherwise
<subject> = Subject of the new message
<body> = Body of the new message. The message body may contain valid HTML.

Response

An XML or JSON encoding of the new message. (See Examples below.)

DELETE

Delete a Message By ID

URL

http://api.cbssports.com/fantasy/league/message-board/message

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.
id	ID of the message to be deleted

Response

One of the following HTTP Status Codes

202 if Message was successfully deleted
404 if Message was not found
403 if the user trying to delete the Message is not a Commissioner

Example

Retrieve a Message

Method

GET

Sample URL

http://api.cbssports.com/fantasy/league/message-board/message?id={message_id}

XML Response

<?xml version="1.0"?>
<result uriAlias="/league/message-board/message" uri="/league/message-board/message" statusCode="200" statusMessage="OK">
  <body>
    <message id="Message ID">
      <body>
    Message Body
      </body>
      <views>3</views>
      <timestamp>1317302815</timestamp>
      <subject>Subject</subject>
      <author>Author Name</author>
    </message>
  </body>
</result>

JSON Response

{
   "body" : {
      "message" : {
         "body" : "Message Body",
         "views" : 3,
         "timestamp" : "1299676394",
         "subject" : "Subject",
         "author" : "Author Name",
         "id" : "Message ID",
      }
   },
   "uriAlias" : "/league/message-board/message",
   "statusMessage" : "OK",
   "uri" : "/league/message-board/message",
   "statusCode" : 200
}

Create a Message

Method

POST

Sample URL

http://api.cbssports.com/fantasy/league/message-board/message

Body

payload={"body": "Body Of A New Message", "subject": "Subject of A New Message"}

XML Response

<?xml version="1.0"?>
<result uriAlias="/league/message-board/message" uri="/league/message-board/message" statusCode="200" statusMessage="OK">
  <body>
    <message id="New Message ID">
      <body>
        Body of A New Message
      </body>
      <views>0</views>
      <timestamp>1317302815</timestamp>
      <subject>Subject Of A New Message</subject>
      <author>Author Name</author>
    </message>
  </body>
</result>

JSON Response

{
   "body" : {
      "message" : {
         "body" : "Body of A New Message",
         "views" : 0,
         "timestamp" : "1299676394",
         "subject" : "Subject Of A New Message",
         "author" : "Author Name",
         "id" : "New Message ID",
      }
   },
   "uriAlias" : "/league/message-board/message",
   "statusMessage" : "OK",
   "uri" : "/league/message-board/message",
   "statusCode" : 200
}

Delete a Message

Method

DELETE

Sample URL

http://api.cbssports.com/fantasy/league/message-board/message?id={message_id}

XML Response

<?xml version="1.0"?>
<result uriAlias="/league/message-board/message" uri="/league/message-board/message" statusCode="204" statusMessage="OK">
</result>

JSON Response

{
   "uriAlias" : "/league/message-board/message",
   "statusMessage" : "OK",
   "uri" : "/league/message-board/message",
   "statusCode" : 204
}

XML field definitions

/message

A container element for the message.

/message/@id

The message ID. This is the same message ID that was used to request the resource.

/message/body

The body of the message.

/message/views

The number of times that the message has been viewed.

/message/timestamp

The timestamp of the message in UNIX timestamp format.

/message/subject

The subject of the message.

/message/author

The name of the author of the message. If the author is no longer a member of the league, the value will be “Author no longer in league”.

The ID of the message.