Moving Load Vehicles

Endpoint/api/v1

Reusable vehicle wheel-load sets referenced by moving-load scenario loads

List

GET

/api/v1

/job/loads/moving-loads/vehicles

Lists the items in this catalog for the current job, ordered by Id. Supports offset/limit pagination; the response carries Total-Count, Offset, and Limit headers.

List › query Parameters

offset

integer · int32 · min: 0 · max: 2147483647

Number of items to skip from the start of the result set. Default is 0.

limit

integer · int32 · min: 1 · max: 2147483647

Maximum number of items to return. Default is null (return all).

expand

string · enum

Whether to hydrate each item's sub-resources inline. Defaults to None for the list.

Controls sub-resource hydration on entity GET endpoints. Shared across every resource that supports expansion — a given resource's metadata (expandable) lists which sub-resources All hydrates.

Enum values:

None

All

List › Responses

Returns the items

object[]

A moving-load vehicle — a named set of wheel loads, either user-defined or imported from a vehicle library. A vehicle carries its own units (length/force/moment); its wheel loads are stored in those units and are not affected by job-level unit conversion.

id

integer · int32

The item Id.

Example: 1

name

string | null

The vehicle name. Unique across all vehicles.

Example: T44 Truck

source

string · enum

Origin of a moving-load vehicle. Mirrors SPACE GASS MLVehicleSource (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

User

Library

library

string | null

The name of the library the vehicle was imported from.

Example: Aust_Bridge_Vehicles

array | null

The vehicle's wheel loads.

object

The units a vehicle's wheel loads are stored in. Independent of the job-level units.

Create

POST

/api/v1

/job/loads/moving-loads/vehicles

Creates a new catalog item. Supply id to choose the Id, or omit it to have the next available Id auto-assigned.

Create › Request Body

Creates a user-defined vehicle from supplied wheel loads. To import a vehicle from a library instead, use `POST moving-loads/vehicles/library`.

id

integer | null · int32 · min: 1 · max: 2147483647

The Id to assign to the new item.

Example: 1

name

string | null

The vehicle name. Must be unique across all vehicles.

Example: T44 Truck

array | null

The vehicle's wheel loads. Must contain at least one wheel.

object

The units a vehicle's wheel loads are stored in. Independent of the job-level units.

Create › Responses

Returns the created item

id

integer · int32

The item Id.

Example: 1

name

string | null

The vehicle name. Unique across all vehicles.

Example: T44 Truck

source

string · enum

Origin of a moving-load vehicle. Mirrors SPACE GASS MLVehicleSource (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

User

Library

library

string | null

The name of the library the vehicle was imported from.

Example: Aust_Bridge_Vehicles

array | null

The vehicle's wheel loads.

object

The units a vehicle's wheel loads are stored in. Independent of the job-level units.

POST/job/loads/moving-loads/vehicles

curl --request POST \
  --url /api/v1/job/loads/moving-loads/vehicles \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "name": "T44 Truck",
  "loads": [
    {
      "x": 0,
      "y": 1.8,
      "fx": 0,
      "fy": 0,
      "fz": -48,
      "mx": 0,
      "my": 0,
      "mz": 0
    }
  ],
  "loadUnits": {
    "length": "ft",
    "force": "K",
    "moment": "Kft"
  }
}
'

shell

Example Request Body

{
  "id": 1,
  "name": "T44 Truck",
  "loads": [
    {
      "x": 0,
      "y": 1.8,
      "fx": 0,
      "fy": 0,
      "fz": -48,
      "mx": 0,
      "my": 0,
      "mz": 0
    }
  ],
  "loadUnits": {
    "length": "ft",
    "force": "K",
    "moment": "Kft"
  }
}

json

Example Responses

{
  "id": 1,
  "name": "T44 Truck",
  "source": "User",
  "library": "Aust_Bridge_Vehicles",
  "loads": [
    {
      "x": 0,
      "y": 1.8,
      "fx": 0,
      "fy": 0,
      "fz": -48,
      "mx": 0,
      "my": 0,
      "mz": 0
    }
  ],
  "loadUnits": {
    "length": "ft",
    "force": "K",
    "moment": "Kft"
  }
}

json

application/json

Get

GET

/api/v1

/job/loads/moving-loads/vehicles/{id}

Gets a single catalog item by Id.

Get › path Parameters

id

integer · int32 · required

The item Id

Get › query Parameters

expand

string · enum

Whether to hydrate the item's sub-resources inline. Defaults to All for a single fetch.

Controls sub-resource hydration on entity GET endpoints. Shared across every resource that supports expansion — a given resource's metadata (expandable) lists which sub-resources All hydrates.

Enum values:

None

All

Get › Responses

Returns the item

id

integer · int32

The item Id.

Example: 1

name

string | null

The vehicle name. Unique across all vehicles.

Example: T44 Truck

source

string · enum

Origin of a moving-load vehicle. Mirrors SPACE GASS MLVehicleSource (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

User

Library

library

string | null

The name of the library the vehicle was imported from.

Example: Aust_Bridge_Vehicles

array | null

The vehicle's wheel loads.

object

The units a vehicle's wheel loads are stored in. Independent of the job-level units.

Delete

DELETE

/api/v1

/job/loads/moving-loads/vehicles/{id}

Deletes a catalog item. Only unused items can be deleted.

Delete › path Parameters

id

integer · int32 · required

The item Id

Delete › Responses

Deleted

No data returned

Update

PATCH

/api/v1

/job/loads/moving-loads/vehicles/{id}

Partially updates a catalog item; omitted fields keep their current value.

Update › path Parameters

id

integer · int32 · required

The item Id

Update › Request Body

Partial update for a user-defined vehicle. All properties are optional; omitted properties keep their current value. A library vehicle's source and library cannot be changed here, and load units are fixed at create and intentionally not updatable.

id

integer · int32

The Id of the item to update.

Example: 1

name

string | null

Replacement vehicle name. Must remain unique. Omit to keep current.

Example: T44 Truck

array | null

Replacement wheel loads. When present, replaces the entire wheel-load list. Omit to keep current.

Update › Responses

Returns the updated item

id

integer · int32

The item Id.

Example: 1

name

string | null

The vehicle name. Unique across all vehicles.

Example: T44 Truck

source

string · enum

Origin of a moving-load vehicle. Mirrors SPACE GASS MLVehicleSource (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

User

Library

library

string | null

The name of the library the vehicle was imported from.

Example: Aust_Bridge_Vehicles

array | null

The vehicle's wheel loads.

object

The units a vehicle's wheel loads are stored in. Independent of the job-level units.

PATCH/job/loads/moving-loads/vehicles/{id}

curl --request PATCH \
  --url /api/v1/job/loads/moving-loads/vehicles/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "name": "T44 Truck",
  "loads": [
    {
      "x": 0,
      "y": 1.8,
      "fx": 0,
      "fy": 0,
      "fz": -48,
      "mx": 0,
      "my": 0,
      "mz": 0
    }
  ]
}
'

shell

Example Request Body

{
  "id": 1,
  "name": "T44 Truck",
  "loads": [
    {
      "x": 0,
      "y": 1.8,
      "fx": 0,
      "fy": 0,
      "fz": -48,
      "mx": 0,
      "my": 0,
      "mz": 0
    }
  ]
}

json

Example Responses

{
  "id": 1,
  "name": "T44 Truck",
  "source": "User",
  "library": "Aust_Bridge_Vehicles",
  "loads": [
    {
      "x": 0,
      "y": 1.8,
      "fx": 0,
      "fy": 0,
      "fz": -48,
      "mx": 0,
      "my": 0,
      "mz": 0
    }
  ],
  "loadUnits": {
    "length": "ft",
    "force": "K",
    "moment": "Kft"
  }
}

json

application/json

Get Metadata

GET

/api/v1

/job/loads/moving-loads/vehicles/metadata

Returns the schema for this catalog resource.

Get Metadata › Responses

Returns the schema

Metadata describing an API resource — entity, sub-resource, or result set. Returned from `GET …/metadata` endpoints so clients can introspect the shape, units, and valid values of the data without hitting a live endpoint.

resourceType

string · enum

Identifies entity types managed by the API. Kept separate from SGFileID to allow for future API-only entities that may not have a formal SPACE GASS FileID.

Enum values:

Nodes

Members

Plates

PlateCuts

PlateStrips

Solids

NodeLoads

MemberConcentratedLoads

count

integer | null · int32

Current count of items in this resource. Null for sub-resources whose count does not apply uniformly.

maxId

integer | null · int32

Maximum Id currently in use (single-int Id entities only).

nextId

integer | null · int32

Next available Id (single-int Id entities only).

array | null

Field definitions describing the resource's wire shape. Each entry corresponds to a property on the read DTO; jsonName matches the JSON key clients see.

Next Id

GET

/api/v1

/job/loads/moving-loads/vehicles/next

Gets the next available (unused) Id for this catalog resource.

Next Id › query Parameters

start

integer · int32

The Id value to start searching from (inclusive). Defaults to 1.

Default: 1

Next Id › Responses

Returns the next available Id

integer · int32

Create Bulk

POST

/api/v1

/job/loads/moving-loads/vehicles/bulk

Creates multiple catalog items in one call; they persist with a single save.

Create Bulk › query Parameters

continueOnError

boolean

Whether to continue processing after individual failures

Default: false

Create Bulk › Request Body

object[]

Creates a user-defined vehicle from supplied wheel loads. To import a vehicle from a library instead, use `POST moving-loads/vehicles/library`.

id

integer | null · int32 · min: 1 · max: 2147483647

The Id to assign to the new item.

Example: 1

name

string | null

The vehicle name. Must be unique across all vehicles.

Example: T44 Truck

array | null

The vehicle's wheel loads. Must contain at least one wheel.

object

The units a vehicle's wheel loads are stored in. Independent of the job-level units.

Create Bulk › Responses

Returns the bulk result (created items + per-item errors)

Result of a bulk operation.

array | null

Successfully processed items.

array | null

Errors from failed items.

errorsTruncated

boolean

True when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.

POST/job/loads/moving-loads/vehicles/bulk

curl --request POST \
  --url /api/v1/job/loads/moving-loads/vehicles/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "T44 Truck",
    "loads": [
      {
        "x": 0,
        "y": 1.8,
        "fx": 0,
        "fy": 0,
        "fz": -48,
        "mx": 0,
        "my": 0,
        "mz": 0
      }
    ],
    "loadUnits": {
      "length": "ft",
      "force": "K",
      "moment": "Kft"
    }
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "T44 Truck",
    "loads": [
      {
        "x": 0,
        "y": 1.8,
        "fx": 0,
        "fy": 0,
        "fz": -48,
        "mx": 0,
        "my": 0,
        "mz": 0
      }
    ],
    "loadUnits": {
      "length": "ft",
      "force": "K",
      "moment": "Kft"
    }
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "T44 Truck",
      "source": "User",
      "library": "Aust_Bridge_Vehicles",
      "loads": [
        {
          "x": 0,
          "y": 1.8,
          "fx": 0,
          "fy": 0,
          "fz": -48,
          "mx": 0,
          "my": 0,
          "mz": 0
        }
      ],
      "loadUnits": {
        "length": "ft",
        "force": "K",
        "moment": "Kft"
      }
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Delete Bulk

DELETE

/api/v1

/job/loads/moving-loads/vehicles/bulk

Deletes multiple catalog items by Id. The body is a JSON array of integer Ids (e.g. [1, 5, 10]). An item referenced by a scenario load fails with an in-use error rather than being deleted.

Delete Bulk › query Parameters

continueOnError

boolean

Whether to continue processing after individual failures

Default: false

Delete Bulk › Request Body

integer[]

Delete Bulk › Responses

Returns the bulk result (deleted Ids + per-item errors)

Result of a bulk operation.

array | null

Successfully processed items.

array | null

Errors from failed items.

errorsTruncated

boolean

True when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.

Update Bulk

PATCH

/api/v1

/job/loads/moving-loads/vehicles/bulk

Partially updates multiple catalog items in one call; each body item carries the id of the item to update. They persist with a single save.

Update Bulk › query Parameters

continueOnError

boolean

Whether to continue processing after individual failures

Default: false

Update Bulk › Request Body

object[]

id

integer · int32

The Id of the item to update.

Example: 1

name

string | null

Replacement vehicle name. Must remain unique. Omit to keep current.

Example: T44 Truck

array | null

Replacement wheel loads. When present, replaces the entire wheel-load list. Omit to keep current.

Update Bulk › Responses

Returns the bulk result (updated items + per-item errors)

Result of a bulk operation.

array | null

Successfully processed items.

array | null

Errors from failed items.

errorsTruncated

boolean

True when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.

PATCH/job/loads/moving-loads/vehicles/bulk

curl --request PATCH \
  --url /api/v1/job/loads/moving-loads/vehicles/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "T44 Truck",
    "loads": [
      {
        "x": 0,
        "y": 1.8,
        "fx": 0,
        "fy": 0,
        "fz": -48,
        "mx": 0,
        "my": 0,
        "mz": 0
      }
    ]
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "T44 Truck",
    "loads": [
      {
        "x": 0,
        "y": 1.8,
        "fx": 0,
        "fy": 0,
        "fz": -48,
        "mx": 0,
        "my": 0,
        "mz": 0
      }
    ]
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "T44 Truck",
      "source": "User",
      "library": "Aust_Bridge_Vehicles",
      "loads": [
        {
          "x": 0,
          "y": 1.8,
          "fx": 0,
          "fy": 0,
          "fz": -48,
          "mx": 0,
          "my": 0,
          "mz": 0
        }
      ],
      "loadUnits": {
        "length": "ft",
        "force": "K",
        "moment": "Kft"
      }
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Import Vehicle From Library

POST

/api/v1

/job/loads/moving-loads/vehicles/library

Creates a vehicle by importing it from a vehicle library; wheel loads and units are copied from the library item.

Import Vehicle From Library › Request Body

Imports a vehicle from a vehicle library by name. The imported wheel loads are converted to the current job units.

id

integer | null · int32 · min: 1 · max: 2147483647

The Id to assign to the new item.

Example: 1

name

string | null

The vehicle item name within the library.

Example: T44

library

string | null

The library name to import from.

Example: Aust_Bridge_Vehicles

Import Vehicle From Library › Responses

Returns the imported vehicle

id

integer · int32

The item Id.

Example: 1

name

string | null

The vehicle name. Unique across all vehicles.

Example: T44 Truck

source

string · enum

Origin of a moving-load vehicle. Mirrors SPACE GASS MLVehicleSource (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

User

Library

library

string | null

The name of the library the vehicle was imported from.

Example: Aust_Bridge_Vehicles

array | null

The vehicle's wheel loads.

object

The units a vehicle's wheel loads are stored in. Independent of the job-level units.

Replace Vehicle From Library

PUT

/api/v1

/job/loads/moving-loads/vehicles/{id}/library

Replaces an existing vehicle in place with the library version, preserving its Id.

Replace Vehicle From Library › path Parameters

id

integer · int32 · required

The vehicle Id to replace

Replace Vehicle From Library › Request Body

Imports a vehicle from a vehicle library by name. The imported wheel loads are converted to the current job units.

id

integer | null · int32 · min: 1 · max: 2147483647

The Id to assign to the new item.

Example: 1

name

string | null

The vehicle item name within the library.

Example: T44

library

string | null

The library name to import from.

Example: Aust_Bridge_Vehicles

Replace Vehicle From Library › Responses

Returns the replaced vehicle

id

integer · int32

The item Id.

Example: 1

name

string | null

The vehicle name. Unique across all vehicles.

Example: T44 Truck

source

string · enum

Origin of a moving-load vehicle. Mirrors SPACE GASS MLVehicleSource (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

User

Library

library

string | null

The name of the library the vehicle was imported from.

Example: Aust_Bridge_Vehicles

array | null

The vehicle's wheel loads.

object

The units a vehicle's wheel loads are stored in. Independent of the job-level units.

Moving Load Scenarios Moving Load Pressures