dcs-sastra / dsc-api

dsc-api v0.0.0

• Auth

  • Authenticate

• Clusters

  • Create clusters
  • Delete clusters
  • Retrieve clusters
  • Update clusters

• Events

  • Create events
  • Delete events
  • Retrieve events
  • Update events

• MembersbyCluster

  • Create membersby cluster
  • Delete membersby cluster
  • Retrieve membersby clusters
  • Update membersby cluster

• Resources

  • Create resource
  • Delete resources
  • Retrieve resources
  • Update resource

• User

  • Create user
  • Delete user
  • Retrieve current user
  • Retrieve user
  • Retrieve users
  • Update password
  • Update user

Auth

Authenticate

POST /auth

Headers

Name	Type	Description
Authorization	String	Basic authorization with email and password.

Parameters

Name	Type	Description
access_token	String	Master access_token.

Clusters

Create clusters

POST /clusters

Parameters

Name	Type	Description
access_token	String	master access token.
name		Clusters's name.
img		Clusters's img.
backgroundColor		Clusters's backgroundColor.
link		Clusters's link.

Delete clusters

DELETE /clusters/:id

Parameters

Name	Type	Description
access_token	String	master access token.

Retrieve clusters

GET /clusters/:id

Update clusters

PUT /clusters/:id

Parameters

Name	Type	Description
access_token	String	master access token.
name		Clusters's name.
img		Clusters's img.
backgroundColor		Clusters's backgroundColor.
link		Clusters's link.

Events

Create events

POST /events

Parameters

Name	Type	Description
access_token	String	master access token.
name		Events's name.
date		Events's date.
description		Events's description.
main		Events's main.
venue		Events's venue.
speakers		Events's speakers.
poster		Events's poster.
register_link		Events's register_link.

Delete events

DELETE /events/:id

Parameters

Name	Type	Description
access_token	String	master access token.

Retrieve events

GET /events/:id

Update events

PUT /events/:id

Parameters

Name	Type	Description
access_token	String	master access token.
name		Events's name.
date		Events's date.
description		Events's description.
main		Events's main.
venue		Events's venue.
speakers		Events's speakers.
poster		Events's poster.
register_link		Events's register_link.

MembersbyCluster

Create membersby cluster

POST /MembersbyCluster

Parameters

Name	Type	Description
access_token	String	master access token.
lead		Membersby cluster's lead.
app		Membersby cluster's app.
flutter		Membersby cluster's flutter.
web		Membersby cluster's web.
ml		Membersby cluster's ml.
cloud		Membersby cluster's cloud.
graphic		Membersby cluster's graphic.
content		Membersby cluster's content.
marketing		Membersby cluster's marketing.

Delete membersby cluster

DELETE /MembersbyCluster/:id

Parameters

Name	Type	Description
access_token	String	master access token.

Retrieve membersby clusters

GET /MembersbyCluster

Parameters

Name	Type	Description
q	String	optional Query to search.
page	Number	optional Page number.
limit	Number	optional Amount of returned items.
sort	String[]	optional Order of returned items.
fields	String[]	optional Fields to be returned.

Update membersby cluster

PUT /MembersbyCluster/:id

Parameters

Name	Type	Description
access_token	String	master access token.
lead		Membersby cluster's lead.
app		Membersby cluster's app.
flutter		Membersby cluster's flutter.
web		Membersby cluster's web.
ml		Membersby cluster's ml.
cloud		Membersby cluster's cloud.
nonTech		Membersby cluster's nonTech.

Resources

Create resource

POST /resources

Parameters

Name	Type	Description
access_token	String	master access token.
name		Resource's name.
description		Resources's description.
resource_url		Url to the resource.
image_url		Resource's image_url.

Delete resources

DELETE /resources/:id

Parameters

Name	Type	Description
access_token	String	master access token.

Retrieve resources

GET /resources/:id

Update resource

PUT /resources/:id

Parameters

Name	Type	Description
access_token	String	master access token.
name		Resource's name.
description		Resources's description.
resource_url		Url to the resource.
image_url		Resource's image_url.

User

Create user

POST /users

Parameters

Name	Type	Description
access_token	String	Master access_token.
email	String	User's email.
password	String	User's password.
name	String	optional User's name.
picture	String	optional User's picture.
role	String	optional User's role.

Delete user

DELETE /users/:id

Parameters

Name	Type	Description
access_token	String	User access_token.

Retrieve current user

GET /users/me

Parameters

Name	Type	Description
access_token	String	User access_token.

Retrieve user

GET /users/:id

Retrieve users

GET /users

Parameters

Name	Type	Description
access_token	String	User access_token.
q	String	optional Query to search.
page	Number	optional Page number.
limit	Number	optional Amount of returned items.
sort	String[]	optional Order of returned items.
fields	String[]	optional Fields to be returned.

Update password

PUT /users/:id/password

Headers

Name	Type	Description
Authorization	String	Basic authorization with email and password.

Parameters

Name	Type	Description
password	String	User's new password.

Update user

PUT /users/:id

Parameters

Name	Type	Description
access_token	String	User access_token.
name	String	optional User's name.
picture	String	optional User's picture.