Recent changes to EditionAPIStructures

EditionAPIStructures modified by Domhnall101

Domhnall101 — Tue, 06 Oct 2015 20:01:39 -0000

--- v12
+++ v13
@@ -1,4 +1,5 @@
 Draft 2015-03-26
+##Edition API Structures

 ### Basic Types ###

Edition API Structures modified by Eric Smith

Eric Smith — Thu, 26 Mar 2015 20:20:59 -0000

--- v11
+++ v12
@@ -1,4 +1,4 @@
-Draft 2014-10-29
+Draft 2015-03-26

 ### Basic Types ###

@@ -64,21 +64,31 @@
 ### Permission ###

 #### Long-form ####
-Includes name and email address of User associated so that an extra call is not necessary.  Used in Edition.permissions.
+Includes name and email address of User associated so that an extra call is not necessary.  Returned in `Edition.permissions`, `Manifest.permissions`, `Transcription.permissions`, and `Publication.permissions`.

 \{
    "id": ID,
    "role": "NONE"|"VIEWER"|"CONTRIBUTOR"|"EDITOR"|"OWNER",
-   "user": User ID,
+   "user": User ID
    "name": User's full name,
    "mail": User's email address,
+   "target": Edition, Manifest, or Transcription URI
+}
+
+#### Short-form ####
+
+Used when PUTting to `/edition/`*edID*`/permissions`, `/transcription/`*transcrID*`/permissions`, `/manifest/`*manID*`/permissions`, or `/publication/`*pubID*`/permissions`.
+
+\{
+   "role": "NONE"|"VIEWER"|"CONTRIBUTOR"|"EDITOR"|"OWNER",
+   "user": User ID (0 to indicate the "public sharing" user).
    "target": Edition, Manifest, or Transcription URI
 }

 ### Witness ###

 #### Short-form ####
-Used in Edition.witnesses.
+Returned in Edition.witnesses.

 \{
    "id": ID,

Edition API Structures modified by Eric Smith

Eric Smith — Wed, 29 Oct 2014 19:41:24 -0000

--- v10
+++ v11
@@ -1,3 +1,5 @@
+Draft 2014-10-29
+
 ### Basic Types ###

 #### ID ####
@@ -15,7 +17,8 @@
    "title": string,
    "creator": User ID,
    "permissions": array of long-form Permissions,
-   "witnesses": array of short-form Witnesses
+   "witnesses": array of short-form Witnesses,
+   "outlines": array of Outline IDs
 }

 ### Outline ###

Edition API Structures modified by Eric Smith

Eric Smith — Wed, 29 Oct 2014 19:16:26 -0000

--- v9
+++ v10
@@ -15,8 +15,7 @@
    "title": string,
    "creator": User ID,
    "permissions": array of long-form Permissions,
-   "witnesses": array of short-form Witnesses,
-   "outlines": array of Outline IDs
+   "witnesses": array of short-form Witnesses
 }

 ### Outline ###

Edition API Structures modified by Eric Smith

Eric Smith — Thu, 02 Oct 2014 23:32:38 -0000

Tradamus Server API Structures modified by Eric Smith

Eric Smith — Sat, 26 Jul 2014 23:54:14 -0000

--- v7
+++ v8
@@ -4,7 +4,9 @@
 An integer serving as the primary key of a table.

 #### Target URI ####
-Within Tradamus, each entity can be uniquely identified by means of a URI-like string (e.g. "edition/2" or "annotation/1234".
+Within Tradamus, each entity can be uniquely identified by means of a URI-like string (e.g. "edition/2" or "annotation/1234").
+
+In some cases, these URIs may include a fragment to further specify the target.  Thus, "parallel/11#3" specifies to the portion of "parallel/11" which draws from "witness/3".  For a Canvas-targetted annotation, the fragment can specify the portion of the Canvas which is targetted (e.g. "canvas/12#xywh=10,10,320,240" to target a rectangular area within "canvas/12").

 ### Edition ###

Tradamus Server API Structures modified by Eric Smith

Eric Smith — Sat, 26 Jul 2014 23:48:30 -0000

--- v6
+++ v7
@@ -23,6 +23,7 @@
 \{
    "id": ID,
    "title": string,
+   "index":int,
    "bounds": array of Annotations (null for full-Edition outline)
    "edition": Edition ID,
    "decisions": array of Decisions
@@ -39,6 +40,7 @@

 ### Annotation ###
+\{
    "id": ID,
    "content": string,
    "type": string,

Tradamus Server API Structures modified by Eric Smith

Eric Smith — Sat, 26 Jul 2014 23:47:29 -0000

--- v5
+++ v6
@@ -25,7 +25,33 @@
    "title": string,
    "bounds": array of Annotations (null for full-Edition outline)
    "edition": Edition ID,
-   "decisions": array of "tr-decision" Annotations
+   "decisions": array of Decisions
+}
+
+
+### Decision ###
+\{
+   "id": ID,
+   "content": string,
+   "type": "tr-decision",
+   "motes": array of Annotations having "type":"tr-mote"
+}
+
+
+### Annotation ###
+   "id": ID,
+   "content": string,
+   "type": string,
+   "target": URI of Tradamus object (may include fragment),
+   "startPage": Page ID,
+   "startOffset": int,
+   "endPage": Page ID,
+   "endOffset": int,
+   "canvas": URI of Canvas (may include fragment)
+   "attributes": map containing key/value pairs,
+   "tags": string,
+   "modifiedBy": User ID,
+   "approvedBy": User ID
 }

Tradamus Server API Structures modified by Eric Smith

Eric Smith — Wed, 23 Jul 2014 20:30:13 -0000

--- v4
+++ v5
@@ -25,7 +25,7 @@
    "title": string,
    "bounds": array of Annotations (null for full-Edition outline)
    "edition": Edition ID,
-   "motes": array of "tr-mote" Annotations
+   "decisions": array of "tr-decision" Annotations
 }

Discussion for Tradamus Server API Structures page

Patrick — Wed, 25 Jun 2014 16:00:14 -0000

Outlines also have an index here, yes?