Paper API Reference
In order to access a user's data in Paper, the user must authenticate with the auth.dilanxd.com account service and authorize your application to make requests on their behalf.
This Paper API guide assumes you have already done this and have an access token for the user. If not, you'll need to set that up first.
API Reference
Get all plans or schedules
GET
/paper/documents
Get all plans or schedules
HOST
https://api.dilanxd.com
AUTHORIZATION
Bearer {access token}
REQUIRED SCOPE
plan-nu
QUERY PARAMS
type
1 for plans, 2 for schedules. (default: 2)
200 OK
Operation successful
400 Bad Request
Invalid or missing parameters
401 Unauthorized
Invalid or missing access token
Create a plan or schedule
POST
/paper/documents
Create a plan or schedule
HOST
https://api.dilanxd.com
AUTHORIZATION
Bearer {access token}
REQUIRED SCOPE
plan-nu plan-nu:write
BODY
application/json
type*
1 | 2
1 for plans, 2 for schedules. (default: 2)
name*
string (match ^[\w\-\s]{1,24}$)
The name of the document.
content
string (match ^[\w\-%&=,;]+$)
The serialized data string of the document.
notes
string (max len 2000)
The notes for the document.
custom
CustomCourseSection[]
Custom course sections.
201 Created
Operation successful
400 Bad Request
Invalid or missing parameters
401 Unauthorized
Invalid or missing access token
403 Forbidden
Document limit reached for given type
Update a plan or schedule
PATCH
/paper/documents/{documentId}
Update a plan or schedule
HOST
https://api.dilanxd.com
AUTHORIZATION
Bearer {access token}
REQUIRED SCOPE
plan-nu plan-nu:write
PATH PARAMS
documentId*
The ID of the document to update.
BODY
application/json
name
string (match ^[\w\-\s]{1,24}$)
The name of the document.
content
string (match ^[\w\-%&=,;]+$)
The serialized data string of the document.
notes
string (max len 2000)
The notes for the document.
custom
CustomCourseSection[]
Custom course sections.
200 OK
Operation successful
400 Bad Request
Invalid or missing parameters
401 Unauthorized
Invalid or missing access token
404 Not Found
Document for user not found
Delete a plan or schedule
DELETE
/paper/documents/{documentId}
Delete a plan or schedule
HOST
https://api.dilanxd.com
AUTHORIZATION
Bearer {access token}
REQUIRED SCOPE
plan-nu plan-nu:write
PATH PARAMS
documentId*
The ID of the document to delete.
200 OK
Operation successful
401 Unauthorized
Invalid or missing access token
404 Not Found
Document for user not found
Type Reference
Document
| Key | Type | Description |
|---|---|---|
id | string | The document's unique ID |
type | 1 | 2 | 1 if plan, 2 if schedule |
name | string | The name of the document |
owner | string | The user ID of the document's owner |
content | string | The serialized data string of the document |
createdAt | number | The creation timestamp in millis since epoch |
lastUpdated | number | The last update timestamp in millis since epoch |