Catalog Service
- Create a new catalog
- Get the catalog list
- Get the catalog details
- Update the specified catalog
- Get the catalog item list from the specified catalog
- Delete the specified catalog
Catalog Service
Create a new norm
URL: https://api-stage.bimplus.net/v2/ norms
Example: https://api-stage.bimplus.net/v2/norms
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
id | will be ignored | string(guid) | The id of the norm. Will be taken from request url. |
name | mandatory | string | Norm name |
description | optional | string | Norm description |
Create a new norm.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "name":"DIN 1046", "description":"DIN 1046" }
Status: 201 Created
{ "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385", "name":"DIN 1046", "description":"DIN 1046" }
Get the norm list
URL: https://api-stage.bimplus.net/v2/ norms
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[{ "id":"6de06146-125f-c7eb-95cc-0c07d85c4d94", "name":"DIN 1045", "description":"DIN 1045" }, { "id":"0da7bbc8-c63d-d090-c458-1431f78987e0", "name":"DIN 17100", "description":"DIN 17100" } ]
Get the norm details
URL: https://api-stage.bimplus.net/v2/ norms/<norm_id>
Example: https://api-stage.bimplus.net/v2/norms/6de06146-125f-c7eb-95cc-0c07d85c4d94
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "id":"6de06146-125f-c7eb-95cc-0c07d85c4d94", "name":"DIN 1045", "description":"DIN 1045" }
Delete the specified norm
Resource: norms
URL: https://api-stage.bimplus.net/v2/ norms/<norm_id>
Example: https://api-stage.bimplus.net/v2/norms/6de06146-125f-c7eb-95cc-0c07d85c4d94
Delete the specified norm
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Create a new country
URL: https://api-stage.bimplus.net/v2/ countries
Example: https://api-stage.bimplus.net/v2/countries
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
id | will be ignored | string(guid) | The id of the country. Will be taken from request url. |
name | mandatory | string | Country name |
description | optional | string | Country description |
Create a new country.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "name":"Austria", "description":"Austria" }
Status: 201 Created
{ "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385", "name":"Austria", "description":"Austria" }
Get the country list
Resource: countries
URL: https://api-stage.bimplus.net/v2/ countries
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[{ "id":"2909b0d8-c6de-425d-2303-256336ada04f", "name":"Germany", "description":"Germany" }, { "id":"b7e10710-94f8-bfdf-72a0-eaa80f3bc57e", "name":"Italy", "description":"Italy" } ]
Get the country details
Resource: countries
URL: https://api-stage.bimplus.net/v2/ countries/<country_id>
Example: https://api-stage.bimplus.net/v2/countries/ed9fe5ba-96c0-f24d-9779-b06b7ce69385
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "id":"ed9fe5ba-96c0-f24d-9779-b06b7ce69385", "name":"Austria", "description":"Austria" }
Delete the specified country
Resource: countries
URL: https://api-stage.bimplus.net/v2/ countries/<country_id>
Example: https://api-stage.bimplus.net/v2/countries/ed9fe5ba-96c0-f24d-9779-b06b7ce69385
Delete the specified country
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
Get a list of catalog types
URL: https://api-stage.bimplus.net/v2/ catalogs/types
Example: https://api-stage.bimplus.net/v2/catalogs/types
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
id | will be ignored | string(guid) | The id of the catalog type. |
name | mandatory | string | Catalog type name |
description | optional | string | Catalog type description |
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[{ "id":"992bdb90-e093-4e6d-82cd-d8395ec14496", "name":"Material", "description":"Material" }, ... ]
Get the catalog type details
Resource: catalogs/types
URL: https://api-stage.bimplus.net/v2/ catalogs/types/<catalogType_id>
Example: https://api-stage.bimplus.net/v2/catalogs/types/992bdb90-e093-4e6d-82cd-d8395ec14496
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "id":"992bdb90-e093-4e6d-82cd-d8395ec14496", "name":"Material", "description":"Material" }
Create a new catalog item
URL: https://api-stage.bimplus.net/v2/ catalogitems
Example: https://api-stage.bimplus.net/v2/catalogitems
JSON Structure:
Name |
Mandatory / Optional |
Type |
Description |
---|---|---|---|
id | will be ignored | string(guid) | The id of the catalog item |
name | mandatory | string | Catalog item name |
description | optional | string | Catalog item description |
catalogId | mandatory | string | Catalog id. Newly created catalog item belongs to this catalog |
properties | optional | object(dictionary) | Object which contains pairs of all parameter values for catalog item. Value in pair represent attribute value of the attribute with Id specified as key in pair. |
Create a new catalog item to the specified catalog.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/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 }, "name":"S 998", "description":"test catalog item " }
Status: 201 Created
{ "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 " }
Get the catalog item details
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
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "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 " }
Create a new catalog
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 |
Create a new catalog.
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "name":"Timber", "description":"Timber", "catalogtype":{ "id":"992bdb90-e093-4e6d-82cd-d8395ec14496" } }
Status: 201 Created
{ "norms":[], "countries":[], "catalogType":{ "id":"992bdb90-e093-4e6d-82cd-d8395ec14496", "name":"Material", "description":"Material" }, "id":"10e3f185-234e-9686-5fea-73075149abd2", "name":"Timber", "description":"Timber" }
Get the catalog list
Resource: catalogs
URL: https://api-stage.bimplus.net/v2/ catalogs
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[{ "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" } ]
Get the catalog details
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
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
{ "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" }
Update the specified catalog
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
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
{ "norms":[{ "id":"0da7bbc8-c63d-d090-c458-1431f78987e0", "name":"European", "description":"European" } ], "countries":[], "catalogType":{ "id":"992bdb90-e093-4e6d-82cd-d8395ec14496", "name":"Material", "description":"Material" }, "name":"Concrete X", "description":"Concrete" }
Status: 200 OK
{ "norms":[{ "id":"0da7bbc8-c63d-d090-c458-1431f78987e0", "name":"European", "description":"European" } ], "countries":[], "catalogType":{ "id":"992bdb90-e093-4e6d-82cd-d8395ec14496", "name":"Material", "description":"Material" }, "id":"ae2122c0-f667-f242-40ee-3e57161e433a", "name":"Concrete X", "description":"Concrete" }
Get the catalog item list from the specified catalog
Resource: catalogs/<catalog_id>/items
URL: https://api-stage.bimplus.net/v2/ catalogs/<catalog_id>/items
Example: https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK
[{ "catalogId":"10e3f185-234e-9686-5fea-73075149abd2", "id":"754da75a-c96d-6d4f-01a9-33a178394ecb", "name":"GL 26h", "description":"(EN 14080)" }, { "catalogId":"10e3f185-234e-9686-5fea-73075149abd2", "id":"27d2555d-2245-a84a-7950-a4898077261f", "name":"GL 30h", "description":"(EN 14080)" }, { "catalogId":"10e3f185-234e-9686-5fea-73075149abd2", "id":"02ce9b8b-720c-a44c-b115-f45a0de7d965", "name":"GL 32c", "description":"(EN 14080)" }, { "catalogId":"10e3f185-234e-9686-5fea-73075149abd2", "id":"0e00c600-8004-6a03-8110-4d38c3dc40aa", "name":"GL 24h", "description":"(EN 14080)" }, { "catalogId":"10e3f185-234e-9686-5fea-73075149abd2", "id":"fb3bfbb8-aa6a-64b3-b78e-8950ca107891", "name":"GL 28h", "description":"(EN 14080)" }, { "catalogId":"10e3f185-234e-9686-5fea-73075149abd2", "id":"9be0c733-243d-2e1c-c79c-7be0a2b6c1a3", "name":"GL 32h", "description":"(EN 14080)" } ]
Delete the specified catalog
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
Delete the specified catalog
Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088 Content-Type: application/json
Status: 200 OK