API Documentation

Otiima API Documentation

Overview

This documentation provides details on the available API endpoints for the Otiima API. You can find the following endpoints for development at https://api.otiima.com/dev/bim/ and production at https://api.otiima.com/prod/bim/.

Profiles API

Endpoint: profiles.php

GET /profiles.php - Retrieves all profiles or a single profile by ID.
POST /profiles.php - Creates a new profile.
PUT /profiles.php - Updates an existing profile.
DELETE /profiles.php - Deletes a profile by ID.

Profile Data API

This API retrieves the accessories, machinations, and detailed profile information including measurement units associated with a specific profile based on the provided system, series, and profile position. The profile must be mapped to both the system and the series, and the accessories/machinations depend on the profile's position. The endpoint will return an error if the combination of profile, system, series, and position is not valid.

Endpoint

URL: https://api.otiima.com/dev/bim/profile_data.php

Method: GET

Required Parameters

ProfileCode (string) - The unique code for the profile.
SystemCode (string) - The system code associated with the profile.
SerieCode (string) - The series code related to the profile and system.
PositionCode (string) - The position code associated with the profile.

Accepted Profile Positions [PositionCode]

SUP - Profile on superior position.
INF - Profile on inferior position.
LEFT - Profile on lteral left position.
RIGHT - Profile on lateral right position.
NA - Mandatory for when no profile position is provided.

Example Request

GET: /profile_data.php?SystemCode=CLASSIC&SerieCode=38&ProfileCode=L65001&PositionCode=SUP

URL Example: https://api.otiima.com/dev/bim/profile_data.php?SystemCode=CLASSIC&SerieCode=38&ProfileCode=L65001&PositionCode=POS01

Example Response


{
    "ProfileInfo": {
        "ProfileCode": "L65001",
        "ProfileDescription": "ARO 1R",
        "TheoryWeight": 1.551,
        "TheoryWeightUnit": "kg",
        "AreaPerLinearMeter": 0.473,
        "AreaPerLinearMeterUnit": "m²",
        "Width": 1200,
        "WidthUnit": "mm",
        "Height": 2100,
        "HeightUnit": "mm"
    },
    "ProfileParameters": [
        {
            "ParameterCode": "P01",
            "ParameterName": "Parameter 1",
            "Formula": "width * height",
            "Value": "..."
        }
    ],
    "Accessories": [
        {
            "AccessoryCode": "ACC01",
            "AccessoryDescription": "Accessory 1",
            "AccessoryQuantity": 2,
            "Parameters": [
                {
                    "ParameterCode": "A01",
                    "ParameterName": "Parameter 1",
                    "Formula": "quantity * factor",
                    "Value": "..."
                }
            ]
        }
    ],
    "Machinations": [
        {
            "MachinationCode": "M01",
            "MachinationDescription": "Machination 1",
            "Parameters": [
                {
                    "ParameterCode": "M01P",
                    "ParameterName": "Machination Param 1",
                    "Formula": "width / factor",
                    "Value": "..."
                }
            ]
        }
    ]
}

Error Handling

Missing Parameters (HTTP 400): If any required parameters are missing, the API returns an error:
```
{
    "error": "ProfileCode, SystemCode, SerieCode, and PositionCode are required"
}
```
Invalid Combination (HTTP 404): If the combination of profile, system, series, and position is invalid, the API returns:
```
{
    "error": "Invalid combination of SystemCode, SerieCode, and ProfileCode"
}
```
Method Not Allowed (HTTP 405): If the request method is not supported, the API returns:
```
{
    "error": "Method not allowed"
}
```

Notes

This endpoint validates that the combination of profile, system, series, and position is correct before returning any data. It returns the list of accessories and machinations related to the profile and position if the combination is valid. Additionally, the profile information includes the measurement units for key attributes.

Profiles Combined API

Endpoint: profiles_combined.php

GET /profiles_combined.php?SystemCode=system&SerieCode=serie&ProfileCodes[]=profile1&ProfileCodes[]=profile2 - Retrieves profile information and machinations for each profile, and combined accessories if more than one profile is provided.

Example Response:

[
    {
        "ProfileInfo": {
            "ProfileCode": "L65001",
            "ProfileDescription": "ARO 1R",
            "TheoryWeight": 1.551,
            "AreaPerLinearMeter": 0.473,
            "isActive": 1
        },
        "Machinations": [
            {
                "MachinationCode": "DRN",
                "MachinationDescription": "Drenagens STD"
            }
        ]
    },
    {
        "ProfileInfo": {
            "ProfileCode": "L65002",
            "ProfileDescription": "ARO 2R",
            "TheoryWeight": 2.0,
            "AreaPerLinearMeter": 0.670,
            "isActive": 1
        },
        "Machinations": [
            {
                "MachinationCode": "ES01",
                "MachinationDescription": "Esquadros STD"
            }
        ]
    },
    {
        "CombinedAccessories": [
            {
                "AccessoryCode": "ACC003",
                "AccessoryDescription": "Combination Accessory 1",
                "CombinationProfiles": "L65001,L65002",
                "isActive": 1
            }
        ]
    }
]

Accessories API

Endpoint: accessories.php

GET /accessories.php - Retrieves all accessories and their details, including whether they are for production or on-site assembly, and whether they are active. Optionally filter by AccessoryCode.

Example Response:

