Пример YAML файла API¶

POST /calculate-heating¶

Calculate Wire Heating

Perform the heating calculation for a specified wire model and parameters.

Example request:

POST /calculate-heating HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "wireModel": "string",
    "windSpeed": 1.0,
    "ambientTemperature": 1.0,
    "maxTime": 1,
    "timeStep": 1,
    "tmpProgram": true,
    "calculationMethod": "string"
}

Status Codes:

200 OK –

Successful response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "string",
    "message": "string",
    "results": {
        "currentOverTime": [
            1.0
        ],
        "temperatureOverTime": [
            1.0
        ],
        "permissibleTemperature": 1.0,
        "tapr": 1.0,
        "additionalStats": {
            "averageCurrent": 1.0,
            "peakTemperature": 1.0
        }
    }
}

GET /available-wires¶

Get Available Wire Models

Retrieve a list of all available wire models and their properties.

Example request:

GET /available-wires HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "string",
    "message": "string",
    "wires": [
        {
            "mark": "string",
            "diameter": 1.0,
            "resistance": 1.0,
            "thermalCapacity": 1.0,
            "ratedCurrent": 1.0,
            "durabilityTemperature": 1.0,
            "tapr": 1.0
        }
    ]
}

GET /available-methods¶

Get Available Calculation Methods

Retrieve a list of all available calculation methods.

Example request:

GET /available-methods HTTP/1.1
Host: example.com

Status Codes:

200 OK –

Successful response

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "string",
    "message": "string",
    "methods": [
        {
            "shortName": "string",
            "fullName": "string"
        }
    ]
}