3D Event Designer API (CORS)

Signup /api/signup

Test this service

Required Post Variables

  1. username (string)
  2. email (string, well formed email)
  3. plan id (int)
  4. password (string)

Result on Success

{
  "data":
  {
    "key": "a7d457db5ef286d4bd7ed5df346c370dcf20e6ba",
  },
  "error": null
}		

Login /api/login

Test this service

Required Post Variables

  1. email (string, well formed email)
  2. key (string)
  3. create (boolean (1,0), optionnal, default is 0)

If create field is 1, and an account with this email doesn't exist, a new account is created with given email and key.

Result on Success

{
  "data": a7d457db5ef286d4bd7ed5df346c370dcf20e6ba, // user key
  "error": null
}		

Delete User/api/userDelete

Test this service

Required Post Variables

  1. email (string, well formed email)
  2. key (string)

Result on Success

{
  "data": 1, // user key
  "error": null
}		

Project List /api/projectList

Test this service

Required Post Variables

  1. key (string) : User Key obtained on signup

Result on Success

{
  "data": [
    {
      "id": "6837",
      "key": "fb1eb2f4a4c7a1b8fde4b77b8ae10ea526fc7f70",
      "title": "MY HOME",
      "created": {
        "date": "2014-02-03 20:43:53",
        "timezone_type": 3,
        "timezone": "Europe/Paris"
      },
      "modified": {
        "date": "2014-02-03 20:43:53",
        "timezone_type": 3,
        "timezone": "Europe/Paris"
      },
      "notes": "Space Designer",
      "screenshots": [
        {
          "id": "143",
          "projectId": "6837",
          "key": "d00dc65692121b9db5310d1e07912f4e5eb704f2",
          "title": "azer",
          "creationDate": {
            "date": "2014-02-03 00:00:00",
            "timezone_type": 3,
            "timezone": "Europe/Paris"
          },
          "type": "plan", // plan, normal, panoramic
          "fileDataArray": null
        },
        //...
      ]
    },
    //...
  ],
  "error": null
}		

Create Project /api/projectCreate

Test this service

Required Post Variables

  1. project key (string, optional)
  2. project title (string, optional)
  3. user key (string, optional)

Current user should have a session to create a new project.

Result on Success

{
  "data": 1,
  "error": null
}
		

Rename Project /api/renameProject

Test this service

Required Post Variables

  1. project key (string)
  2. new project title (string)

The user should have a session to rename given project.

Result on Success

{
  "data": 1
  "error": null
}
		

Delete Project /api/deleteProject

Test this service

Required Post Variables

  1. project key (string)

The user should have a session to delete given project.

Result on Success

{
  "data": "6857" // project id
  "error": null
}
		

Change Project Owner/api/changeProjectOwner

Test this service

Required Post Variables

  1. project key (string)
  2. new user key (string)

The user should have a session to delete given project.

Result on Success

{
  "data": 1
  "error": null
}
		

Error Codes

Code Description Detail
401 Authorization error Why user is not authorized for the action; i.e., "You are not logged in."
402 Login Error Username and password do not match.
403 Post Data Validation Error Some possibilities are :
"username": [
	"required field"
],
"email": [
	"well formed email",
	"required field"
]
					
500 Database Error Return MySQL error message, such as: Duplicate entry 'xxx@yyy.com' for key 'email'