[
    {
        "AccessoryCode": "ACC001",
        "AccessoryDescription": "Standard Accessory 1",
        "Destination": "Production",
        "isActive": 1,
        "AccessoryType": "Standard"
    },
    {
        "AccessoryCode": "ACC002",
        "AccessoryDescription": "Combination Accessory 1",
        "Destination": "On-site",
        "isActive": 1,
        "CombinationProfiles": "L65001,L65002",
        "AccessoryType": "Combination"
    }
]

Series API

Endpoint: series.php

GET /series.php - Retrieves all series.

Example Response:

{
    "SerieCode": "38",
    "SystemCode": "CLASSIC",
    "Description": "Series 38",
    "isActive": 1
}

Systems API

Endpoint: systems.php

GET /systems.php - Retrieves all systems.

Example Response:

[
    {
        "SystemCode": "CLASSIC",
        "Description": "Classic System",
        "isActive": 1
    },
    {
        "SystemCode": "FUSION",
        "Description": "Fusion 1.0 System",
        "isActive": 1
    }
]

Windows API

This API allows you to retrieve detailed information about windows, including related descriptions for various codes such as BrandCode, SystemCode, SerieCode, and more. You can also create, update, and delete windows in the system. The windows can be queried by their unique WindowCode.

Endpoint

URL: https://api.otiima.com/dev/bim/windows.php

Method: GET, POST, PUT, DELETE

GET Request

Retrieve the details of all windows or a specific window based on the WindowCode. The response includes descriptions of related codes (e.g., system, series, brand).

Required Parameter

WindowCode (optional) - If provided, returns the window details of the specified WindowCode along with related descriptions.

Example Request

GET /windows.php?WindowCode=WINDOW001

URL Example:

https://api.otiima.com/dev/bim/windows.php?WindowCode=WINDOW001

Example Response

{
    "WindowCode": "WINDOW001",
    "BrandCode": "BRAND01",
    "BrandName": "Otiima",
    "SystemCode": "SYS001",
    "SystemName": "Classic System",
    "SerieCode": "SER001",
    "SerieName": "Series 38",
    "OpeningTypeCode": "OP01",
    "OpeningTypeName": "Tilt & Turn",
    "InstallationTypeCode": "INST01",
    "InstallationTypeName": "Standard",
    "GeometryCode": "GEOM01",
    "GeometryName": "Rectangular",
    "LeavesCode": "LV01",
    "NumberOfLeaves": 2,
    "SequenceCode": "SEQ01",
    "SequenceDescription": "Sequence A",
    "RailsCode": "RL01",
    "NumberOfRails": 2,
    "WindowTypeCode": "WT01",
    "WindowTypeName": "Casement Window",
    "Comments": "Some comments",
    "IsActive": 1,
    "CreatedDate": "2024-10-24"
}

Error Handling

404 Not Found - If the requested WindowCode is not found.
400 Bad Request - If required parameters are missing.

POST Request

Create a new window with the provided information.

Required Parameters

WindowCode - Unique code for the window.
BrandCode - Code for the brand associated with the window.
SystemCode - Code for the system used in the window.
SerieCode - Code for the series of the window.
OpeningTypeCode - Type of opening mechanism used for the window.
InstallationTypeCode - Type of installation used for the window.
GeometryCode - Geometric configuration for the window.
LeavesCode - Number of leaves (panes) in the window.
SequenceCode - Sequence code for window design.
RailsCode - Number of rails in the window design.
WindowTypeCode - Type of window being created.
Comments - Any additional comments.
IsActive - Indicates if the window is active (1 for active, 0 for inactive).
CreatedDate - The date when the window was created.

Example Request

POST /windows.php
{
    "WindowCode": "WINDOW001",
    "BrandCode": "BRAND01",
    "SystemCode": "SYS001",
    "SerieCode": "SER001",
    "OpeningTypeCode": "OP01",
    "InstallationTypeCode": "INST01",
    "GeometryCode": "GEOM01",
    "LeavesCode": "LV01",
    "SequenceCode": "SEQ01",
    "RailsCode": "RL01",
    "WindowTypeCode": "WT01",
    "Comments": "Some comments",
    "IsActive": 1,
    "CreatedDate": "2024-10-24"
}

Example Response

{
    "message": "Window created successfully"
}

PUT Request

Update an existing window by providing the updated details. The WindowCode must be provided to identify the window to be updated.

Example Request

PUT /windows.php
{
    "WindowCode": "WINDOW001",
    "BrandCode": "BRAND01",
    "SystemCode": "SYS001",
    "SerieCode": "SER001",
    "OpeningTypeCode": "OP02",
    "InstallationTypeCode": "INST02",
    "GeometryCode": "GEOM02",
    "LeavesCode": "LV02",
    "SequenceCode": "SEQ02",
    "RailsCode": "RL02",
    "WindowTypeCode": "WT02",
    "Comments": "Updated comments",
    "IsActive": 1,
    "CreatedDate": "2024-10-24"
}

Example Response

{
    "message": "Window updated successfully"
}

DELETE Request

Delete an existing window by specifying the WindowCode of the window to be deleted.

Required Parameter

WindowCode - Unique code for the window to be deleted.

Example Request

DELETE /windows.php?WindowCode=WINDOW001

Example Response

{
    "message": "Window deleted successfully"
}

Error Handling

400 Bad Request - If no WindowCode is provided for deletion.