GET /portal/api/books/:book_id/annotation_sets/:annotation_set_id/acl_entries/contacts
List of ACL contact entries

Supported Formats

json

Examples

app/views/portal/api/acl_entries/contacts/index.json.rabl

Params

Param name Description
id
required

Unique identifier for the annotation set model that determines which ACL entries will be show.

Validations:

  • Must be Integer

book_id
required

Unique identifier for the book model that determines which ACL entries will be shown.

Validations:

  • Must be Integer


GET /portal/api/books/:book_id/annotation_sets/:annotation_set_id/acl_entries/contacts/:id
Show an ACL contact entry

Supported Formats

json

Examples

app/views/portal/api/acl_entries/contacts/show.json.rabl

Params

Param name Description
id
required

Unique identifier for the ACL entry model that determines which ACL entry will be shown.

Validations:

  • Must be Integer

annotation_set_id
required

Unique identifier for the annotation set model that determines which ACL entries will be show.

Validations:

  • Must be Integer

book_id
required

Unique identifier for the book model that determines which ACL entries will be shown.

Validations:

  • Must be Integer


POST /portal/api/books/:book_id/annotation_sets/:annotation_set_id/acl_entries/contacts
Create a ACL contact entry

Supported Formats

json

Examples

app/views/portal/api/acl_entries/contacts/show.json.rabl

Params

Param name Description
annotation_set_id
required

Unique identifier for the annotation set model that determines which annotation set the ACL entry will belong to.

Validations:

  • Must be Integer

book_id
required

Unique identifier for the book model that determines which annotation set the ACL entry will belong to.

Validations:

  • Must be Integer

user_id
required

Unique identifier for the user model that determines which user will be granted access. Not required if contact_id is specified.

Validations:

  • Must be Integer

contact_id
optional

Unique identifier for the contact model that determines which contact will be granted access. Not required if user_id is specified. user_id will take precedence if both are included.

Validations:

  • Must be Integer

type
optional

Type of the ACL contact entry. This determines whether the corresponding user can create new annotation sets or just read existing ones.

Validations:

  • Must be one of: readonly, create_as.

expiration
optional

Date and time that the entry's access will expire at.

Validations:

  • Must be DateTime


PATCH /portal/api/books/:book_id/annotation_sets/:annotation_set_id/acl_entries/contacts/:id
Update an ACL contact

PUT /portal/api/books/:book_id/annotation_sets/:annotation_set_id/acl_entries/contacts/:id
Update an ACL contact

Supported Formats

json

Examples

app/views/portal/api/annotation_sets/acl_entries/contacts/show.json.rabl

Params

Param name Description
id
required

Unique identifier for the ACL entry model that determines which ACL entry will be updated.

Validations:

  • Must be Integer

annotation_set_id
required

Unique identifier for the annotation set model that determines which ACL entry will be updated.

Validations:

  • Must be Integer

book_id
required

Unique identifier for the book model that determines which ACL entry will be updated.

Validations:

  • Must be Integer

type
required

Type of the ACL contact entry. This determines whether the corresponding user can create new annotation sets or just read existing ones.

Validations:

  • Must be one of: readonly, create_as.

expiration
optional

Date and time that the entry's access will expire at.

Validations:

  • Must be DateTime


DELETE /portal/api/books/:book_id/annotation_sets/:annotation_set_id/acl_entries/contacts/:id
Destroy (revoke access for) an ACL contact

Supported Formats

json

Examples

app/views/portal/api/annotation_sets/acl_entries/contacts/show.json.rabl

Params

Param name Description
id
required

Unique identifier for the ACL entry model that determines which ACL entry will be destroyed.

Validations:

  • Must be Integer

annotation_set_id
required

Unique identifier for the annotation set model that determines which ACL entry will be destroyed.

Validations:

  • Must be Integer

book_id
required

Unique identifier for the book model that determines which ACL entry will be destroyed.

Validations:

  • Must be Integer


Supported Formats

json

Examples

app/views/portal/api/acl_entries/contacts/show.json.rabl

Params

Param name Description
annotation_set_id
optional

Unique identifier for the annotation set model that determines which annotation set the ACL entry will belong to. if omit, it means book itself

Validations:

  • Must be Integer

book_id
required

Unique identifier for the book model that determines which annotation set the ACL entry will belong to.

Validations:

  • Must be Integer

user_id
required

Unique identifier for the user model that determines which user will be granted access. Not required if user_email is specified.

Validations:

  • Must be Integer

user_email
optional

Unique identifier for the user model that determines which user will be granted access. Not required if user_id is specified. user_id will take precedence if both are included.

Validations:

  • Must be String


Supported Formats

json

Examples

app/views/portal/api/annotation_sets/acl_entries/contacts/show.json.rabl

Params

Param name Description
user_id
required

Unique identifier for the user model that determines which user will be revoked access. Not required if user_email is specified.

Validations:

  • Must be Integer

user_email
optional

Unique identifier for the user model that determines which user will be revoked access. Not required if user_id is specified. user_id will take precedence if both are included.

Validations:

  • Must be String

annotation_set_id
required

Unique identifier for the annotation set model that determines which ACL entry will be destroyed.

Validations:

  • Must be Integer

book_id
required

Unique identifier for the book model that determines which ACL entry will be destroyed.

Validations:

  • Must be Integer


DELETE /portal/api/books/:book_id/annotation_sets/:annotation_set_id/acl_entries/forfeit
User can forfeit (revoke access for) their own contact access

Supported Formats

json

Examples

app/views/portal/api/annotation_sets/acl_entries/contacts/show.json.rabl

Params

Param name Description
annotation_set_id
required

Unique identifier for the annotation set model that determines which ACL entry will be forfeited.

Validations:

  • Must be Integer

book_id
required

Unique identifier for the book model that determines which ACL entry will be destroyed.

Validations:

  • Must be Integer