SHshapemaker
structures

Get Foundation Compatibility For Structure With Id

This endpoint retrieves the foundation compatibility status for a structure by its ID. The structure ID should be provided as a path parameter in the URL.

The response is a boolean value that indicates whether the structure is compatible with the foundation analysis tool.

get/v1/structures/{structure_id}/foundation/compatibility

Request

  • Base URL
    https://api.shapemaker.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /v1/auth

Path parameters

structure_idstring required

Response

Returns compatibility information between the foundation and structure.

isCompatibleboolean required
cause'PAD_WIDTH_TOO_SMALL' | 'PIER_WIDTH_TOO_SMALL' | 'FOUNDATION_TYPE_INCOMPATIBLE_WITH_STRUCTURE_TYPE'

Changes

No recorded changes to this operation across all 1 revision of this API.