Catalog Service
Catalog Service
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"
}
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"
}
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"
}
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
Optional query parameters: Used to refine and reduce the set of returned catalog items
Name |
Type |
Default value |
Description |
|---|---|---|---|
| unit | string | metric | When query parameter "unit=imperial" is defined, the API will return free-attribute of catalog item with imperial unit. Query unit can be only ?unit=metric or ?unit=imperial. |
| filter | string | When filter "name=I200" is defined the API will return only of catalog item which Name contains requested sub-string, e.g. https://api-stage.bimplus.net/v2/catalogitems?filter=name=I1 if filter is "name=I1" will be returned all catalog items which Name contains substring "I1". |
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 "
}
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"
}
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
Optional query parameters: Used to refine and reduce the set of returned catalog items
Name |
Type |
Default value |
Description |
|---|---|---|---|
| code | string | When query parameter "code=DIN 1045" is defined, the API will return from requested catalog only items which are related to code/norm DIN 1045. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045 To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045&country=Germany |
|
| norm | string | When query parameter "norm=DIN 1045" is defined, the API will return from requested catalog only items which are related to code/norm DIN 1045. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?norm=DIN 1045 To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045&country=Germany |
|
| na | string | When query parameter "na=Germany" is defined, the API will return from requested catalog only items which are related to country Germany. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?na=Germany To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045&na=Germany |
|
| country | string | When query parameter "country=Germany" is defined, the API will return from requested catalog only items which are related to country Germany. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?country=Germany To get more precisely specified result set of catalog items, can be combined query parameter for 'norm' or 'code' together with 'country' or 'na' query parameter. e.g. https://api-stage.bimplus.net/v2/catalogs/10e3f185-234e-9686-5fea-73075149abd2/items?code=DIN 1045&country=Germany |
|
| filter | string | When filter "name=S 998" is defined the API will return only catalog items which Name contains requested sub-string, e.g. https://api-stage.bimplus.net/v2/catalogs/2d116846-5f7c-a780-3a82-6dd8150989df/items?filter=name=S 998 To get more precisely specified result set of catalog items, can be combined query parameter filter (by name) together with 'country' or 'code' query parameter. e.g. https://api-stage.bimplus.net/v2/catalogs/2d116846-5f7c-a780-3a82-6dd8150989df/items?filter=name=S 998&code=DIN 1045&country=Germany |
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)"
}
]
