message.html.erb

<a href="/api">&laquo; Back to index</a>




  <div style="padding:30px; padding-top:0px;border-bottom:1px solid #ddd;">
  
  
  <h2><span style='color:#ff6600; width:200px;margin-right:20px;'>GET</span>/messages</h2>
  
  
  <strong>Access:</strong> <br />
  
  <strong>Return:</strong>
  
  
  
     
  
  
  
  
  -
   User does not have access to this message
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  <li>qrrent_id:integer - URL Param, Required</li>
  </ul>
  <p><strong>Description:</strong> 
  Retrieves all messages in the system that the user has access to
</p>
</div>




  <div style="padding:30px; padding-top:0px;border-bottom:1px solid #ddd;">
  
  
  <h2><span style='color:#ff6600; width:200px;margin-right:20px;'>GET</span>/messages/new</h2>
  
  
  <strong>Access:</strong> <br />
  
  <strong>Return:</strong>
  
  
  
     
  
  
  
    <a href="#xml"  onclick="$('xmlrep').show();">XML</a>
  
  
  -
   A message
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  
  </ul>
  <p><strong>Description:</strong>   Get a pre-generated, empty message
</p>
</div>




  <div style="padding:30px; padding-top:0px;border-bottom:1px solid #ddd;">
  
  
  <h2><span style='color:#ff6600; width:200px;margin-right:20px;'>GET</span>/messages/:id</h2>
  
  
  <strong>Access:</strong> <br />
  
  <strong>Return:</strong>
  
  
  
     
  
  
  
    <a href="#xml"  onclick="$('xmlrep').show();">XML</a>
  
  
  -
   The retrieved message
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  <li>id:integer - Required URL param.  ID of the message to retrieve</li>
  </ul>
  <p><strong>Description:</strong>   Retrieve a specific message by unique id.  Could return 403 | access denied; the current user does not have access to this message
    404 | not found; the message requested was not found in the system
</p>
</div>




  <div style="padding:30px; padding-top:0px;border-bottom:1px solid #ddd;">
  
  
  <h2><span style='color:#ff6600; width:200px;margin-right:20px;'>POST</span>/messages</h2>
  
  
  <strong>Access:</strong> <br />
  
  <strong>Return:</strong>
  
  
  
     
  
    <a href="#json" onclick="$('jsonrep').show();">JSON</a>
  
  
  
    <a href="#xml"  onclick="$('xmlrep').show();">XML</a>
  
  
  -
   The created message object
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  <li>message:hash - A message object in hash form.</li>
  </ul>
  <p><strong>Description:</strong>   Creates a single message given properly formatted parameters
</p>
</div>




  <div style="padding:30px; padding-top:0px;border-bottom:1px solid #ddd;">
  
  
  <h2><span style='color:#ff6600; width:200px;margin-right:20px;'>PUT</span>/messages/:id</h2>
  
  
  <strong>Access:</strong> <br />
  
  <strong>Return:</strong>
  
  
  
     
  
    <a href="#json" onclick="$('jsonrep').show();">JSON</a>
  
  
  
    <a href="#xml"  onclick="$('xmlrep').show();">XML</a>
  
  
  -
   The updated message
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  <li>id:integer - Required.  ID of the message to update</li><li>message:hash - A hash of the message parameters to update to</li>
  </ul>
  <p><strong>Description:</strong>   Updates a single message by unique id if given properly formatted parameters
</p>
</div>




  <div style="padding:30px; padding-top:0px;border-bottom:1px solid #ddd;">
  
  
  <h2><span style='color:#ff6600; width:200px;margin-right:20px;'>DELETE</span>/messages/:id</h2>
  
  
  <strong>Access:</strong> <br />
  
  <strong>Return:</strong>
  
  
  
     
  
    <a href="#json" onclick="$('jsonrep').show();">JSON</a>
  
  
  
    <a href="#xml"  onclick="$('xmlrep').show();">XML</a>
  
  
  -
   Response message
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  <li>id:integer - Required.  ID of the message to delete</li>
  </ul>
  <p><strong>Description:</strong>     integer | id (required): the id of the message you wish to delete
  Deletes a message given a specific id
</p>
</div>





<%= render :partial => "sidebar"  %>