Versions Compared

Old Version 29

changes.mady.by.user Ivan Pavlovcik

Saved on

compared with

New Version 30

changes.mady.by.user Ivan Pavlovcik

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Deck of Cards
idbimGetCrossSection
Card
defaulttrue
labelURL / Resource / JSON Structure
Resource: content/crosssections/<cross_section_id>

URL: https://api-stage.bimplus.net/v2/ content/crosssections/<cross_section_id>

Example: https://api-stage.bimplus.net/v2/content/crosssections/bef3f6a2-e869-4282-adab-84114ad672f7


Optional query parameters

NameTypeDefault valueDescription
filterstring 

When filter "name=I200" is defined the API will return only cross sections which Name contains requested sub-string,
e.g. if filter is "name=I1" will be returned all cross section which Name contains substring "I1".
Like I100 I150, etc.

When filter "group=Z" is defined the API will return only cross sections which belongs to group with name "Z".

roundbooleantrue

When round parameter is defined with value "false", API will return simplified cross section geometry, in which .
In such case has all arc segmets has radius equal to zero.

NOTE :
To get details for cross section or groups of cross sections without known or available cross_section_id is possible
to use this call without using cross_section_id, but in such case must be defined requested cross section(s) with filter.
When is used filter to define requested cross sections will be returned all cross sections with matching filter pattern.

e.g. to get all cross sections which names contains string 'H200' let's use api with filter

https://api-stage.bimplus.net/v2/content/crosssections?filter=name=H200

In case you know only cross section name, this name can be used in place of <cross_section_id>. In this case will be returned
wanted cross section with required name. If required name was not found will be returned error 404 Not found.

e.g.: https://api-stage.bimplus.net/v2/content/crosssections/H200

Card
labelHTTP Method
 GET
Card
labelDescription
 Get details of a specified cross section
Card
labelRequest
Code Block
borderColorGreen
langxml
titleHeaders
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json
Card
labelResponse
Code Block
borderColorGreen
langxml
titleStatus
Status: 200 OK
Code Block
borderColorRed
langxml
titleJSON
{
	"name":"IPE-200",
	"description":"parameters IPE-200",
	"id":"bef3f6a2-e869-4282-adab-84114ad672f7"
	"crossSectionParameters":
	[
		{
			"freeAttibId":"a51576ae-ecaa-43c0-b00c-1ae5efaae4f0",
			"value":200
			"name":B
		},
		{
			"freeAttibId":"46065318-8776-4f30-85ff-c7276b094097",
			"value":5.6
			"name":r1
		},
		{
			"freeAttibId":"ec94c7ee-b810-4012-9e94-cc7ed2a9c4bd",
			"value":100,
			"name":s

		},
		{
			"freeAttibId":"d5e91f99-ff75-4262-b21e-05dea7bff340",
			"value":8.5
			"name":t
		},
		{
			"freeAttibId":"df51e064-ee1b-4b5d-bdaa-5b053fd8b8a2",
			"value":12
			"name":h
		}
	],
	"crossSectionCharacteristics":
	[
		{
			"freeAttibId": "f6dccf78-0bb7-4fe7-bd24-a6dee284fcd0",
            "value": 200,
            "name": "Area"
        }
	],
	"shape": 
	[
        {
            "x": 0,
            "y": 0,
            "z": 0
        },
        {
            "x": 200,
            "y": 0,
            "z": 0
        },
        {
            "x": 200,
            "y": 108.5315793,
            "z": 0
        },
        {
            "x": 199.3260249,
            "y": 110.9033885,
            "z": 0
        },
        {
            "x": 197.7059317,
            "y": 112.7599257,
            "z": 0
        },
	...
	]
}

...