LearningRegistry Bookshare Mapping

Skip to end of metadata
Go to start of metadata

Resource Data Description Data Model


The resource data description is a JSON document. The elements of the document are described below in the following format:


Element Description Bookshare Attribute Required Immutable
element_name
data_type (encoding)
About the element. Literal or Bookshare API attribute ■ True □ False
◘ Conditional
■ True
□ False
◘ Conditional


{          
  doc_type
resource_data
The literal "resource_data" "resource_data"
  doc_version
literal
The literal for the current LR Spec version. (e.g. "0.23.0")  


  General elements about the submission.
doc_ID
string
Unique document ID within scope of the LR.  
resource_data_type
string
Open (best practices) vocabulary ["paradata", "resource", "assertion", ...] "resource"
active
Boolean
Is the resource data description document active? true


  Information about the submission, independent of the resource data.
identity Identity and curation


{ submitter_type
string
Fixed vocabulary ["anonymous", "user", "agent"] "agent"
  submitter
string
Identity of the submitter of the resource data. "Bookshare"
  curator
string
Identity of the curator of the resource data description. Not applicable  
  owner
string
Identity of the owner of the resource. author from search results  
  signer
string
Identity of key owner used to sign the submission. "Benetech"  
}          


  Submission and distribution workflow information.
submitter_timestamp
string (time/date)
Submitter-created timestamp. Required for Bookshare
submitter_TTL
string (time/date)
Submitter statement of TTL of validity of submission. Not applicable
publishing_node
string
Node_id of node where injected into the network.  
node_timestamp
string (time/date)
Timestamp of when received by the current node.  
create_timestamp
string (time/date)
Timestamp of when first published to the network.  


 
TOS  


{ submission_TOS
string
Agreed terms of service by submitter "http://www.learningregistry.org/tos/cc0/v0-5/"
  submission_attribution
string
Attribution statement from submitter Not applicable
}          
  Information about the resource, independent of the resource data.
resource_locator
string
Unique locator for the resource described
Shall resolve to a single unique resource
http://bookshare.org/browse/book/ + Bookshare Book ID
keys
["string1","string2",...]
Array of hashtag, keyword value list used for filtering "Accessible", "AIM", add keys "DAISY", "Z39.86" and "DAISY 3" if format 1 is available, add keys "Braille" and "BRF" if format 0 is available, ISBN13, Title, Author(s), Publisher, Categorie(s)
resource_TTL
integer
TTL from resource owner for the resource itself, in days Not applicable

We need to decide what will go in the payload.  There is a discussion at: https://groups.google.com/d/topic/learningreg-dev/dX7ch9AnZjk/discussion on this topic.

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.