From cede8fc5787f7dc37df2bd83e00fafa7b8ac04b0 Mon Sep 17 00:00:00 2001
From: fgerlits <fgerlits@cfc7b370-4200-0410-a6e3-cb6bdb053afe>
Date: Mon, 27 Nov 2006 14:07:15 +0000
Subject: [PATCH] clarified the playable ID format in the xml-rpc interface
 docs

---
 .../src/products/scheduler/src/DisplayScheduleMethod.h     | 5 +++++
 .../src/products/scheduler/src/GeneratePlayReportMethod.h  | 7 ++++++-
 .../src/products/scheduler/src/UploadPlaylistMethod.h      | 5 +++++
 3 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/campcaster/src/products/scheduler/src/DisplayScheduleMethod.h b/campcaster/src/products/scheduler/src/DisplayScheduleMethod.h
index 58db6afdb..2aadf719e 100644
--- a/campcaster/src/products/scheduler/src/DisplayScheduleMethod.h
+++ b/campcaster/src/products/scheduler/src/DisplayScheduleMethod.h
@@ -96,6 +96,11 @@ using namespace LiveSupport::Core;
  *      <li>end - datetime - the end of the scheduled item</li>
  *  </ul>
  *
+ *  The playlistId parameter is a string containing the hexadecimal value of 
+ *  the playlist ID.
+ *  It is up to 32 characters long, representing a value between 0 and 2^31-1,
+ *  inclusive.
+ *
  *  In case of an error, a standard XML-RPC fault response is generated, 
  *  and a {&nbsp;faultCode, faultString&nbsp;} structure is returned.  The
  *  possible errors are:
diff --git a/campcaster/src/products/scheduler/src/GeneratePlayReportMethod.h b/campcaster/src/products/scheduler/src/GeneratePlayReportMethod.h
index cf23b6fff..1a17558d2 100644
--- a/campcaster/src/products/scheduler/src/GeneratePlayReportMethod.h
+++ b/campcaster/src/products/scheduler/src/GeneratePlayReportMethod.h
@@ -89,10 +89,15 @@ using namespace LiveSupport::Core;
  *  for each play log item in the interval.  An array of size 0 means there
  *  are no play log entries. Each structure is as follows:
  *  <ul>
- *      <li>audioClipId - string -      the id of the audio clip played </li>
+ *      <li>audioClipId - string -   the id of the audio clip played </li>
  *      <li>timestamp   - datetime - the time the clip was played (started)</li>
  *  </ul>
  *
+ *  The audioClipId parameter is a string containing the hexadecimal value of 
+ *  the audio clip ID.
+ *  It is up to 32 characters long, representing a value between 0 and 2^31-1,
+ *  inclusive.
+ *
  *  In case of an error, a standard XML-RPC fault response is generated, 
  *  and a {&nbsp;faultCode, faultString&nbsp;} structure is returned.  The
  *  possible errors are:
diff --git a/campcaster/src/products/scheduler/src/UploadPlaylistMethod.h b/campcaster/src/products/scheduler/src/UploadPlaylistMethod.h
index 28a733e86..d1067ad14 100644
--- a/campcaster/src/products/scheduler/src/UploadPlaylistMethod.h
+++ b/campcaster/src/products/scheduler/src/UploadPlaylistMethod.h
@@ -81,6 +81,11 @@ using namespace LiveSupport::Core;
  *                                scheduled, an ISO 8601 DateTime field</li>
  *  </ul>
  *
+ *  The playlistId parameter is a string containing the hexadecimal value of 
+ *  the playlist ID.
+ *  It is up to 32 characters long, representing a value between 0 and 2^31-1,
+ *  inclusive.
+ *
  *  If the upload is successful, the method returns an XML-RPC structure with
  *  the following members:
  *  <ul>