security.getUserAccessList

This method is part of iPaper Secure. For more information about iPaper Secure, see the complete documentation.

This method can be used for tracking and verification purposes. It gets the list of the secure documents that the given user_identifier is currently allowed to access. Note that calling security.setAccess will not insert a document into this resultset (though it can remove one)- that can only be done with the user viewing an active embed code.

Parameters

string user_identifier (required) Your user identifier; should be the same as what is used in the embed code.
string api_key (required) API key assigned to your account.
string api_sig (optional) MD5 hash of the active request and your secret key. This is an optional security measure. See the signing documentation for more info.

Sample return XML

    <?xml version="1.0" encoding="UTF-8"?>
    <rsp stat="ok">
      <result_set list="true">
        <result>
          <doc_id>244565</doc_id>
          <title>&lt;![CDATA[Ruby on Java]]&gt;</title>
          <description>&lt;![CDATA[Ruby On Java, Barcamp, Washington DC]]&gt;</description>
          <access_key>key-t3q5qujoj525yun8gf7</access_key>
          <conversion_status>DONE</conversion_status>
          <page_count>10</page_count>
        </result>
        <result>
          <doc_id>244567</doc_id>
          <title>&lt;![CDATA[Ruby on Java Part II]]&gt;</title>
          <description>&lt;![CDATA[Ruby On Java Part II, Barcamp, Washington DC]]&gt;</description>
          <access_key>key-2b3udhalycthsm91d1ps</access_key>
          <conversion_status>DONE</conversion_status>
          <page_count>12</page_count>
        </result>
      </result_set>
    </rsp>

Result explanation

list result Contains each individual result
integer doc_id Every document on Scribd has a unique document ID. You can use this ID to link to the document, among other things.
string secret_password The secret password allows access to the Scribd pages for private documents. This parameter will only be provided if the given document is actually private.
string access_key The access_key allows you to embed a document on an external site.
string title
string description
["DISPLAYABLE", "DONE", "ERROR", "PROCESSING"] conversion_status
integer page_count The number of pages in the document

Error codes

401 Unauthorized
500 Internal Server Error. Scribd has been notified about this problem.
601 Required parameter missing