ComCheck API.
1.0.0
OAS 3.0
/swagger.json
This documentation describes the Community Check API.
MIT
Authorize
Token
GET
/api
/tokens
/validate
Validate user token
Complex create
POST
/api
/projects
/complex-create
Complex create project, books and check
Projects
GET
/api
/projects
/{projectId}
Returns a project by ID.
POST
/api
/projects
/{projectId}
Updates the project name.
DELETE
/api
/projects
/{projectId}
Delete a project by ID
GET
/api
/projects
Get projects for the current user
POST
/api
/projects
Create a new project
Books
GET
/api
/projects
/{projectId}
/books
/{bookId}
/info
Get count of notes for book
GET
/api
/projects
/{projectId}
/books
/{bookId}
Get a book by ID
POST
/api
/projects
/{projectId}
/books
/{bookId}
Update book name
DELETE
/api
/projects
/{projectId}
/books
/{bookId}
Delete a book by ID
GET
/api
/projects
/{projectId}
/books
Get books
POST
/api
/projects
/{projectId}
/books
Create a new book
Checks
GET
/api
/checks
/{checkId}
Get check content by check ID
GET
/api
/projects
/{projectId}
/books
/{bookId}
/checks
/{checkId}
Get check by ID
POST
/api
/projects
/{projectId}
/books
/{bookId}
/checks
/{checkId}
Update check
DELETE
/api
/projects
/{projectId}
/books
/{bookId}
/checks
/{checkId}
Delete check by ID
GET
/api
/projects
/{projectId}
/books
/{bookId}
/checks
Returns a list of checks for a book
POST
/api
/projects
/{projectId}
/books
/{bookId}
/checks
Creates a new check for a book
Notes
GET
/api
/checks
/{checkId}
/{inspectorId}
Get notes by check id and inspector id
DELETE
/api
/checks
/{checkId}
/{inspectorId}
Delete note
POST
/api
/checks
/{checkId}
/notes
/{noteId}
Update note
POST
/api
/checks
/{checkId}
/notes
Insert note
GET
/api
/projects
/{projectId}
/books
/{bookId}
/checks
/{checkId}
/notes
Get notes by check ID
Material
POST
/api
/materials
Create or update material
Inspector
GET
/api
/inspectors
/{inspectorId}
Check if there are notes for the inspector
GET
/api
/projects
/{projectId}
/books
/{bookId}
/checks
/{checkId}
/inspector
Returns the list of inspectors for the check
POST
/api
/projects
/{projectId}
/books
/{bookId}
/checks
/{checkId}
/inspector
Creates a new inspector
DELETE
/api
/projects
/{projectId}
/books
/{bookId}
/checks
/{checkId}
/inspector
Deletes an inspector and its notes
Links
GET
/api
/checks
/{checkId}
/{inspectorId}
/url?chapterNumber=1&lng=en
Generate link for personal check page
GET
/api
/checks
/{checkId}
/url?chapterNumber=1&lng=en
Generate link for public check page
Schemas
Complex create
Project
Projects
Book
Check
CheckUpdate
Inspector
Note
NoteResponse
NotesResponse