Skip to main content
JSON Manual Created Edited

Vehicles - South Africa

Input URI

{base url} + db/MVHL



Active Methods

POST, GET, PUT, DELETE



JSON Schema

Details

{
    "MVHL": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
            "MVLD_CODE": {
                "description": "MovingLoadCode",
                "type": "integer"
            },
            "VEHICLE_LOAD_NAME": {
                "description": "VehicularLoadName",
                "type": "string"
            },
            "VEHICLE_LOAD_NUM": {
                "description": "VehicularLoadNumber",
                "type": "integer"
            },
            "VEHICLE_TYPE_NAME": {
                "description": "VehicularTypeName",
                "type": "string"
            },
            "STANDARD_CODE": {
                "description": "StandardCode",
                "type": "string"
            },
            "USER_LOAD_TYPE": {
                "description": "UserLoadType",
                "type": "string"
            },
            "VEH_ZA": {
                "type": "object",
                "properties": {
                    "PERMIT_LOAD": {
                        "type": "object",
                        "properties": {
                            "IMPACT_FACTOR": {
                                "description": "PermitLoadImpactFactor",
                                "type": "number"
                            },
                            "AXLE_TYPES": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "AXLE_TYPE": {
                                            "description": "AxleType",
                                            "type": "string"
                                        },
                                        "EVENLY_DIST_LOAD": {
                                            "description": "EvenlyDistanceLoad",
                                            "type": "boolean"
                                        },
                                        "SYMMETRIC_VEHICLE": {
                                            "description": "SymmetricVehicle",
                                            "type": "boolean"
                                        },
                                        "POINT_ITEMS": {
                                            "type": "array",
                                            "items": {
                                                "type": "object",
                                                "properties": {
                                                    "POINT_LOAD": {
                                                        "description": "PointLoad",
                                                        "type": "number"
                                                    },
                                                    "POINT_DIST": {
                                                        "description": "PointDistance",
                                                        "type": "number"
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            },
                            "PERMIT_LOADS": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "AXLE_TYPE": {
                                            "description": "AxleType",
                                            "type": "string"
                                        },
                                        "SPACING": {
                                            "description": "Spacing",
                                            "type": "number"
                                        },
                                        "EQUAL_J_NVSIDX": {
                                            "description": "j==nVsIdx",
                                            "type": "boolean"
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "INCRE_LENGTH": {
                        "description": "Unitlengthforloadedlengthincrement",
                        "type": "boolean"
                    },
                    "INCRE_LENGTH_VALUE": {
                        "description": "LoadedlengthincrementValue",
                        "type": "number"
                    },
                    "UNIT_NUM": {
                        "description": "LoadedlengthincrementValue",
                        "type": "number"
                    },
                    "OPPOSITE": {
                        "description": "Considerloadareagivingoppositecontribution",
                        "type": "boolean"
                    },
                    "W1": {
                        "description": "W1",
                        "type": "number"
                    },
                    "W2": {
                        "description": "W2",
                        "type": "number"
                    },
                    "W3": {
                        "description": "W3",
                        "type": "number"
                    },
                    "LOADED_LENGTH": {
                        "description": "LoadedLength",
                        "type": "number"
                    },
                    "PA": {
                        "description": "Pa",
                        "type": "number"
                    },
                    "PB": {
                        "description": "Pb",
                        "type": "number"
                    },
                    "D1": {
                        "description": "D1",
                        "type": "number"
                    },
                    "D2": {
                        "description": "D2",
                        "type": "number"
                    },
                    "DELTA": {
                        "description": "Delta",
                        "type": "number"
                    },
                    "PRESSURE_LOAD": {
                        "description": "PressureLoad",
                        "type": "number"
                    },
                    "NUM_LOAD_ARRAY": {
                        "description": "Differentdiscretelengths",
                        "type": "array",
                        "items": {
                            "type": "integer"
                        }
                    },
                    "POINT_DIST_ARRAY": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "POINT_DIST": {
                                    "description": "PointDistance",
                                    "type": "array",
                                    "items": {
                                        "type": "number"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}


Examples

Vehicle - Standard

{
    "Assign": {
        "1": {
            "MVLD_CODE": 16,
            "VEHICLE_LOAD_NAME": "SA_NA",
            "VEHICLE_LOAD_NUM": 1,
            "VEHICLE_TYPE_NAME": "NA",
            "STANDARD_CODE": "TMH7",
            "VEH_ZA": {
                "INCRE_LENGTH": true,
                "INCRE_LENGTH_VALUE": 1
            }
        },
        "2": {
            "MVLD_CODE": 16,
            "VEHICLE_LOAD_NAME": "SA_NB",
            "VEHICLE_LOAD_NUM": 1,
            "VEHICLE_TYPE_NAME": "NB",
            "STANDARD_CODE": "TMH7",
            "VEH_ZA": {
                "UNIT_NUM": 36
            }
        },
        "3": {
            "MVLD_CODE": 16,
            "VEHICLE_LOAD_NAME": "SA_NC",
            "VEHICLE_LOAD_NUM": 1,
            "VEHICLE_TYPE_NAME": "NC",
            "STANDARD_CODE": "TMH7",
            "VEH_ZA": {
                "OPPOSITE": false
            }
        }
    }
}

Vehicle - User Defined

{
    "Assign": {
        "4": {
            "MVLD_CODE": 16,
            "VEHICLE_LOAD_NAME": "SA_NA",
            "VEHICLE_LOAD_NUM": 2,
            "USER_LOAD_TYPE": "NAType",
            "VEH_ZA": {
                "INCRE_LENGTH": false,
                "W1": 36,
                "W2": 180,
                "W3": 6,
                "LOADED_LENGTH": 36,
                "PA": 144
            }
        },
        "5": {
            "MVLD_CODE": 16,
            "VEHICLE_LOAD_NAME": "SA_NB",
            "VEHICLE_LOAD_NUM": 2,
            "USER_LOAD_TYPE": "NBType",
            "VEH_ZA": {
                "UNIT_NUM": 36,
                "PB": 10,
                "D1": 2,
                "D2": 6,
                "DELTA": 5
            }
        },
        "6": {
            "MVLD_CODE": 16,
            "VEHICLE_LOAD_NAME": "SA_NC",
            "VEHICLE_LOAD_NUM": 2,
            "USER_LOAD_TYPE": "NCType",
            "VEH_ZA": {
                "OPPOSITE": false,
                "PRESSURE_LOAD": 30,
                "NUM_LOAD_ARRAY": [
                    4,
                    3,
                    6
                ],
                "POINT_DIST_ARRAY": [
                    {
                        "POINT_DIST": [
                            5,
                            10,
                            15,
                            20
                        ]
                    },
                    {
                        "POINT_DIST": [
                            3,
                            4,
                            5
                        ]
                    },
                    {
                        "POINT_DIST": [
                            0,
                            5,
                            10,
                            15,
                            20,
                            25
                        ]
                    }
                ]
            }
        },
        "7": {
            "MVLD_CODE": 16,
            "VEHICLE_LOAD_NAME": "SA_Permit",
            "VEHICLE_LOAD_NUM": 3,
            "USER_LOAD_TYPE": "PermitTruck",
            "VEH_ZA": {
                "PERMIT_LOAD": {
                    "IMPACT_FACTOR": 0,
                    "AXLE_TYPES": [
                        {
                            "AXLE_TYPE": "Axle",
                            "EVENLY_DIST_LOAD": false,
                            "SYMMETRIC_VEHICLE": true,
                            "POINT_ITEMS": [
                                {
                                    "POINT_LOAD": 0.7,
                                    "POINT_DIST": 0.5
                                },
                                {
                                    "POINT_LOAD": 3,
                                    "POINT_DIST": 2.7
                                },
                                {
                                    "POINT_LOAD": 1.2,
                                    "POINT_DIST": 1
                                }
                            ]
                        }
                    ],
                    "PERMIT_LOADS": [
                        {
                            "AXLE_TYPE": "Axle",
                            "SPACING": 0,
                            "EQUAL_J_NVSIDX": false
                        }
                    ]
                }
            }
        },
        "8": {
            "MVLD_CODE": 16,
            "VEHICLE_LOAD_NAME": "SA_Permit_Even",
            "VEHICLE_LOAD_NUM": 3,
            "USER_LOAD_TYPE": "PermitTruck",
            "VEH_ZA": {
                "PERMIT_LOAD": {
                    "IMPACT_FACTOR": 0,
                    "AXLE_TYPES": [
                        {
                            "AXLE_TYPE": "Axle",
                            "EVENLY_DIST_LOAD": true,
                            "SYMMETRIC_VEHICLE": true,
                            "POINT_ITEMS": [
                                {
                                    "POINT_LOAD": 1,
                                    "POINT_DIST": 1.1
                                },
                                {
                                    "POINT_LOAD": 1,
                                    "POINT_DIST": 2
                                },
                                {
                                    "POINT_LOAD": 1,
                                    "POINT_DIST": 2.2
                                },
                                {
                                    "POINT_LOAD": 1,
                                    "POINT_DIST": 3.3
                                }
                            ]
                        }
                    ],
                    "PERMIT_LOADS": [
                        {
                            "AXLE_TYPE": "Axle",
                            "SPACING": 0,
                            "EQUAL_J_NVSIDX": false
                        }
                    ]
                }
            }
        }
    }
}


Specifications

No. Description Key Value Type Default Required

1

Function Name

 • South Africa: 16

"MVLD_CODE"

Integer

-

Required

2

Vehicular Load Name

"VEHICLE_LOAD_NAME"

String

-

Required

3

Vehicular Load Number

 • Standard: 1

 • User Defined

"VEHICLE_LOAD_NUM"

Integer

-

Required

4

Vehicular Type Name

 • TMH7 Standard Load: "TMH7"

"VEHICLE_TYPE_NAME"

String

-

Required

5

Standard Code

 • NA Type: "NA"

 • NB Type: "NB"

 • NC Type: "NC"

"STANDARD_CODE"

String

-

Required

6

User Defined Load Type

 • NA Type: "NA Type"

 • NB Type: "NB Type"

 • NC Type: "NC Type"

 • Permit Truck: "Permit Truck"

"USER_LOAD_TYPE"

String

-

Required

For Standard Vehicle - NA Type

7

Vehicle

"VEH_ZA"

Object

-

Required

(1)

Unit Length for Loaded Length Increment Option

"INCRE_LENGTH"

Boolean

false

Optional

(2)

Increment Length

"INCRE_LENGTH_VALUE"

Number

0

Optional

For Standard Vehicle - NB Type

7

Vehicle

"VEH_ZA"

Object

-

Required

(1)

Number of Unit

 • 36 or 24

"UNIT_NUM"

Number

-

Required

For Standard Vehicle - NC Type

7

Vehicle

"VEH_ZA"

Object

-

Required

(1)

Consider Load Area Giving Opposite Contribution

"OPPOSITE"

Boolean

false

Optional

For User Defined Vehicle - NA Type

7

Vehicle

"VEH_ZA"

Object

-

Required

(1)

Unit Length for Loaded Length Increment Option

"INCRE_LENGTH"

Boolean

false

Optional

(2)

Increment Length

"INCRE_LENGTH_VALUE"

Number

0

Optional

(3)

Uniform Distribution Load

 • Not Exceeding Loaded Length

"W1"

Number

-

Required

(4)

Uniform Distribution Load

 • Exceeding Loaded Length

"W2"

Number

-

Required

(5)

Uniform Distribution Load

 • Exceeding Loaded Length

"W3"

Number

-

Required

(6)

Loaded Length

"LOADED_LENGTH"

Number

-

Required

(7)

Axle Load (Pa)

"PA"

Number

0

Optional

For User Defined Vehicle - NB Type

7

Vehicle

"VEH_ZA"

Object

-

Required

(1)

Axle Load (Pb)

"PB"

Number

-

Required

(2)

Number of Units

"UNIT_NUM"

Integer

-

Required

(3)

Distance between Axle Load (End)

"D1"

Number

0

Optional

(4)

Distance between Axle Load (Middel)

"D2"

Number

0

Optional

(5)

Factor to Calculate D3, D4, D5, D6

"DELTA"

Number

0

Optional

For User Defined Vehicle - NC Type

7

Vehicle

"VEH_ZA"

Object

-

Required

(1)

Uniform Distribution Load

"PRESSURE_LOAD"

Number

-

Required

(2)

Consider Load Area Giving Opposite Contribution

"OPPOSITE"

Boolean

false

Optional

(3)

Number of Load

 • [a, b, c]

"NUM_LOAD_ARRAY"

Array
[Integer, 3]

-

Required

(4)

Different Discreate Lengths

"POINT_DIST_ARRAY"

Array
[Object, 3]

-

Required

i. Discreate Length of Each Point

 • Insert Data as Object

"POINT_DIST"

Array
[Number]

-

Required

For User Defined Vehicle - Permit Truck

7

Vehicle

"VEH_ZA"

Object

-

Required

(1)

Permit Load

"PERMIT_LOAD"

Object

-

Required

i. Impact Factor

"IMPACT_FACTOR"

Number

0

Optional

ii. Axle Types ¹⁾

"AXLE_TYPES"

Array
[Object]

-

Required

iii. Permit Load ¹⁾

"PERMIT_LOADS"

Array
[Object]

-

Required



¹⁾ Permit Truck - JSON Structure

No. Description Key Value Type Default Required

1

Axle Types

 • Insert the data as an object

"AXLE_TYPES"

Array
[Object]

-

Required

(1)

Axle Name

"AXLE_TYPE"

String

-

Required

(2)

Evenly Distributed Wheel Load

"EVENLY_DIST_LOAD"

Boolean

false

Optional

(3)

Symmetric Vehicle

"SYMMETRIC_VEHICLE"

Boolean

false

Optional

(4)

Axle Load

 • Insert the data as an object

"POINT_ITEMS"

Array
[Object]

-

Required

i. Axle Load

"POINT_LOAD"

Number

-

Required

ii. Spacing

"POINT_DIST"

Number

-

Required

2

Permit Load

 • Insert the data as an object

"PERMIT_LOADS"

Array
[Object]

-

Required

(1)

Defined Axle Name

"AXLE_TYPE"

String

-

Required

(2)

Distance between axle

"SPACING"

Number

-

Required

(3)

Variable Spacing of Axle in Longitudinal Direction

"EQUAL_J_NVSIDX"

Boolean

false

Optional



0
Was this article helpful?