Page History

...

Deck of Cards

id	bimGetCatalogItem

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogitems

URL: https://api-stage.bimplus.net/v2/ catalogitems/<catalogitem_id>

Example: https://api-stage.bimplus.net/v2/catalogitems/f15e402a-d29d-023c-745d-2b2f41c58483

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified catalog item

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "catalogId":"2d116846-5f7c-a780-3a82-6dd8150989df",
  "properties":{
    "7f670d2a-6c00-4fb1-0dce-bb4f700ca0f4":"1.2e-05",
    "029ca99d-d590-3f36-60ad-c2f8538b6bf4":"No",
    "9df611ca-c547-e0ab-4595-8a017a383592":210000000000,
    "ca5d193d-c7c8-be57-a244-e7d751a67824":80769200000,
    "ceb34ade-8a26-f9a5-b3ea-f247486a1778":7850,
    "52941ec9-f125-d765-aaca-07c7a3e86997":0.3,
    "efd8c210-8d8e-21e6-987f-8924159f961f":0.15,
    "c905659b-74c8-dd27-7c61-e9722abbf9a3":600,
    "9813d85d-cd87-1db0-a4ce-08a94375ecae":45,
    "633a90c2-a927-faf3-22d4-7a17e4f2b81a":355000000,
    "d450c196-451f-6811-0b47-53c5b81f2cc9":470000000
  },
  "id":"f15e402a-d29d-023c-745d-2b2f41c58483",
  "name":"S 998",
  "description":"test catalog item "
}

Anchor

	createCatalog
	createCatalog

Create a new catalog

Deck of Cards

id	bimCreateCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs

Example: https://api-stage.bimplus.net/v2/catalogs

JSON Structure:

Name	Mandatory / Optional	Type	Description
id	will be ignored	string(guid)	The id of the catalog
name	mandatory	string	Catalog name
description	optional	string	Catalog description
catalogtype	mandatory	object	Catalog type object. Mandatory is only Id of the catalog type object. See response of Get a list of catalog types
norms	optional	JSON array	Array of norm objects, see json response part of Get the norm list . Mandatory is only Id of the norm object
countries	optional	JSON array	Array of country objects, see json response part of Get the country list . Mandatory is only Id of the country object

Card

label	HTTP Method

POST

Card

label	Description

Create a new catalog.

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "name":"Timber",
  "description":"Timber",
  "catalogtype":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496"
  }
}

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 201 Created

Code Block

title	JSON

{
  "norms":[],
  "countries":[],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  "id":"10e3f185-234e-9686-5fea-73075149abd2",
  "name":"Timber",
  "description":"Timber"
}

Anchor

	getCatalogList
	getCatalogList

Get the catalog list

Deck of Cards

id	bimGetCatalogList

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs

Example: https://api-stage.bimplus.net/v2/catalogs

Card

label	HTTP Method

GET

Card

label	Description

Gets the catalog list

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

[{
    "norms":[{
        "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
        "name":"EC"
      }
    ],
    "countries":[{
        "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "name":"Standard EN"
      }
    ],
    "catalogType":{
      "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
      "name":"Material",
      "description":"Material"
    },
    "id":"2d116846-5f7c-a780-3a82-6dd8150989df",
    "name":"Steel",
    "description":"Steel"
  },
  {
    "norms":[{
        "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
        "name":"EC"
      }
    ],
    "countries":[{
        "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "name":"Standard EN"
      }
    ],
    "catalogType":{
      "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
      "name":"Material",
      "description":"Material"
    },
    "id":"ae2122c0-f667-f242-40ee-3e57161e433a",
    "name":"Concrete",
    "description":"Concrete"
  },
  {
    "norms":[{
        "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
        "name":"EC"
      }
    ],
    "countries":[{
        "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
        "name":"Standard EN"
      }
    ],
    "catalogType":{
      "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
      "name":"Material",
      "description":"Material"
    },
    "id":"2e5f209b-98e4-f731-9f54-f9ade4a87587",
    "name":"Aluminium",
    "description":"Aluminium"
  }
]

Anchor

	getCatalog
	getCatalog

Get the catalog details

Deck of Cards

id	bimGetCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs/<catalog_id>

Example: https://api-stage.bimplus.net/v2/catalogs/ae2122c0-f667-f242-40ee-3e57161e433a

Card

label	HTTP Method

GET

Card

label	Description

Get information about a specified catalog

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Code Block

borderColor	Red
lang	xml
title	JSON

{
  "norms":[{
      "id":"96b6d63f-7d86-2270-5ded-a7868308679b",
      "name":"EC"
    }
  ],
  "countries":[{
      "id":"7a286f49-ca3e-f2c9-2555-af6f9713071c",
      "name":"Standard EN"
    }
  ],
  "catalogType":{
    "id":"992bdb90-e093-4e6d-82cd-d8395ec14496",
    "name":"Material",
    "description":"Material"
  },
  "id":"ae2122c0-f667-f242-40ee-3e57161e433a",
  "name":"Concrete",
  "description":"Concrete"
}

Anchor

	deleteCatalog
	deleteCatalog

Delete the specified catalog

Deck of Cards

id	bimDeleteCatalog

Card

default	true
label	URL / Resource / JSON Structure

Resource: catalogs

URL: https://api-stage.bimplus.net/v2/ catalogs/<catalog_id>

Example: https://api-stage.bimplus.net/v2/catalogs/ae2122c0-f667-f242-40ee-3e57161e433a

Card

label	HTTP Method

DELETE

Card

label	Description

Delete the specified catalog

Card

label	Request

Code Block

borderColor	Green
lang	xml
title	Headers

Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
Content-Type: application/json

Card

label	Response

Code Block

borderColor	Green
lang	xml
title	Status

Status: 200 OK

Math Editor

Space shortcuts

Page tree

Versions Compared

Old Version 10

New Version 11

Key

Create a new catalog

Get the catalog list

Get the catalog details

Delete the specified catalog