1. Overview
The Bookshare API v2 for Membership provides clients endpoints for Membership Assistant users to manage the membership records of users who are part of their Site. The same conventions and general rules for API use apply here as they do to the public API for Bookshare users.
Membership Assistants are responsible for helping users and organizations get as much content, as easily as possible, from the collection of titles to which they are entitled. This can involve reviewing or updating properties of users or organizations, or reviewing their activity to help them resolve any problems they are having. Many of the endpoints mirror operations that a user might otherwise perform for themselves, such as adding a subscription or updating a user’s preferences.
2. Resources
2.1. Membership Assistant - User Accounts
Membership Assistant users are able to view and update the user accounts for those individual members who are associated with the Assistant’s site.
2.1.1. Look up user account
GET /v2/accounts/{userIdentifier}
Description
Search for a user by their unique user identifier. Membership Assistants are only allowed to search for users associated with the same Site as them.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user to search for. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User Account response |
|
default |
Unexpected error |
2.1.2. Update a user account
PUT /v2/accounts/{userIdentifier}
Description
Update a new user account, with the properties provided.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user to update. |
string |
FormData |
firstName |
The user’s first name. |
string |
FormData |
lastName |
The user’s last name. |
string |
FormData |
phoneNumber |
The user’s phone number. |
string |
FormData |
emailAddress |
The user’s email address. This value will also be used as the username. |
string |
FormData |
address1 |
The user’s street address of residence. |
string |
FormData |
address2 |
Any extra street address information for the user. |
string |
FormData |
city |
The user’s city of residence. |
string |
FormData |
state |
The user’s state or province of residence. The value should be either a two-character postal abbreviation or an ISO 3166-2 subdivision code for the user’s country. This field is only relevant for subdivisions of the US and Canada. |
string |
FormData |
country |
The user’s country of residence. The values should be a two-character ISO 3166 alpha-2 country code. |
string |
FormData |
postalCode |
The user’s postal code of residence. |
string |
FormData |
guardianFirstName |
The user’s guardian’s first name (if user is a minor). |
string |
FormData |
guardianLastName |
The user’s guardian’s last name (if user is a minor). |
string |
FormData |
dateOfBirth |
The user’s date of birth. The value should be formatted as 'YYYY-MM-DD'. |
string |
FormData |
language |
The user’s preferred language. The value should be a three-character ISO 639-2 alpha-3 language code |
string |
FormData |
allowAdultContent |
True if the user should be allowed to find and download titles marked with adult content. If a birth date is provided, this defaults to true; if no birth date is provided, this defaults to false. |
boolean |
FormData |
site |
The site with which the user should be associated. The person submitting the request must be a full administrator. By default, the created user will be associated with the same site as the user submitting the request. |
string |
FormData |
role |
The user’s primary role. If not provided, the user will be given the individual member role. |
enum (individual, volunteer, trustedVolunteer, collectionAssistant, membershipAssistant) |
FormData |
password |
The user’s password. It must be from 8-32 characters long, and contain at least one letter and one number. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
User Account response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.3. Create a user account
POST /v2/accounts
Description
Create a new user account, with the properties provided.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
FormData |
firstName |
The user’s first name. |
string |
FormData |
lastName |
The user’s last name. |
string |
FormData |
phoneNumber |
The user’s phone number. |
string |
FormData |
emailAddress |
The user’s email address. This value will also be used as the username. |
string |
FormData |
address1 |
The user’s street address of residence. |
string |
FormData |
address2 |
Any extra street address information for the user. |
string |
FormData |
city |
The user’s city of residence. |
string |
FormData |
state |
The user’s state or province of residence. The value should be either a two-character postal abbreviation or an ISO 3166-2 subdivision code for the user’s country. This field is only relevant for subdivisions of the US and Canada. |
string |
FormData |
country |
The user’s country of residence. The values should be a two-character ISO 3166 alpha-2 country code. |
string |
FormData |
postalCode |
The user’s postal code of residence. |
string |
FormData |
guardianFirstName |
The user’s guardian’s first name (if user is a minor). |
string |
FormData |
guardianLastName |
The user’s guardian’s last name (if user is a minor). |
string |
FormData |
dateOfBirth |
The user’s date of birth. The value should be formatted as 'YYYY-MM-DD'. |
string |
FormData |
language |
The user’s preferred language. The value should be a three-character ISO 639-2 alpha-3 language code |
string |
FormData |
allowAdultContent |
True if the user should be allowed to find and download titles marked with adult content. If a birth date is provided, this defaults to true; if no birth date is provided, this defaults to false. |
boolean |
FormData |
site |
The site with which the user should be associated. The person submitting the request must be a full administrator. By default, the created user will be associated with the same site as the user submitting the request. |
string |
FormData |
role |
The user’s primary role. If not provided, the user will be given the individual member role. |
enum (individual, volunteer, trustedVolunteer, collectionAssistant, membershipAssistant) |
FormData |
password |
The user’s password. It must be from 8-32 characters long, and contain at least one letter and one number. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
User Account response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.4. Get subscriptions
GET /v2/accounts/{userIdentifier}/subscriptions
Description
Get the list of existing membership subscriptions for an existing user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User subscription list response |
|
default |
Unexpected error |
2.1.5. Create a subscription
POST /v2/accounts/{userIdentifier}/subscriptions
Description
Create a new membership subscription for an existing user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
FormData |
startDate |
Date that the user subscription starts. The value should be formatted as 'YYYY-MM-DD'. |
string (date) |
FormData |
endDate |
Date that the user subscription ends. The value should be formatted as 'YYYY-MM-DD'. |
string (date) |
FormData |
userSubscriptionType |
Type of user subscription. List of possible values exists at /v2/subscriptiontypes. |
string |
FormData |
numBooksAllowed |
Number of books allowed. |
integer |
FormData |
downloadTimeframe |
The timeframe for download limits on a user subscription |
enum (monthly, entireSubscription) |
FormData |
notes |
Notes about the user subscription. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
User subscription response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.6. Get single subscription
GET /v2/accounts/{userIdentifier}/subscriptions/{subscriptionId}
Description
Get an existing membership subscriptions for an existing user by unique id.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Path |
subscriptionId |
The unique identifier of a user membership subscription. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User subscription response |
|
default |
Unexpected error |
2.1.7. Update a subscription
PUT /v2/accounts/{userIdentifier}/subscriptions/{subscriptionId}
Description
Update an existing membership subscription for an existing user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Path |
subscriptionId |
The unique identifier of a user membership subscription |
string |
FormData |
startDate |
Date that the user subscription starts. The value should be formatted as 'YYYY-MM-DD'. |
string (date) |
FormData |
endDate |
Date that the user subscription ends. The value should be formatted as 'YYYY-MM-DD'. |
string (date) |
FormData |
userSubscriptionType |
Type of user subscription. List of possible values exists at /v2/subscriptiontypes. |
string |
FormData |
numBooksAllowed |
Number of books allowed. |
integer |
FormData |
downloadTimeframe |
The timeframe for download limits on a user subscription. |
enum (monthly, entireSubscription) |
FormData |
notes |
Notes about the user subscription. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User subscription response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.8. Get subscription types
GET /v2/subscriptiontypes
Description
Get the list of subscription types available to users of the Membership Assistant’s site.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User Subscription Type list response |
|
default |
Unexpected error |
2.1.9. Get proof of disability
GET /v2/accounts/{userIdentifier}/pod
Description
Get the list of disabilities for an existing user, with their proof source.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User disabilities list response |
|
default |
Unexpected error |
2.1.10. Create a proof of disability
POST /v2/accounts/{userIdentifier}/pod
Description
Create a new record of a disability for an existing user, with its proof source.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
FormData |
disabilityType |
The type of disability involved. |
enum (visual, learning, physical, nonspecific) |
FormData |
proofSource |
The organization who has verified the given disability. |
enum (schoolVerified, faxed, nls, learningAlly, partner, hadley, marrakeshPartner) |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
User disabilities list response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.11. Update a proof of disability
PUT /v2/accounts/{userIdentifier}/pod/{disabilityType}
Description
Update the proof source for a disability for an existing user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Path |
disabilityType |
The type of disability involved. |
enum (visual, learning, physical, nonspecific) |
FormData |
proofSource |
The organization who has verified the given disability. |
enum (schoolVerified, faxed, nls, learningAlly, partner, hadley, marrakeshPartner) |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
User disabilities list response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.12. Remove a proof of disability
DELETE /v2/accounts/{userIdentifier}/pod/{disabilityType}
Description
Remove a proof of disability for an existing user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Path |
disabilityType |
The type of disability involved. |
enum (visual, learning, physical, nonspecific) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User disabilities list response |
|
default |
Unexpected error |
2.1.13. Get a list of signed agreements
GET /v2/accounts/{userIdentifier}/agreements
Description
Get the list of signed agreements for an existing user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User Agreements List response |
|
default |
Unexpected error |
2.1.14. Create a new signed agreement
POST /v2/accounts/{userIdentifier}/agreements
Description
Create a new signed agreement record for an existing user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
FormData |
agreementType |
The type of agreement. |
enum (individual, volunteer, sponsor) |
FormData |
dateSigned |
The date of agreement signing. |
string |
FormData |
printName |
The print name of the signing user signing the agreement. |
string |
FormData |
signedByLegalGuardian |
True if the was signed by legal guardian. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
User Agreements response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.15. Expire a signed agreement
POST /v2/accounts/{userIdentifier}/agreements/{id}/expired
Description
Expire a signed agreement.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the agreement owner. |
string |
Path |
id |
The ID of the agreement to expire. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
User Agreements response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.16. Update user password
PUT /v2/accounts/{userIdentifier}/password
Description
Update the password for an existing user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
FormData |
password |
The user’s password. It must be from 8-32 characters long, and contain at least one letter and one number. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Status messages |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.17. Get recommendation profile
GET /v2/accounts/{userIdentifier}/recommendationProfile
Description
Get a particular user’s choices of properties that guide title recommendations.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Recommendation Profile |
|
default |
Unexpected error |
2.1.18. Update recommendation profile
PUT /v2/accounts/{userIdentifier}/recommendationProfile
Description
Update a particular user’s choices of properties that guide how title recommendations.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
|
FormData |
includeGlobalCollection |
If true, the recommendation system should include titles from the Bookshare Global Collection. This defaults to false for members of private label sites. |
boolean |
|
FormData |
narratorType |
Limit results to those with audio artifacts that are voiced by the given narrator type. If format is not also specified, it will default to search for DAISY_AUDIO or DAISY_2_AUDIO. |
enum (human, tts) |
|
FormData |
narratorGender |
Limit results to those with audio artifacts that are voiced by the given narrator type. If format is not also specified, it will default to search for DAISY_AUDIO or DAISY_2_AUDIO. |
enum (female, male, otherNonBinary) |
|
FormData |
readingAge |
Limit results to those with a specific reading age. |
integer |
|
FormData |
excludedContentWarnings |
Limit recommendations to titles that do not match any of the given content warning flags. |
< enum (contentWarning, sex, violence, drugs, language, intolerance, adult, unrated) > array(multi) |
|
FormData |
includedContentWarnings |
Deprecated - Limit recommendations to titles that match at least one of the given content warning flags. |
< enum (contentWarning, sex, violence, drugs, language, intolerance, adult, unrated) > array(multi) |
|
FormData |
excludedCategories |
Limit recommendations to titles that do not match any of the given Bookshare categories. |
< string > array(multi) |
|
FormData |
includedCategories |
Limit recommendations to titles that match at least one of these Bookshare categories. |
< string > array(multi) |
|
FormData |
excludedAuthors |
Limit recommendations to titles that do not match any of the given authors. |
< string > array(multi) |
|
FormData |
includedAuthors |
Limit recommendations to titles that match at least one of these authors. |
< string > array(multi) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Recommendation Profile |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.19. Get user account preferences
GET /v2/accounts/{userIdentifier}/preferences
Description
Request the set of account preferences associated with a specific user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User Account preferences response |
|
default |
Unexpected error |
2.1.20. Update user account preferences
PUT /v2/accounts/{userIdentifier}/preferences
Description
Update the preference settings for a specific user.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
|
FormData |
allowAdultContent |
True if the user is allowed to find and download titles marked with adult content. This defaults to false for members who are minors. |
boolean |
|
FormData |
showAllBooks |
True if books marked as low quality should be included in search results. The default is false. |
boolean |
|
FormData |
showRecommendations |
True if the user would like to opt-in to receiving personalized recommendations. The default is true. |
boolean |
|
FormData |
language |
Language preference of the user. The value should be a three-character ISO 639-2 alpha-3 language code. |
string |
|
FormData |
format |
Preferred format when downloading a title. Can be used by clients to suggest a title’s format when that format is available. |
enum (DAISY, DAISY_AUDIO, BRF, EPUB3, PDF, DOCX) |
|
FormData |
brailleGrade |
The preferred Braille grade (uncontracted or contracted) when downloading generated BRF. |
enum (uncontracted, contracted) |
|
FormData |
brailleFormat |
The format of the Braille (refreshable or embossable) that will be created when downloading generated BRF. An updated Braille format must be submitted with an updated compatible Braille cell line width in order to be accepted. |
enum (refreshable, embossable) |
|
FormData |
brailleCellLineWidth |
The maximum number of cells to create per line when generating BRF. For refreshable Braille, the allowed values are 18, 20, 32, 40, 70, or 80. For embossable Braille, the allowed values are 28 and 40. An updated Braille cell line width must be submitted with an updated compatible Braille format in order to be accepted. |
integer |
|
FormData |
useUeb |
True if English-language books should use UEB, rather than EBAE when downloading generated BRF. The default is false. |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
User Account preferences response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.21. Get periodical subscriptions of a user
GET /v2/accounts/{userIdentifier}/periodicals
Description
Get the list of periodical subscriptions for an existing user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Periodical subscription list response |
|
default |
Unexpected error |
2.1.22. Subscribe to a periodical series for a user
POST /v2/accounts/{userIdentifier}/periodicals
Description
Subscribe to a periodical series for an existing user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
FormData |
seriesId |
The ID of the periodical series. |
string |
FormData |
format |
The format of the periodical edition artifact |
enum (DAISY, DAISY_2_AUDIO, DAISY_AUDIO, BRF) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Periodical subscription list response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.1.23. Unsubscribe from a periodical series for a user
DELETE /v2/accounts/{userIdentifier}/periodicals/{seriesId}
Description
Unsubscribe from a periodical series for an existing user.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Path |
seriesId |
The ID of the periodical series. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Periodical subscription list response |
|
default |
Unexpected error |
2.1.24. Get reading lists for a given user
GET /v2/accounts/{userIdentifier}/lists
Description
Request the list of reading lists that a given user is able to see. These could be private lists, shared lists, or organization lists that the user is subscribed to.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user who the reading lists are being retrieved for. |
string |
|
Query |
start |
If null or empty, it means to start at the beginning of the result set. Otherwise, it should be the value of "next" that was returned from the previous request. |
string |
|
Query |
limit |
Maximum number of results to include. The maximum allowed is 100. |
integer |
|
Query |
sortOrder |
Primary sorting field. |
enum (name, owner, dateUpdated) |
|
Query |
direction |
Direction for sorting. |
enum (asc, desc) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Reading List collection response |
|
default |
Unexpected error |
2.1.25. Create a reading list for a given user
POST /v2/accounts/{userIdentifier}/lists
Description
Create an empty reading list that will be owned by the given user, with the properties provided.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user who the reading lists are being retrieved for. |
string |
FormData |
name |
The name of the reading list |
string |
FormData |
access |
Visibility of the list |
enum (private, shared, org) |
FormData |
description |
The description of the reading list |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Reading List Response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.2. Membership Assistant - Organizations
Membership Assistant users are able to view, create and update organization accounts.
2.2.1. Create an organization
POST /v2/organizations
Description
Create a new organization, with the properties provided.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
FormData |
organizationName |
The name of the organization. |
string |
FormData |
address1 |
The organization’s street address. |
string |
FormData |
address2 |
Any extra street address information for the organization. |
string |
FormData |
city |
The organization’s city. |
string |
FormData |
state |
The organization’s state or province. The value should be either a two-character postal abbreviation or an ISO 3166-2 subdivision code for the user’s country. This field is only relevant for subdivisions of the US and Canada. |
string |
FormData |
country |
The organization’s country of residence. The values should be a two-character ISO 3166 alpha-2 country code. |
string |
FormData |
postalCode |
The organization’s postal code of residence. |
string |
FormData |
phoneNumber |
The organization’s phone number. |
string |
FormData |
website |
The organization’s website. |
string |
FormData |
organizationType |
Type of organization. |
string |
FormData |
subscriptionType |
Type of organization subscription. List of possible values exists at /v2/subscriptiontypes. If nothing is specified, then the default subscription type for the organization type and site will be used. |
string |
FormData |
site |
The site with which the user should be associated. The person submitting the request must be a full administrator. By default, the created user will be associated with the same site as the user submitting the request. |
string |
FormData |
contactFirstName |
The primary contact’s first name. |
string |
FormData |
contactLastName |
The primary contact’s last name. |
string |
FormData |
contactPhoneNumber |
The primary contact’s phone number. |
string |
FormData |
contactTitle |
The title of the primary contact. |
string |
FormData |
contactEmailAddress |
The primary contact’s email address. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Organization |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.2.2. Get organization information
GET /v2/organizations/{organizationId}
Description
Ask for an organization’s information. This includes name, address, type and other properties.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
organizationId |
ID of the organization. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Organization |
|
default |
Unexpected error |
2.2.3. Get a list of members in an organization
GET /v2/organizations/{organizationId}/members
Description
As a membership assistant, get a list of members in an organization.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
organizationId |
ID of the organization. |
string |
|
Query |
start |
If null or empty, it means to start at the beginning of the result set. Otherwise, it should be the value of "next" that was returned from the previous request. |
string |
|
Query |
limit |
Maximum number of results to include. The maximum allowed is 100. |
integer |
|
Query |
sortOrder |
Primary sorting field. |
enum (dateAdded, lastName, firstName, email, userId, district, school, grade, birthDate, status) |
|
Query |
direction |
Direction for sorting. |
enum (asc, desc) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
User Account List response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.2.4. Create a user for an organization
POST /v2/organizations/{organizationId}/members
Description
Create a new organization user account, with the properties provided.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
organizationId |
ID of the organization. |
string |
|
FormData |
firstName |
The user’s first name. |
string |
|
FormData |
lastName |
The user’s last name. |
string |
|
FormData |
dateOfBirth |
The user’s date of birth. The value should be formatted as 'YYYY-MM-DD'. |
string |
|
FormData |
grade |
User’s current grade. Values are from ONIX codelist 77 for US grades, BIC for UK grades |
string |
|
FormData |
username |
Username for the user. |
string |
|
FormData |
password |
The user’s password. It must be from 8-32 characters long, and contain at least one letter and one number. |
string |
|
FormData |
disabilityType |
The type of disability involved. |
enum (visual, learning, physical, nonspecific) |
|
FormData |
proofSource |
The organization who has verified the given disability. Only applies if disabilityType is submitted. |
enum (schoolVerified, faxed, nls, learningAlly, partner, hadley, marrakeshPartner) |
|
FormData |
disabilityPlan |
The disability plan for the user. |
< enum (iep, section504) > array(multi) |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
User Account response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.2.5. Get organization types
GET /v2/organizationTypes
Description
Get the list of organization types relevant to the current user.
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Organization type list response. |
|
default |
Unexpected error |
2.3. Membership Assistant - Active Titles
Membership Assistant users are able to manage active titles on behalf of a given user account.
2.3.1. Get active books for a user
GET /v2/accounts/{userIdentifier}/activeBooks
Description
Get a list of active books for a specific user that are ready to read.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user who owns the active book list. |
string |
|
Query |
start |
If null or empty, it means to start at the beginning of the result set. Otherwise, it should be the value of "next" that was returned from the previous request. |
string |
|
Query |
limit |
Maximum number of results to include. The maximum allowed is 100. |
integer |
|
Query |
sortOrder |
Primary sorting field. |
enum (title, dateAdded, assigner) |
|
Query |
direction |
Direction for sorting. |
enum (asc, desc) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Active Book collection |
|
default |
Unexpected error |
2.3.2. Add active book for a user
POST /v2/accounts/{userIdentifier}/activeBooks
Description
Add a book to a specific user’s active books list.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user who owns the active book list. |
string |
FormData |
bookshareId |
The identifier of the book to add. |
string |
FormData |
format |
The format of the title to add to the active list. |
enum (DAISY, DAISY_AUDIO, BRF, EPUB3, PDF, DOCX, PRINT_BRAILLE, HARDCOPY_BRAILLE, MUSIC_BRAILLE, FEELIX_KIT) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Active Book collection |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.3.3. Remove an active book
DELETE /v2/accounts/{userIdentifier}/activeBooks/{activeTitleId}
Description
Remove one of the entries from a specific user’s list of active books.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user who owns the active book list. |
string |
Path |
activeTitleId |
The identifier of the active book resource. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Active Book collection |
|
default |
Unexpected error |
2.3.4. Get active periodicals for a user
GET /v2/accounts/{userIdentifier}/activePeriodicals
Description
Get a list of active periodicals for a specific user that are ready to read.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user who owns the active periodical list. |
string |
|
Query |
start |
If null or empty, it means to start at the beginning of the result set. Otherwise, it should be the value of "next" that was returned from the previous request. |
string |
|
Query |
limit |
Maximum number of results to include. The maximum allowed is 100. |
integer |
|
Query |
sortOrder |
Primary sorting field. |
enum (title, dateAdded, assigner) |
|
Query |
direction |
Direction for sorting. |
enum (asc, desc) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Active Book collection |
|
default |
Unexpected error |
2.3.5. Add active periodical for a user
POST /v2/accounts/{userIdentifier}/activePeriodicals
Description
The user who owns the active periodical list.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the member for which to add the active periodical. |
string |
FormData |
editionId |
The identifier of the periodical to add. |
string |
FormData |
format |
The format of the title to add to the active list. |
enum (DAISY, DAISY_AUDIO, BRF, EPUB3, PDF, DOCX) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Active Book collection |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.3.6. Remove an active periodical
DELETE /v2/accounts/{userIdentifier}/activePeriodicals/{activeTitleId}
Description
Remove one of the entries from a specific user’s list of active periodicals.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user who owns the active periodical list. |
string |
Path |
activeTitleId |
The identifier of the active periodical resource. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Active Periodical collection |
|
default |
Unexpected error |
2.3.7. Get active books profile
GET /v2/accounts/{userIdentifier}/activeBooksProfile
Description
Get a particular user’s choices of properties that guide how titles are added by the system to a user’s active books list.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Active Book Profile |
|
default |
Unexpected error |
2.3.8. Update active books profile
PUT /v2/accounts/{userIdentifier}/activeBooksProfile
Description
Update a particular user’s choices of properties that guide how titles are added by the system to a user’s active books list.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
userIdentifier |
The unique identifying username or userAccountId of the user. |
string |
FormData |
useRecommendations |
True if the system should add to the active books list from system recommendations. The default is false. |
boolean |
FormData |
useRequestList |
True if the system should add to the active books list from the user’s request list. The default is false. |
boolean |
FormData |
maxContributions |
The maximum number of books that will be on the active books list at one time as a result of this profile. |
integer |
FormData |
readingListId |
The unique identifier of a reading list that will be used as the user’s request list. This must be a list that the user is allowed to read. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Active Book Profile |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.4. Membership Assistant - Messages
Membership Assistant users are able to create and manage system and informational messages sent to either a given user account, or to all members of the Assistant’s site.
2.4.1. Get a list of messages
GET /v2/messages
Description
As a membership assistant, get a list of messages based on the inputs given.
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
userIdentifier |
The unique identifying username or userAccountId of the recipient user of the message. Omit if only system messages should be returned. |
string |
|
Query |
messageType |
Type of message, either system-wide or informational direct message to a user. The message type of information should be used along with a userIdentifier. |
enum (system, information) |
|
Query |
sortOrder |
Primary sorting field. |
enum (dateCreated) |
|
Query |
direction |
Direction for sorting. |
enum (asc, desc) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Message detail list response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.4.2. Create a message
POST /v2/messages
Description
Create a new message. This could be specific to a user, or a system-wide message for all users of the site.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
FormData |
text |
The message content. Text is limited to 2000 characters, and must be in UTF-8. |
string |
FormData |
messagePriority |
Relative priority of the message. |
enum (high, medium, low) |
FormData |
messageType |
Type of message, either system-wide or informational. |
enum (system, information) |
FormData |
expirationDate |
The expiration date when the message will be removed. The value should be formatted as 'YYYY-MM-DD'. The date can be up to 90 days in the future. |
string (date) |
FormData |
userIdentifier |
The unique identifying username or userAccountId of the user to receive the message. Omit if this is a system message. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Message detail response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.4.3. Update a message
PUT /v2/messages/{messageId}
Description
As a membership assistant, update a message.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
messageId |
The ID of the message. |
string |
FormData |
read |
Indicates whether the message has been read |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Message detail response |
|
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
2.4.4. Expire a message
DELETE /v2/messages/{messageId}
Description
As a membership assistant, expire a message
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
messageId |
The ID of the message. |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
Message expired |
No Content |
default |
Unexpected error |
Consumes
-
application/x-www-form-urlencoded
3. Definitions
3.1. active_book
Name | Description | Schema |
---|---|---|
activeTitleId |
Unique identifier of the active title. |
string |
allows |
Operations allowed: DELETE |
< enum (DELETE) > array |
assignedBy |
Username of the account that assigned this title. |
string |
book |
The metadata associated with the book. |
|
dateAdded |
The date when this title was added to the active books list. |
string (date-time) |
downloadStatus |
The status of the user’s request for the content, independent of any packaging. |
|
fileResourceStatus |
The status of the ability to provide file resources for the format of the active book. |
|
format |
The format of the content that was requested. |
|
lastUpdated |
Date when the metadata about this book was last updated. |
string (date-time) |
links |
< link > array |
|
packagingStatus |
Deprecated - The status of the work to package the content in preparation for downloading. |
|
size |
Size in bytes of the set of files that make up the active title. |
integer |
status |
Deprecated - See 'packagingStatus' instead. |
3.2. active_book_list
Name | Description | Schema |
---|---|---|
activeTitles |
< active_book > array |
|
allows |
Operations allowed: POST |
< enum (POST) > array |
limit |
Maximum number of results included in this set |
integer |
links |
< link > array |
|
message |
||
next |
Token that can be used as the "start" value to retrieve another group of results |
string |
totalResults |
The number of results found that match the search criteria |
integer |
3.3. active_book_preferences
Name | Description | Schema |
---|---|---|
allows |
Operations allowed: PUT |
< enum (PUT) > array |
format |
Preferred format when downloading a title. Can be used by clients to suggest a title’s format when that format is available. |
|
language |
Language preference of the user. The value will be a three-character ISO 639-2 alpha-3 language code. |
string |
links |
< link > array |
3.4. active_book_profile
Name | Description | Schema |
---|---|---|
allows |
Operations allowed: PUT |
< enum (PUT) > array |
links |
< link > array |
|
maxContributions |
The maximum number of books that will be on the active books list at one time as a result of this profile. |
integer |
preferences |
||
recommendationProfile |
||
requestList |
||
useRecommendations |
True if the system should add to the active books list from system recommendations. The default is false. |
boolean |
useRequestList |
True if the system should add to the active books list from the user’s request list. The default is false. |
boolean |
3.5. active_periodical
Name | Description | Schema |
---|---|---|
activeTitleId |
Unique identifier of the active title. |
string |
allows |
Operations allowed: DELETE |
< enum (DELETE) > array |
assignedBy |
Username of the account that assigned this title. |
string |
dateAdded |
The date when this title was added to the active periodicals list. |
string (date-time) |
downloadStatus |
The status of the user’s request for the content, independent of any packaging. |
|
fileResourceStatus |
The status of the ability to provide file resources for the given format. |
|
format |
The format of the content that was requested. |
|
lastUpdated |
Date when the metadata about this book was last updated. |
string (date-time) |
links |
< link > array |
|
packagingStatus |
Deprecated - The status of the work to package the content in preparation for downloading. |
|
periodical |
||
seriesId |
Unique identifier of the periodical series. |
string |
size |
Size in bytes of the set of files that make up the active title. |
integer |
status |
Deprecated - See 'packagingStatus' instead. |
|
title |
Title of the periodical. |
string |
3.6. active_periodical_list
Name | Description | Schema |
---|---|---|
activeTitles |
< active_periodical > array |
|
allows |
Operations allowed: POST |
< enum (POST) > array |
limit |
Maximum number of results included in this set |
integer |
links |
< link > array |
|
message |
||
next |
Token that can be used as the "start" value to retrieve another group of results |
string |
totalResults |
The number of results found that match the search criteria |
integer |
3.7. address
Name | Description | Schema |
---|---|---|
address1 |
The primary street address. |
string |
address2 |
Extra street address information, if any. |
string |
city |
A city name. |
string |
country |
The country code. The value will be an ISO 3166 alpha-2 country code. |
string |
postalCode |
The postal code, if any, for the given address. |
string |
state |
The state or province or other subdivision of the country. The value will be an ISO-3166-2 subdivision code for the associated country. |
string |
3.8. category
Name | Description | Schema |
---|---|---|
categoryType |
Category type, Bookshare or BISAC |
enum (Bookshare, BISAC) |
code |
Code that represents the category, may be null. |
string |
description |
Descriptive name of the subject category, localized when possible to the user’s locale. |
string |
links |
< link > array |
|
name |
Identifier of the subject category |
string |
3.9. content_warning_values
Type : enum (contentWarning, sex, violence, drugs, language, intolerance, adult, unrated)
3.10. contributor
Name | Description | Schema |
---|---|---|
links |
< link > array |
|
name |
The contributor’s name. |
|
type |
Type of contributor to a title or artifact. |
enum (author, coWriter, epilogueBy, forwardBy, introductionBy, editor, composer, arranger, lyricist, translator, transcriber, abridger, adapter) |
3.11. contributor_name
Name | Description | Schema |
---|---|---|
displayName |
Name as a full combination of all parts, first name before last name. |
string |
indexName |
Name as it would be indexed for sorting. |
string |
links |
< link > array |
3.12. download_timeframe
Name | Description | Schema |
---|---|---|
name |
Descriptive name of the timeframe for download limits. |
enum (monthly, entireSubscription) |
3.13. error_model
Name | Schema |
---|---|
key |
string |
messages |
< string > array |
3.14. format
Name | Description | Schema |
---|---|---|
formatId |
Unique identifier of the format. |
string |
name |
Descriptive name of the format, suitable for display. |
string |
3.15. link
Name | Description | Schema |
---|---|---|
href |
An absolute or relative URI for a resource request |
string |
rel |
A relationship name |
string |
3.16. myaccount_preferences
Name | Description | Schema |
---|---|---|
allowAdultContent |
True if the user is allowed to find and download titles marked with adult content. This defaults to false for members who are minors. |
boolean |
brailleCellLineWidth |
The maximum number of cells to create per line when generating BRF. For refreshable Braille, the allowed values are 18, 20, 32, 40, 70, or 80. For embossable Braille, the allowed values are 28 and 40. |
integer |
brailleFormat |
The format of the Braille (refreshable or embossable) that will be created when downloading generated BRF. |
enum (refreshable, embossable) |
brailleGrade |
The preferred Braille grade (uncontracted or contracted) when downloading generated BRF. |
enum (uncontracted, contracted) |
format |
Preferred format when downloading a title. Can be used by clients to suggest a title’s format when that format is available. |
|
language |
Language preference of the user. The value will be a three-character ISO 639-2 alpha-3 language code. |
string |
links |
< link > array |
|
showAllBooks |
True if books marked as low quality should be included in search results. The default is false. |
boolean |
showRecommendations |
True if the user would like to opt-in to receiving personalized recommendations. The default is true. |
boolean |
useUeb |
True if English-language books should use UEB, rather than EBAE when downloading generated BRF. The default is false. |
boolean |
3.17. name
Name | Description | Schema |
---|---|---|
firstName |
First name of the individual or entity |
string |
lastName |
Last name of the individual or entity |
string |
links |
< link > array |
|
middle |
Middle name, or initial, if any |
string |
prefix |
Prefix, if any, such as Mr., Mrs., Dr. |
string |
suffix |
Suffix, if any, such as Jr., Sr., III |
string |
3.18. organization
Name | Description | Schema |
---|---|---|
address |
The organization’s address. |
|
hasOrgAgreement |
True if current signed organitzational membership agreement is on file. |
boolean |
links |
< link > array |
|
organizationId |
Unique identifier of the organization |
string |
organizationName |
The name of the organization |
string |
organizationType |
The type of organization. |
string |
phoneNumber |
The organization’s phone number. |
string |
primaryContact |
The primary contact for the organization. |
|
site |
The organization’s site. |
string |
subscriptionType |
The organization’s subscription type. |
string |
webSite |
The organization’s website. |
string |
3.19. organization_type
Possible values at /v2/organizationTypes
Name | Description | Schema |
---|---|---|
description |
Description of the organization type |
string |
name |
Unique descriptive name of the organization type |
string |
3.20. organization_type_list
Name | Description | Schema |
---|---|---|
links |
< link > array |
|
organizationTypes |
List of organization types |
< organization_type > array |
3.21. periodical_edition
Name | Description | Schema |
---|---|---|
editionId |
Unique identifier of a periodical edition |
string |
editionName |
Name of the edition |
string |
expirationDate |
Expiration date of the edition |
string (date-time) |
formats |
Available formats |
< format > array |
links |
< link > array |
|
publicationDate |
Publication date of the edition |
string (date-time) |
3.22. periodical_edition_summary
Name | Description | Schema |
---|---|---|
editionId |
Unique identifier of the periodical edition |
string |
editionName |
Name of the edition |
string |
3.23. periodical_series_metadata_summary
Name | Description | Schema |
---|---|---|
categories |
Categories of the periodical |
< category > array |
countries |
Countries to which this periodical is restricted for distribution. The values should be a two-character ISO 3166 alpha-2 country code. |
< string > array |
description |
Description of the periodical |
string |
editionCount |
The number of editions available for this periodical |
integer |
externalCategoryCode |
External Category Code |
string |
issn |
ISSN of the periodical |
string |
languages |
Languages of the periodical. The value will be a three-character ISO 639-2 alpha-3 language code |
< string > array |
latestEdition |
||
links |
< link > array |
|
publisher |
Publisher of the periodical |
string |
seriesId |
Unique identifier of the periodical series |
string |
seriesType |
Type of periodical |
enum (newspaper, magazine, journal) |
title |
Title of the periodical |
string |
3.24. periodical_subscription
Name | Description | Schema |
---|---|---|
dateSubscribed |
Date that the subscription to the reading list started |
string (date-time) |
format |
The format of the periodical edition artifact |
string |
links |
< link > array |
|
periodical |
Periodical series |
3.25. periodical_subscription_list
Name | Schema |
---|---|
links |
< link > array |
titles |
< periodical_subscription > array |
3.26. reading_list
Name | Description | Schema |
---|---|---|
access |
Visibility of the list |
enum (private, shared, org) |
allows |
Operations allowed: PUT = edit metadata |
< enum (PUT) > array |
assignedBy |
If the current user is a member of the the list, the display name of the user who assigned them |
string |
dateUpdated |
Date that the reading list was last updated |
string (date-time) |
description |
Description of the list given by the owner |
string |
links |
< link > array |
|
memberCount |
Number of organization members assigned to this reading list |
integer |
name |
Name given by the owner |
string |
owner |
Display name of the owner |
string |
readingListId |
Unique identifier of the reading list |
string |
subscriberCount |
Number of users subscribed in this reading list |
integer |
titleCount |
Number of titles contained in this reading list |
integer |
3.27. reading_list_list
Name | Description | Schema |
---|---|---|
allows |
Operations allowed: POST = create a new list |
< enum (POST) > array |
limit |
Maximum number of results included in this set |
integer |
links |
< link > array |
|
lists |
< reading_list_user_view > array |
|
next |
Token that can be used as the "start" value to retrieve another group of results |
string |
totalResults |
The number of results found that match the search criteria |
integer |
3.28. reading_list_subscription
Name | Description | Schema |
---|---|---|
allows |
Operations allowed: PUT = subscribe or unsubscribe |
< enum (PUT) > array |
enabled |
User is subscribed to this reading list |
boolean |
links |
< link > array |
3.29. reading_list_user_view
Name | Description | Schema |
---|---|---|
access |
Visibility of the list |
enum (private, shared, org) |
allows |
Operations allowed: None. See full reading list resource for capabilities |
< string > array |
assignedBy |
If the current user is a member of the the list, the display name of the user who assigned them |
string |
dateUpdated |
Date that the reading list was last updated |
string (date-time) |
description |
Description of the list given by the owner |
string |
links |
< link > array |
|
memberCount |
Number of organization members assigned to this reading list |
integer |
name |
Name given by the owner |
string |
owner |
Display name of the owner |
string |
readingListId |
Unique identifier of the reading list |
string |
subscription |
||
titleCount |
Number of titles contained in this reading list |
integer |
3.30. recommendation_profile
Name | Description | Schema |
---|---|---|
allows |
Operations allowed: PUT |
< enum (PUT) > array |
excludedAuthors |
Limit results to titles that match none of the given authors. |
< string > array |
excludedCategories |
Limit results to titles that match none of the given Bookshare categories. |
< category > array |
excludedContentWarnings |
Limit results to titles that match none of the given content warnings. |
< content_warning_values > array |
includeGlobalCollection |
True if the recommendation system should suggest titles from the Bookshare Global Collection. This defaults to false for members of private label sites. |
boolean |
includedAuthors |
Limit results to titles that match at least one of the given authors. |
< string > array |
includedCategories |
Limit results to titles that match at least one of the given Bookshare categories. |
< category > array |
includedContentWarnings |
Deprecated - Limit results to titles that match at least one of the given content warnings. |
< content_warning_values > array |
links |
< link > array |
|
narratorGender |
Limit results to the given narrator’s gender. |
enum (male, female, otherNonBinary) |
narratorType |
Limit results to the given source of speech. |
enum (tts, human) |
readingAge |
Limit results to titles that include the given reading age. |
integer |
3.31. sponsor
Name | Description | Schema |
---|---|---|
allowAdultContent |
True if the sponsor is allowed to find and download titles marked with adult content. |
boolean |
canDownload |
True if sponsor account can download titles. |
boolean |
deleted |
True if sponsor account is deleted. |
boolean |
emailAddress |
The sponsor’s email address. |
string |
hasAgreement |
True if current signed agreement is on file. |
boolean |
language |
Language preference of the sponsor. The value will be a three-character ISO 639-2 alpha-3 language code |
string |
links |
< link > array |
|
locked |
True if sponsor account is locked. |
boolean |
name |
The sponsor’s name. |
|
phoneNumber |
The sponsor’s preferred phone number. |
string |
site |
The site with which the user is associated. This will be used to define what titles are available to the user, since titles are also designated with an associated site. |
string |
title |
The sponsor’s title. |
string |
3.32. status_model
Name | Schema |
---|---|
key |
string |
messages |
< string > array |
3.33. title_link
Name | Description | Schema |
---|---|---|
href |
An absolute or relative URI for a resource request. |
string |
rel |
A relationship name. |
enum (self, coverimage, thumbnail, download, history, titleSource, replacement, submitter) |
title |
Descriptive text that could be used as link text. |
string |
type |
Media type that this link is expected to return. |
string |
3.34. title_metadata_summary
Name | Description | Schema |
---|---|---|
allows |
Operations allowed: PUT, for Collection Assistants |
< enum (PUT) > array |
arrangers |
Deprecated - Arrangers of the sheet music |
< name > array |
authors |
Deprecated - Author names of the title |
< name > array |
available |
True if the title is potentially available to users. See 'formats' for the ways the current user is allowed to request the title |
boolean |
bookshareId |
Unique identifier of the title |
string |
categories |
Categories of the title |
< category > array |
composers |
Deprecated - Composer names of the sheet music |
< name > array |
contentWarnings |
List of content warnings for the title |
< content_warning_values > array |
contributors |
Contributors to the title |
< contributor > array |
copyrightDate |
The copyright year of this title |
string (year) |
externalFormats |
Formats in which the title is available, but which are not deliverable by the API. Access to these formats must be negotiated with the site responsible for the title. |
< format > array |
formats |
Formats in which the title is available |
< format > array |
instruments |
Instruments of the sheet music |
string |
isbn13 |
ISBN of the book or reading material |
string |
languages |
Languages of the title. The value will be a three-character ISO 639-2 alpha-3 language code |
< string > array |
lexileCode |
The 2-letter Lexile code describing additional information about the readability of the book. |
string |
lexileNumber |
The numeric Lexile measure describing the readability of the book, followed by an 'L'. |
string |
links |
< title_link > array |
|
lyricists |
Deprecated - Lyricists of the sheet music |
< name > array |
publishDate |
The date this title was added to the collection |
string (date-time) |
readingAgeMaximum |
The maximum reading age for which the book is recommended |
integer |
readingAgeMinimum |
The minimum reading age for which the book is recommended |
integer |
seriesNumber |
Number of the book within the series to which it belongs |
string |
seriesTitle |
Title of the series to which the book belongs, if applicable |
string |
site |
The site with which the title is associated |
string |
subtitle |
Subtitle of the book or reading material |
string |
synopsis |
Synopsis of the title |
string |
title |
Title of the book or reading material |
string |
titleContentType |
General type of content found in this title. Most titles will be text, but specialized titles could be primarily content like music scores or graphic images. |
string |
translators |
Deprecated - Translators of the sheet music |
< name > array |
vocalParts |
Vocal parts of the sheet music |
string |
3.35. user_account
Name | Description | Schema |
---|---|---|
address |
The user’s primary address. |
|
allowAdultContent |
True if the user is allowed to find and download titles marked with adult content. |
boolean |
canDownload |
True if user account can download titles. |
boolean |
dateOfBirth |
The user’s date of birth. The value will be formatted as 'YYYY-MM-DD'. |
string |
deleted |
True if user account is deleted. |
boolean |
emailAddress |
The user’s email address. This also serves as the username. |
string |
grade |
The user’s current grade. Values are from ONIX codelist 77 for US grades, BIC for UK grades. |
string |
guardian |
The user’s guardian’s name, if the user is a minor. |
|
hasAgreement |
True if current signed agreement is on file. |
boolean |
language |
Language preference of the user. The value will be a three-character ISO 639-2 alpha-3 language code |
string |
links |
< link > array |
|
locked |
True if user account is locked. |
boolean |
name |
The user’s name. |
|
phoneNumber |
The user’s preferred phone number. |
string |
proofOfDisabilityStatus |
Status of proof of disability. |
enum (active, missing) |
roles |
The roles assigned to the user. These define some of the boundaries on features available to the user. |
< string > array |
site |
The site with which the user is associated. This will be used to define what titles are available to the user, since titles are also designated with an associated site. |
string |
subscriptionStatus |
Status of subscription. |
enum (active, expired, missing) |
userAccountId |
Unique identifier of the user account |
string |
3.36. user_account_list
Name | Description | Schema |
---|---|---|
allows |
Operations allowed: POST = create new organization member |
< enum (POST) > array |
links |
< link > array |
|
next |
Token that can be used as the "start" value to retrieve another group of results |
string |
totalResults |
The number of results found that match the search criteria |
integer |
userAccounts |
< user_account > array |
3.37. user_message_detail
Name | Description | Schema |
---|---|---|
allows |
Operations allowed: DELETE = remove this message, PUT = mark this message as read |
< string > array |
createdBy |
The username of the person who created the message. |
string |
createdDate |
The date this message was created. |
string (date-time) |
expirationDate |
The date this message will be automatically removed. |
string (date-time) |
links |
< link > array |
|
messageId |
The unique message identifier. |
string |
messageType |
The type of message, either informational, or system-wide. System messages will typically alert all users to a planned outage or system change, and informational messages will typically alert an individual user about something specific to their account. |
enum (information, system) |
priority |
The priority of the message, either low, medium or high. |
enum (high, medium, low) |
read |
True if the message has been marked as read by the user. |
boolean |
text |
The message text. |
string |
3.38. user_message_detail_list
Name | Description | Schema |
---|---|---|
links |
< link > array |
|
messages |
List of detailed user messages |
< user_message_detail > array |
3.39. user_pod
Name | Description | Schema |
---|---|---|
disabilityType |
The type of disability. |
string |
proofSource |
The organization who has verified the given disability. |
string |
3.40. user_pod_list
Name | Description | Schema |
---|---|---|
allows |
Operations allowed: POST = add new disability proof, DELETE = remove a disability proof, PUT = update a disability proof |
< string > array |
disabilities |
List of user proofs of disability |
< user_pod > array |
links |
< link > array |
3.41. user_signed_agreement
Name | Description | Schema |
---|---|---|
agreementId |
The ID of the agreement. |
string |
agreementType |
The type of signed agreement. |
enum (individual, volunteer, sponsor) |
dateExpired |
The date of agreement expiration. |
string |
dateSigned |
The date of agreement signing. |
string |
printName |
The print name of the signing user signing the agreement. |
string |
recordingUser |
The username of the recording user. |
string |
signedByLegalGuardian |
True if the agreement was signed by legal guardian. |
boolean |
username |
The username of the signed agreement owner. |
string |
3.42. user_signed_agreement_list
Name | Description | Schema |
---|---|---|
allows |
Operations allowed: None |
< string > array |
links |
< link > array |
|
signedAgreements |
List of user signed agreements |
< user_signed_agreement > array |
3.43. user_subscription
Name | Description | Schema |
---|---|---|
downloadTimeframe |
The timeframe for download limits on a user subscription |
|
endDate |
Date that the user subscription ends |
string (date-time) |
links |
< link > array |
|
notes |
Notes about the user subscription |
string |
numBooksAllowed |
Number of books allowed |
integer |
startDate |
Date that the user subscription starts |
string (date-time) |
subscriptionId |
Unique identifier of the user subscription |
string |
userSubscriptionType |
Type of user subscription |
3.44. user_subscription_list
Name | Description | Schema |
---|---|---|
allows |
Operations allowed: None |
< string > array |
limit |
Maximum number of results included in this set |
integer |
links |
< link > array |
|
next |
Token that can be used as the "start" value to retrieve another group of results |
string |
totalResults |
The number of user subscriptions found that match the search criteria |
integer |
userSubscriptions |
List of user subscriptions |
< user_subscription > array |
3.45. user_subscription_type
Possible values at /v2/subscriptiontypes
Name | Description | Schema |
---|---|---|
description |
Description of the user subscription type |
string |
name |
Unique descriptive name of the user subscription type |
string |
3.46. user_subscription_type_list
Name | Description | Schema |
---|---|---|
links |
< link > array |
|
userSubscriptionTypes |
List of subscription types |
< user_subscription_type > array |