Introduction

You can use our API to access collaborative3D endpoints which are used to create, query, and manipulate components.

User

Return User

            
{
  "user_id": "1",
  "username": "mcapitain",
  "UserInfo": {
    "firstname": "Michael",
    "lastname": "Capitain",
    "emailaddress": "mcapitain@welwynd.com"
    },
  "Activity": {
    "datetime_joined": "2018-01-05 12:54:34",
    "last_online": "2018-01-05 12:54:34"
    },
  "RegistrationStatus": {
    "registrationlevel": "Ambassador"
    },
  "Activations": {
    "activation_webworks": "1",
    "activation_solidworks": "1",
    "activation_rhino": "0"
    },
  "Quotas": {
  "quota_models":  null,
    "quota_designers": null,
    "quotas_configurations": null
    },
  "QuotaConsumption": {
    "num_models": null,
    "num_designers": null,
    "num_configurations": null
  }
}
            
          

This endpoint returns all public User data for a specific userID.

HTTP RequestGET

http://api.collaborative3D.com/web/user/return_user.php?
userid=[]

Query Parameters

Register New User

Generates 'Return User' JSON.

Creates a new user given a first / last name, email address, and password.

HTTP RequestGET

http://api.collaborative3D.com/web/user/register_new_user.php?
firstname=[]&lastname=[]&email=[]&password=[]

Query Parameters

Project

Return User Projects

Returns a listing of all Projects owned by a specific userID.

HTTP RequestGET

http://api.collaborative3D.com/web/project/return_user_projects.php?
userid=[]&project_type=[]

Query Parameters

Return Project

Returns data for a specific project based on its ID.

HTTP RequestGET

http://api.collaborative3D.com/web/project/return_project.php?
projectid=[]

Query Parameters

Delete Project

Deletes a specific project based on its ID.

HTTP RequestGET

http://api.collaborative3D.com/web/project/delete_project.php?
projectid=[]

Query Parameters

Model

Return Model

Returns a specific model based on its id.

HTTP RequestGET

http://api.collaborative3D.com/web/model/return_model.php?
modelid=[]

Query Parameters

Model BOM

Return Model BOM

Returns the Bill of Materials for a specific model based on its ID.

HTTP RequestGET

http://api.collaborative3D.com/web/model/bom/return_bom.php?
modelid=[]

Query Parameters

Part

Return Part

Returns a part based on its ID.

HTTP RequestGET

http://api.collaborative3D.com/web/part/return_part.php?
modelid=[]

Query Parameters

Edit Name

Changes the name of a specific part based on its ID.

HTTP RequestGET

http://api.collaborative3D.com/web/part/edit_name.php?
modelid=[]&oldpartname=[]&newpartname=[]

Query Parameters

Change Material

Changes the material of a part based on its ID.

HTTP RequestGET

http://api.collaborative3D.com/web/part/change_material.php?
modelid=[]&partname=[]&materialid=[]

Query Parameters

Change Color

Changes the default color of a part.
This color is used when no material is provided.

HTTP RequestGET

http://api.collaborative3D.com/web/part/change_color.php?
modelid=[]&partname=[]&color=[]

Query Parameters

Material

Return Material

Returns the definition of a specific material.

HTTP RequestGET

http://api.collaborative3D.com/web/material/return_material.php?
materialid=[]

Query Parameters

Return User Materials

Returns all materials owned by a specific user.

HTTP RequestGET

http://api.collaborative3D.com/web/material/return_user_materials.php?
userid=[]

Query Parameters

Update Material

Updates several material properties in a single call.

HTTP RequestGET

http://api.collaborative3D.com/web/material/update_material.php?
materialid=[]&color=[]&edgecolor=[]&transparency=[]&opacity=[]&emissivity=[]&specular_color=[]&shininess=[]&metalness=[]&roughness=[]

Query Parameters

Designer

Return Configuration

Returns the current configuration data for a model given a specific project and screen.

HTTP RequestGET

http://api.collaborative3D.com/web/designer/return_configuration.php?
projectid=[]&screenid=[]

Query Parameters

Return Parts List

Returns listing of unique parts for a specific project.

HTTP RequestGET

http://api.collaborative3D.com/web/designer/return_parts_list.php?
projectid=[]

Query Parameters

Screen

Build New Screen

Builds a new screen for a specific project.

HTTP RequestGET

http://api.collaborative3D.com/web/screen/build_new_screen.php?
projectid=[]&name=[]&description=[]&distnearplane=[]&distfarplane=[]&bgcolor_viewport=[]&configs_bgcolor=[]&bom_bgcolor=[]&bom_fontsize=[]&bom_fontcolor=[]&camdets_bgcolor=[]&camdets_fontsize=[]&camdets_fontcolor=[]

Query Parameters

Delete Screen

Deletes a specific screen.

HTTP RequestGET

http://api.collaborative3D.com/web/screen/delete_screen.php?
screenid=[]

Query Parameters

Return Screen

Returns data for a specific screen.

HTTP RequestGET

http://api.collaborative3D.com/web/screen/return_screen.php?
screenid=[]

Query Parameters

Set Default View

Sets the default camera angle and target for a specific screen.

HTTP RequestGET

http://api.collaborative3D.com/web/screen/set_default_view.php?
wws=[]&camposx=[]&camposy=[]&camposz=[]&camrotx=[]&camroty=[]&camrotz=[]&targposx=[]&targposy=[]&targposz=[]

Query Parameters

Set Description

Sets the description of a specific screen.

HTTP RequestGET

http://api.collaborative3D.com/web/screen/set_description.php?
screenid=[]&description=[]

Query Parameters

Set Name

Sets the name of a specific screen.

HTTP RequestGET

http://api.collaborative3D.com/web/screen/set_name.php?
screenid=[]&name=[]

Query Parameters

Update Screen

Updates any one of several properties for a specific screen.

HTTP RequestGET

http://api.collaborative3D.com/web/screen/update_screen.php?
wws=[]¶m=[]&val=[]

Query Parameters

Interface

Return Designer

Returns the designer project of a specific interface.

HTTP RequestGET

http://api.collaborative3D.com/web/interface/return_designer.php?
screenid=[]

Query Parameters

Return Designer Options

Returns a list of design options for a designer project based on screen id.

HTTP RequestGET

http://api.collaborative3D.com/web/interface/return_designer_options.php?
screenid=[]

Query Parameters

Return Model Configuration

Returns the current model configuration data of a specific model.

HTTP RequestGET

http://api.collaborative3D.com/web/interface/return_model_configuration.php?
modelid=[]

Query Parameters

Errors

This API uses the following error codes: