Versions Compared

Old Version 18

changes.mady.by.user Noema Bradnanska

Saved on

compared with

New Version 19

changes.mady.by.user Ivan Pavlovcik

Saved on

Key

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

...

Deck of Cards
idbimGetCatalogItemList


Card
defaulttrue
labelURL / Resource / JSON Structure

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

codestring 

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.
Instead of code name can be used also codeId 6de06146-125f-c7eb-95cc-0c07d85c4d94. Query parameter 'code' can be interchanged with query parameter norm.
When are defined both query parameters - code and norm, only code is used in api call.

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

normstring

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.
Instead of code name can be used also normId 6de06146-125f-c7eb-95cc-0c07d85c4d94. Query parameter 'norm' can be interchanged with query parameter code.
When are defined both query parameters - code and norm, only code is used in api call.

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

nastring

When query parameter "na=Germany" is defined, the API will return from requested catalog only items which are related to country Germany.
Instead of country name can be used also country Id 2909b0d8-c6de-425d-2303-256336ada04f. Query parameter 'na' can be interchanged with query parameter 'country'.
When are defined both query parameters - 'na' and 'country', only 'na' parameter is used in api call.

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

countrystring

When query parameter "country=Germany" is defined, the API will return from requested catalog only items which are related to country Germany.
Instead of country name can be used also country Id 2909b0d8-c6de-425d-2303-256336ada04f. Query parameter 'country' can be interchanged with query parameter 'na'.
When are defined both query parameters - 'na' and 'country', only 'na' parameter is used in api call.

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

filterstring 

When filter "name=S 998" is defined the API will return only catalog items which Name contains requested sub-string,
e.g. if filter is "name=S 998" will be returned all catalog items which Name contains substring "S 998".

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




Card
labelHTTP Method
 GET


Card
labelDescription
 Get all catalog items of the catalog


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
[{
    "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)"
  }
]



...