Inertia7 API
A RESTful application programming interface whose data schema revolves around software and data science project objects.
api
v1 > auth > rest-auth > login > create
Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework Accept the following POST parameters: username, password Return the REST Framework Token Object's key.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
username | |
email | |
password required |
v1 > auth > rest-auth > logout > list
Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.
v1 > auth > rest-auth > logout > create
Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.
v1 > auth > rest-auth > password > change > create
Calls Django Auth SetPasswordForm save method. Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
new_password1 required | |
new_password2 required |
v1 > auth > rest-auth > password > reset > create
Calls Django Auth PasswordResetForm save method. Accepts the following POST parameters: email Returns the success/fail message.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
email required |
v1 > auth > rest-auth > password > reset > confirm > create
Password reset e-mail link is confirmed, therefore this resets the user's password. Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
new_password1 required | |
new_password2 required | |
uid required | |
token required |
v1 > auth > rest-auth > registration > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
username required | |
email required | |
password1 required | |
password2 required |
v1 > auth > rest-auth > registration > verify-email > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
key required |
v1 > auth > rest-auth > user > read
Reads and updates UserModel fields Accepts GET, PUT, PATCH methods. Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email Returns UserModel fields.
v1 > auth > rest-auth > user > update
Reads and updates UserModel fields Accepts GET, PUT, PATCH methods. Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email Returns UserModel fields.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
username required | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
first_name | |
last_name |
v1 > auth > rest-auth > user > partial_update
Reads and updates UserModel fields Accepts GET, PUT, PATCH methods. Default accepted fields: username, first_name, last_name Default display fields: pk, username, email, first_name, last_name Read-only fields: pk, email Returns UserModel fields.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
username | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
first_name | |
last_name |
v1 > metrics > feedback > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
v1 > metrics > feedback > partial_update_0
Mark a feedback entry as read/unread.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
v1 > notifications > read > partial_update
Mark a single notification as read.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
v1 > projects > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
search | A search term. |
ordering | Which field to use when ordering the results. |
v1 > projects > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
owner required | |
title required | |
subtitle | |
body | |
picture_link | |
technology | |
skill | |
publish |
v1 > projects > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
v1 > projects > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
owner required | |
title required | |
subtitle | |
body | |
picture_link | |
technology | |
skill | |
publish |
v1 > projects > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
owner | |
title | |
subtitle | |
body | |
picture_link | |
technology | |
skill | |
publish |
v1 > projects > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
v1 > projects > comments > list
List comments for a project.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
v1 > projects > comments > create
Create a comment on a project.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
v1 > projects > comments > partial_update
Edit own comment.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
comment_pk required | |
id required |
v1 > projects > comments > delete
Delete own comment (or admin can delete any).
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
comment_pk required | |
id required |
v1 > projects > like > create
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
v1 > projects > liked > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
user_pk required |
v1 > tags > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
v1 > tags > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
category | |
description |
v1 > tags > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this tag. |
v1 > tags > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this tag. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
category | |
description |
v1 > tags > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this tag. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name | |
category | |
description |
v1 > tags > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this tag. |
v1 > users > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
search | A search term. |
username | |
id |
v1 > users > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this user. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
search | A search term. |
username | |
id |
v1 > users > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this user. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
search | A search term. |
username | |
id |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
username required | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
first_name | |
last_name |
v1 > users > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this user. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
search | A search term. |
username | |
id |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
username | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
first_name | |
last_name |
v1 > users > extended > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
user | |
user__username |
v1 > users > extended > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this extended user. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
user | |
user__username |
v1 > users > extended > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this extended user. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
user | |
user__username |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
user required | |
bio | |
cv | |
website | |
picture_link |
v1 > users > extended > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this extended user. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
user | |
user__username |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
user | |
bio | |
cv | |
website | |
picture_link |