Forms

Fetch Configurator Form(s)

GET /configurator-forms/

Simplio3D API: Fetch All Configurator Forms

Endpoint: GET /api/v1/configurator-forms

Description: This endpoint retrieves a list of all configurator forms available in the Simplio3D system.

Request

• Method: GET

• URL Parameters: None

• Headers:

  • Authorization: Bearer <access_token>

  Response

  • Status Code: 200 OK

  • Content-Type: application/json

  Response Body:

  [
    {
      "form_id": "123",
      "name": "Configurator Form 1",
      "description": "Description of configurator form 1",
      "created_at": "2023-01-01T12:00:00Z",
      "updated_at": "2023-01-02T12:00:00Z"
    },
    {
      "form_id": "124",
      "name": "Configurator Form 2",
      "description": "Description of configurator form 2",
      "created_at": "2023-01-03T12:00:00Z",
      "updated_at": "2023-01-04T12:00:00Z"
    }
  ]

• Notes

  • Ensure that the API token used in the request is valid and has the required permissions.

  • The response includes metadata about each configurator form, such as creation and last update timestamps.

  • Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint which is taken from the 'Share' tab encryption token found at the bottom of the page.

Fetch all configurator forms

get

Get a list of configurator forms.

Authorizations

Responses

200

Successful response

application/json

401

Unauthorized

500

Internal Server Error

get

HTTPcURLJavaScriptPython

GET /api/open-api/v1/configurator-forms HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*

[
  {
    "id": 12,
    "configurator_id": 127,
    "enable_form": true,
    "created_at": "2024-02-27T12:45:00Z"
  }
]

GET /configurator-forms/{id}

Fetch a Specific Configurator Form

Endpoint: GET /api/v1/configurator-forms/{form_id}

Description: This endpoint retrieves details of a specific configurator form by its ID in the Simplio3D system.

Request

• Method: GET

• URL Parameters: None

NOTE: Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint which is taken from the 'Share' tab encryption token found at the bottom of the page.

Fetch a specific configurator form

get

Get a specific configurator form by ID.

Authorizations

Path parameters

idinteger · int64Required

ID of the configurator form

Example: 15

Responses

200

Successful response

application/json

401

Unauthorized

404

Configurator Form not found

500

Internal Server Error

get

HTTPcURLJavaScriptPython

GET /api/open-api/v1/configurator-forms/{id} HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*

{
  "id": 12,
  "configurator_id": 127,
  "enable_form": true,
  "created_at": "2024-02-27T12:45:00Z"
}