subscription.html

<a href="/apidoc">&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>/subscriptions</h2>
  
  
  <strong>Access:</strong> <br />
  
  <strong>Return:</strong>
  
  
  
    a list of
    
     
  
    <a href="#json" onclick="$('jsonrep').show();">JSON</a>
  
  
  
    <a href="#xml"  onclick="$('xmlrep').show();">XML</a>
  
  
  -
   Qrrents
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  
  </ul>
  <p><strong>Description:</strong>   Returns all subscriptions for the current user
</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>/subscriptions/: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 subscription object
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  <li>id:integer - Required.  ID of the subscription object</li>
  </ul>
  <p><strong>Description:</strong>     integer | id (URL Param, required)
</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>/subscriptions/new</h2>
  
  
  <strong>Access:</strong> <br />
  
  <strong>Return:</strong>
  
  
  
     
  
    <a href="#json" onclick="$('jsonrep').show();">JSON</a>
  
  
  
    <a href="#xml"  onclick="$('xmlrep').show();">XML</a>
  
  
  -
   an empty subscription
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  
  </ul>
  <p><strong>Description:</strong>   Returns a new, empty subscription object
</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>/subscriptions</h2>
  
  
  <strong>Access:</strong> <br />
  
  <strong>Return:</strong>
  
  
  
     
  
    <a href="#json" onclick="$('jsonrep').show();">JSON</a>
  
  
  
    <a href="#xml"  onclick="$('xmlrep').show();">XML</a>
  
  
  -
   Newly created subscription object
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  <li>subscription:hash - The hash of subscription attributes to create</li>
  </ul>
  <p><strong>Description:</strong>   Creates a subscription association in the system between a user and a qrrent
</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>/subscriptions/: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>
  
  
  -
   OK
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  <li>id:integer - Required.  ID of the subscription to delete</li>
  </ul>
  <p><strong>Description:</strong>   Deletes a subscription from the system based on a unique id
</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>/subscriptions/: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>
  
  
  -
   OK
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  <li>id:integer - Required.  Unique id of the subscription to update</li><li>subscription:hash - Subscription object to use for the update</li>
  </ul>
  <p><strong>Description:</strong> </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>/subscriptions/latest_assets</h2>
  
  
  <strong>Access:</strong> <br />
  
  <strong>Return:</strong>
  
  
  
    a list of
    
     
  
    <a href="#json" onclick="$('jsonrep').show();">JSON</a>
  
  
  
    <a href="#xml"  onclick="$('xmlrep').show();">XML</a>
  
  
  -
  
  <br />
  
  
  <strong>Parameters:</strong>
  <ul>
  
  </ul>
  <p><strong>Description:</strong>   Returns an array of asset objects that represent the latest asset in each subscription for the current user
</p>
</div>