Macat MVP

This is the Macat Digital Library MVP.
More information: https://openapi-generator.tech
Contact Info: tim@timcowlishaw.co.uk
Version: 1.0.0
BasePath:
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Closed

Open

Paywalled

Closed

Up 
get /book/{publicationURL}/bibliography
(bookPublicationURLBibliographyGet)

Path parameters

publicationURL (required)
Path Parameter — default: null

Return type

array[BibliographyItem]

Example data

Content-Type: application/json
{
  "publication" : "The Politics of Immigration in Multi-Level States",
  "position" : 0,
  "content" : "Hepburn, Eve, and Ricard Zapata-Barrero, eds. The Politics of Immigration in Multi-Level States. London: Palgrave, 2014."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The book's bibliography is succesfully returned

401

The user is not logged in Error

404

the book does not exist Error
Up 
get /book/{publicationURL}/glossary
(bookPublicationURLGlossaryGet)

Path parameters

publicationURL (required)
Path Parameter — default: null

Return type

array[GlossaryItem]

Example data

Content-Type: application/json
{
  "textIdentifier" : "Agency",
  "position" : 0,
  "label" : "Agency:",
  "synopsis" : "philosophical term for the capacity to act with free will.",
  "type" : "Term"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The books glossary is succesfully returned

401

The user is not logged in Error

404

the book does not exist Error
Up 
get /book/{publicationURL}/overview
(bookPublicationURLOverviewGet)

Path parameters

publicationURL (required)
Path Parameter — default: null

Return type

BookFull

Example data

Content-Type: application/json
{
  "overview" : "The overview of the book",
  "ISBN" : "9781912127764",
  "synopsis" : "The synopsis of the book",
  "id" : "c602f351-cea6-46d0-8ab6-813e77dc1728",
  "title" : "Gender Trouble",
  "publicationURL" : "gender-trouble-feminism-and-the-subversion-of-identity--analysis",
  "authors" : [ {
    "isAlive" : true,
    "isTopicAuthor" : true,
    "name" : "Judith Butler",
    "position" : 0,
    "id" : "1edf74e7-bb04-4ed4-b1aa-9e9dd678ed47",
    "biography" : "American philosopher and gender theorist Judith Butler was born in Ohio in 1956..."
  }, {
    "isAlive" : true,
    "isTopicAuthor" : true,
    "name" : "Judith Butler",
    "position" : 0,
    "id" : "1edf74e7-bb04-4ed4-b1aa-9e9dd678ed47",
    "biography" : "American philosopher and gender theorist Judith Butler was born in Ohio in 1956..."
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The overview of the book is successfully returned BookFull

404

the book does not exist Error

Open

Up 
get /books
(booksGet)

Query parameters

page (optional)
Query Parameter — default: 0
per_page (optional)
Query Parameter — default: 25

Return type

array[BookOverview]

Example data

Content-Type: application/json
{
  "ISBN" : "9781912127764",
  "id" : "c602f351-cea6-46d0-8ab6-813e77dc1728",
  "title" : "Gender Trouble",
  "publicationURL" : "gender-trouble-feminism-and-the-subversion-of-identity--analysis",
  "authors" : [ {
    "isTopicAuthor" : true,
    "name" : "Judith Butler",
    "position" : 0,
    "id" : "1edf74e7-bb04-4ed4-b1aa-9e9dd678ed47"
  }, {
    "isTopicAuthor" : true,
    "name" : "Judith Butler",
    "position" : 0,
    "id" : "1edf74e7-bb04-4ed4-b1aa-9e9dd678ed47"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

A list of books is successfully returned
Up 
delete /session
Ends the current session if it exists (sessionDelete)

Return type

Message

Example data

Content-Type: application/json
{
  "message" : "the parameters provided failed validation",
  "status" : 422
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The session is succesfully ended Message

404

No session exists for the current user Error
Up 
get /session
Displays the current session if it exists (sessionGet)

Return type

User

Example data

Content-Type: application/json
{
  "role" : {
    "name" : "user"
  },
  "id" : "aaadcde9-d877-436a-b66b-19acd31d2574",
  "email" : "user@example.com"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The user is successfully retrieved, we return their id and role User

404

No session exists for the current user Error
Up 
post /session
Creates a new session for a registered user (sessionPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

inline_object_1 inline_object_1 (optional)
Body Parameter —

Return type

User

Example data

Content-Type: application/json
{
  "role" : {
    "name" : "user"
  },
  "id" : "aaadcde9-d877-436a-b66b-19acd31d2574",
  "email" : "user@example.com"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

The user is successfully retrieved, we return their id and role User

401

The user details provided were not valid Error
Up 
get /structure
(structureGet)

Return type

array[SectionStructure]

Example data

Content-Type: application/json
{
  "title" : "Ways In To The Text",
  "modules" : [ {
    "title" : "Module 1: The Author And The Historical Context",
    "content" : [ {
      "title" : "What does The Sacred Wood say?",
      "contentType" : "KeyPoints"
    }, {
      "title" : "What does The Sacred Wood say?",
      "contentType" : "KeyPoints"
    } ]
  }, {
    "title" : "Module 1: The Author And The Historical Context",
    "content" : [ {
      "title" : "What does The Sacred Wood say?",
      "contentType" : "KeyPoints"
    }, {
      "title" : "What does The Sacred Wood say?",
      "contentType" : "KeyPoints"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The page structure for the analysis is succesfully returned
Up 
post /users
Registers a new user (usersPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

inline_object inline_object (optional)
Body Parameter —

Return type

User

Example data

Content-Type: application/json
{
  "role" : {
    "name" : "user"
  },
  "id" : "aaadcde9-d877-436a-b66b-19acd31d2574",
  "email" : "user@example.com"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

The user is successfully created, we return their id and role User

422

The user details provided were not valid ValidationError

Paywalled

Up 
get /book/{publicationURL}/content/{sectionNum}/{moduleNum}/{contentType}
(bookPublicationURLContentSectionNumModuleNumContentTypeGet)

Path parameters

publicationURL (required)
Path Parameter — default: null
sectionNum (required)
Path Parameter — default: null
moduleNum (required)
Path Parameter — default: null
contentType (required)
Path Parameter — default: null

Return type

array[ContentItem]

Example data

Content-Type: application/json
{
  "ISBN" : "9781912453085",
  "module" : 0,
  "section" : 0,
  "position" : 0,
  "contentType" : "KeyPoints",
  "content" : "Michel Foucault (1926-1984) was a French philosopher and historian."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The content items for this section / module / type are returned

401

The user is not logged in Error

404

The content item does not exist Error
Up 
get /book/{publicationURL}/content/{sectionNum}/{moduleNum}/Notes
(bookPublicationURLContentSectionNumModuleNumNotesGet)

Path parameters

publicationURL (required)
Path Parameter — default: null
sectionNum (required)
Path Parameter — default: null
moduleNum (required)
Path Parameter — default: null

Return type

array[Note]

Example data

Content-Type: application/json
{
  "ISBN" : "9781912453085",
  "module" : 0,
  "textIdentifier" : "m-en-1",
  "section" : 0,
  "position" : 0,
  "content" : "Michel Foucault (1926-1984) was a French philosopher and historian."
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

The content items for this section / module / type are returned

401

The user is not logged in Error

404

The content item does not exist Error

Models

[ Jump to Methods ]

Table of Contents

  1. Author -
  2. AuthorOverview -
  3. BibliographyItem -
  4. BookFull -
  5. BookOverview -
  6. ContentItem -
  7. ContentStructure -
  8. Error -
  9. GlossaryItem -
  10. Message -
  11. ModuleStructure -
  12. Note -
  13. Redirect -
  14. Role -
  15. SectionStructure -
  16. User -
  17. ValidationError -
  18. ValidationError_allOf -
  19. ValidationIssue -
  20. inline_object -
  21. inline_object_1 -

Author - Up

position
Integer
isTopicAuthor
Boolean
id
String
name
String
biography
String
isAlive
Boolean

AuthorOverview - Up

position
Integer
isTopicAuthor
Boolean
id
String
name
String

BibliographyItem - Up

position
Integer
publication
String
content
String

BookFull - Up

publicationURL
String
title
String
ISBN
String
synopsis
String
overview
String
id
String
authors
array[Author]

BookOverview - Up

publicationURL
String
title
String
ISBN
String
id
String
authors
array[AuthorOverview]

ContentItem - Up

ISBN
String
section
Integer
module
Integer
position
Integer
contentType
String
content
String

ContentStructure - Up

title
String
contentType
String

Error - Up

status
Integer
message
String

GlossaryItem - Up

position
Integer
type
String
textIdentifier
String
label
String
synopsis
String

Message - Up

status
Integer
message
String

ModuleStructure - Up

A module of the analysis, gives order and content types
title (optional)
String
content
array[ContentStructure]

Note - Up

ISBN
String
section
Integer
module
Integer
position
Integer
textIdentifier
String
content
String

Redirect - Up

status
Integer
location
String

Role - Up

name
String
Enum:
user
admin

SectionStructure - Up

The general structure of the analysis, gives order and content types
title
String
modules
array[ModuleStructure]

User - Up

id
String
email
String
role (optional)
Role

ValidationError - Up

status
Integer
message
String
issues
array[ValidationIssue]

ValidationError_allOf - Up

issues
array[ValidationIssue]

ValidationIssue - Up

field
String
message
String

inline_object - Up

email
String
password
String
passwordConfirmation
String

inline_object_1 - Up

email
String
password
String