Texture Categories

Retrieve texture categories endpoints

GET /textures-categories/list

Endpoint: Retrieve All Texture Categories

HTTP Method: GET

URL: /open-api/v1/textures-categories/list

Description: This endpoint retrieves a list of all texture categories available in the database without applying pagination filters. It returns a detailed list ensuring all categories are accessible in a single response.

Response Format:

• Status Code: 200 OK

• Content-Type: application/json

Response Example:

[
    {
        "id": "1",
        "name": "Wood"
    },
    {
        "id": "2",
        "name": "Metal"
    },
    {
        "id": "3",
        "name": "Stone"
    }
    // ... more categories
]

Notes:

• Ensure proper authorization headers are included if necessary.

• The response will include all categories, so handle large datasets appropriately in your application.

Retrieve all texture categories without pagination

get

/api/open-api/v1/textures-categories/list

Get all texture categories without pagination.

Authorizations

AuthorizationstringRequired

Enter token in format (Bearer <your_token>)

Query parameters

order_bystringOptional

Column to order results by (e.g., 'created_at')

Example: created_at

orderstring · enumOptional

Sorting order (asc or desc)

Example: descPossible values:

Responses

200

Successful response

application/json

Textures category data

idintegerOptionalExample: 1

titlestringOptionalExample: Wood Textures

descriptionstringOptionalExample: Collection of wood textures

created_atstring · date-timeOptionalExample: 2024-02-21T12:34:56Z

updated_atstring · date-timeOptionalExample: 2024-02-21T12:34:56Z

created_bystringOptionalExample: John Doe

401

Unauthorized

500

Internal server error

get/api/open-api/v1/textures-categories/list

GET /api/open-api/v1/textures-categories/list HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "title": "Wood Textures",
    "description": "Collection of wood textures",
    "created_at": "2024-02-21T12:34:56Z",
    "updated_at": "2024-02-21T12:34:56Z",
    "created_by": "John Doe"
  }
]

GET /textures-categories/{id}

Get Texture Category by ID - GET Endpoint

Endpoint:

GET open-api/v1/textures-categories/{id}

Description:

Retrieve detailed information about a specific texture category using its unique ID.

Authorization:

Ensure appropriate authorization headers are included in the request.

Parameters:

• id (path parameter) - The unique identifier of the texture category.

Response:

Returns a JSON object containing detailed information about the texture category, such as its name, description, and any related metadata.

Example Response:

{
    "id": "2",
    "name": "Metal",
    "description": "A category for all metal-based textures."
}

Notes:

• Handle any potential errors such as 404 Not Found for invalid IDs.

• Consider rate limits and implement retry logic as appropriate.

Get texture category by ID

get

/api/open-api/v1/textures-categories/{id}

Get a specific texture category by ID.

Authorizations

AuthorizationstringRequired

Enter token in format (Bearer <your_token>)

Path parameters

idinteger · int64Required

ID of the texture category

Responses

200

Successful response

application/json

Textures category data

idintegerOptionalExample: 1

titlestringOptionalExample: Wood Textures

descriptionstringOptionalExample: Collection of wood textures

created_atstring · date-timeOptionalExample: 2024-02-21T12:34:56Z

updated_atstring · date-timeOptionalExample: 2024-02-21T12:34:56Z

created_bystringOptionalExample: John Doe

401

Unauthorized

404

Texture category not found

get/api/open-api/v1/textures-categories/{id}

GET /api/open-api/v1/textures-categories/{id} HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "title": "Wood Textures",
  "description": "Collection of wood textures",
  "created_at": "2024-02-21T12:34:56Z",
  "updated_at": "2024-02-21T12:34:56Z",
  "created_by": "John Doe"
}

GET /textures-categories

Get List of Texture Categories

The Get List of Texture Categories endpoint retrieves a complete list of available texture categories. Each category includes essential details such as the category's ID, name, and description.

Endpoint

GET /open-api/v1/textures-categories

Example Request

GET /open-api/v1/texture-categories HTTP/1.1
Host: api.simplio3d.com
Authorization: Bearer YOUR_ACCESS_TOKEN

Example Response

[
    {
        "id": "1",
        "name": "Wood",
        "description": "A category for all wood-based textures."
    },
    {
        "id": "2",
        "name": "Metal",
        "description": "A category for all metal-based textures."
    }
]

Notes

• Ensure a valid access token is provided in the request header.

• Handle potential errors, such as 401 Unauthorized if the token is invalid or expired.

• Implement retry logic to handle rate limit errors if encountered.

Get list of textures categories

get

/api/open-api/v1/textures-categories

Get all textures categories.

Authorizations

AuthorizationstringRequired

Enter token in format (Bearer <your_token>)

Query parameters

per_pageintegerOptional

Number of records per page (-1 for all records)

Example: 25

pageintegerOptional

Number of page

Example: 2

order_bystringOptional

Column to sort by

Example: created_at

orderstringOptional

Sort order (asc/desc)

Example: desc

Responses

200

Successful response

No content

401

Unauthorized

500

Internal Server Error

get/api/open-api/v1/textures-categories

GET /api/open-api/v1/textures-categories HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content