Skip to content

About

The API for the Academe Space platform

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

115 Commits

Folders and files

Repository files navigation

AcademeSpace API

Version 1.05!

Basic How To Use

Get request the API Example Below

Sample Query

http://APIENDPOINTIP/graphql?query={validateUserToken(email:"STRING",currenttoken:"STRING")}

Sample Mutation

http://APIENDPOINTIP/graphql?query=mutation+_{createUser(fname:"STRING",lname:"STRING",email:"STRING",phonenumber:"STRING",type:"STRING",password:"STRING",discordid:"STRING"){success errors token}}

Queries and Return Types

userExists

  • Arguments
    • email
      • Type: String
  • Return
    • {} (empty return)
      • Type: Boolean

validateUserToken

  • Arguments
    • email
      • Type: String
    • currenttoken
      • Type: String
  • Return
    • {} (empty return)
      • Type: Boolean

login

  • Arguments
    • email
      • Type: String
    • password
      • Type: String
    • token
      • Type: String
  • Return
    • success
      • Type: Boolean
      • Denotes any errors - false == errors
    • errors
      • Type: []String
      • String array of all errors
    • token
      • Type: String
      • Returns a valid token only when success is true

Mutations and Return Types

createUser

  • Arguments
    • fname
      • Type: String
    • lname
      • Type: String
    • email
      • Type: String
    • phonenumber
      • Type: String
    • type
      • Type: String
    • password
      • Type: String
    • discordid
      • Type: String
  • Return
    • success
      • Type: Boolean
      • Denotes any errors - false == errors
    • errors
      • Type: []String
      • String array of all errors
    • token
      • Type: String
      • Returns a valid token only when success is true

gendiscordtoken

  • Arguments
    • email
      • Type: String
  • Return
    • success
      • Type: Boolean
      • Denotes any errors - false == errors
    • errors
      • Type: []String
      • String array of all errors
    • token
      • Type: String
      • Returns a valid token only when success is true

createserverd

  • Arguments
    • token
      • Type: String
    • professordcordid
      • Type: String
    • dcordserverid
      • Type: String
  • Return
  • success
    • Type: Boolean
    • Denotes any errors - false == errors
  • errors
    • Type: []String
    • String array of all errors
  • token
    • Type: String
    • Returns a valid token only when success is true

createclassroomfront

  • Arguments
    • token
      • Type: String
    • classname
      • Type: String
    • classnumber
      • Type: String
    • sectionnumber
      • Type: String
  • Return
    • success
      • Type: Boolean
      • Denotes any errors - false == errors
    • errors
      • Type: []String
      • String array of all errors
    • token
      • Type: String
      • Returns a valid token only when success is true

About

The API for the Academe Space platform

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages

⌂ 换网址