Material Categories

API endpoints for managing material categories

GET /materials/categories

Get List of Materials Categories (Without Pagination) Endpoint

Endpoint: GET /open-api/v1/materials/categories

Description

Fetches a complete list of material categories from the Simplio3D API without pagination.

Request Headers

  • Authorization: Bearer token required.

Sample Request

GET /open-api/v1/materials/categories HTTP/1.1
Host: api.simplio3d.com
Authorization: Bearer {your_api_token}

Response

  • Status Code: 200 OK

  • Body: A JSON array containing the material categories available.

  • [
        {
            "id": "1",
            "name": "Wood"
        },
        {
            "id": "2",
            "name": "Metal"
        }
        // ... other categories
    ]

    Error Handling

    • 401 Unauthorized: If the authorization token is missing or invalid.

    • 500 Internal Server Error: For generic server-side errors.

Get list of materials categories (without pagination)

get

Get all materials categories without pagination.

Authorizations
Query parameters
order_bystringOptional

Column to order the results by (default: created_at)

Example: name
orderstring · enumOptional

Order direction (asc or desc, default: desc)

Example: ascPossible values:
Responses
200
Successful response
application/json
get
GET /api/open-api/v1/materials-categories/list HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*
[
  {
    "id": 1,
    "title": "Wood",
    "description": "Wood-based materials",
    "created_at": "2024-02-26 12:00:00",
    "updated_at": "2024-02-27 15:00:00",
    "created_by": "John Doe"
  }
]

GET /materials/categories/{id}

Get a Specific Material Category by ID

GET /open-api/v1/materials/categories/{id} HTTP/1.1
Host: api.simplio3d.com
Authorization: Bearer {your_api_token}

Response

  • Status Code: 200 OK

  • Materials Not Found: 404

  • Unauthorized: 401

Get materials category by ID

get

Get a specific materials category by ID.

Authorizations
Path parameters
idinteger · int64Required

ID of the materials category

Responses
200
Successful response
application/json
get
GET /api/open-api/v1/materials-categories/{id} HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer JWT
Accept: */*
{
  "id": 1,
  "title": "Wood",
  "description": "Wood-based materials",
  "created_at": "2024-02-26 12:00:00",
  "updated_at": "2024-02-27 15:00:00",
  "created_by": "John Doe"
}

Last updated

Was this helpful?