Notice: The Bookshare API V1 will be sunset on June 30, 2024 and will no longer be available. Partners will need to migrate to API V2 to continue accessing the Bookshare collection after that date. Learn about API V2.

URI	Details	Response
api.bookshare.org/user/members/list/for/Text	Organizational Member List	Organizational Member List Response
api.bookshare.org/download/member/Text/content/Number/version/Number/for/Text	Organizational Download Request	Binary Download

Organization Member List

• Description: List members available in the Organization identified by the User (Sponsor) Account.
• Format: api.bookshare.org/user/members/list/for/Text
• Authentication: User Authenticated
• Response: Organization Member List Response
• Examples:
  • api.bookshare.org/user/members/list/for/user@foo.com
• Errors:
  • Error 14 – No Members available for the Sponsors Organization.
  • Error 61 – Unauthorized request. The User is not a valid Sponsor for an Organization.

Organization Member List Response

• The Member ID returned in this response is an obfuscated string that is valid for a certain period of time.
• To perform an action on behalf of a Organization Member, first issue a /member/list and invoke the subsequent step with the Member ID returned in this response to guarantee its validity.
• Caching of Member IDs from this response is not supported.

Container: user

Fields

Field	Type	Description	Occurrence
downloads-remaining	Number	Indicates the number of downloads remaining for this User	1

Container: user/list/result

Additional Fields

Field	Type	Description	Occurrence
member-id	Text	Obfuscated User ID	1
first-name	Text	First Name for the member	1
last-name	Text	Last Name for the member	1

XML Example:

<bookshare>
  <version>3.2.8</version>
  <user>
    <downloads-remaining>100</downloads-remaining>
    <list>
      <page>1</page>
      <limit>10</limit>
      <num-pages>1</num-pages>
      <member>
        <member-id>AP5xvS_7UWQeXyrO_qJDwfc7wpSSCojqBQwgJciWhniqLLD9P9rFQxcQyijsrOvHSlb2e2RJS1tG</member-id>
        <first-name>Test</first-name>
        <last-name>STUDENT1</last-name>
      </member>
      <member>
        <member-id>AP5xvS8NheonN_BoCxobZrEHKNjWFiuak1i_LH0J-ZbJy3BYUK_IatUFBkJ9JIBesHYpBOWuzZJF</member-id>
        <first-name>Test</first-name>
        <last-name>STUDENT2</last-name>
      </member>
      <member>
        <member-id>AP5xvS_hdK_W8Wi2h4TBLkGXcr-MiaEW3YrJ5hJjnUxUc6_5OBXO6VFoxUrzmc5C46Neu_fTSUgb</member-id>
        <first-name>Test</first-name>
        <last-name>STUDENT3</last-name>
      </member>
      <member>
        <member-id>AP5xvS8EILqn1IU7u23RB55LfxMGooT9TsbOmihkCUkSaZTfRANxZhBtKd_rcHDYPLuL9AQ13Cu5</member-id>
        <first-name>Test</first-name>
        <last-name>STUDENT4</last-name>
      </member>
      <member>
        <member-id>AP5xvS_5HquG47GBw7DOUbmIuvFPrcrXYfLzJ_RGEFRSc5vby2w2sHI-bJjUYaMhRyLvMH6Qu79N</member-id>
        <first-name>Test</first-name>
        <last-name>STUDENT5</last-name>
      </member>
    </list>
  </user>
</bookshare>

JSON Example:

{"bookshare": {
  "response": {
    "version": "3.5.1"
  },
  "messages": [
  ],
  "downloadsRemaining": 100,
  "member": [
    {
      "memberId": "AP5xvS-4BExqe2VsZbRzkh-pxcXagAHRF3eb_5idz5Xb3bmi5910ViWGTpiYc3xjEmzhOvQXJoct",
      "firstName": "API",
      "lastName": "STUDENT1"
    },
    {
      "memberId": "AP5xvS-cu8JGJ4CctnkPjVzLeM7ekxqZuSgT5dtlPVfuyjn1hm7upKKDbkrzX6OEFrfyFgsbFMoQ",
      "firstName": "API",
      "lastName": "STUDENT2"
    },
    {
      "memberId": "AP5xvS_NFSjr-vUOaq15GQxronsYDAt8jMnlGEqavOeyb-y7Akt_6t1QRicyoiNd7CiYTe3tqFJe",
      "firstName": "API",
      "lastName": "STUDENT3"
    },
    {
      "memberId": "AP5xvS9AGmbcGQ_cZPcL-ohbhFY08uGsGS8GQ-kSyUjWV89E3T5wQmv79Trs4EkIcLaht_qLC1r-",
      "firstName": "API",
      "lastName": "STUDENT4"
    },
    {
      "memberId": "AP5xvS8pEvIqS9awA0Du4xdlRWgK29dQFOpSzLj0ZbrFE87Ka6UTcJvYri4R_L8a1WnnYmWfOn8H",
      "firstName": "API",
      "lastName": "STUDENT5"
    }
  ]
}}