UOL Data Service
BIMReady
Sets the BIM Ready information for products.
Sets the BIM ready status of the specified product Ids.
Request
POST /api/v{version}/BIMReadyParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| bimReadyInformation | The BIM ready information to set. |
||
| *version | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 400 | Bad Request |
|
| 404 | Not Found |
|
| 500 | Server Error |
Data
Gets the UOL information to use for authenticating and searching on the data source.
Gets the UOL information to use for authenticating and searching on the data source.
The information consists of URLs to use and credentials to connect to the UOL platform.
Request
GET /api/v{version}/DataParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *version | string | The information consists of URLs to use and credentials to connect to the UOL platform. |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 400 | Bad Request |
|
| 404 | Not Found |
|
| 500 | Server Error |
ProductData
Gets the product for the specified criteria.
Gets the product for the specified manufacturerGLN and productCode.
Request
GET /api/v{version}/ProductData/{ManufacturerGLN}/{ProductCode}[?languageCode]Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *manufacturerGLN | string | The manufacturer GLN. |
|
| *productCode | string | The product code. |
|
| languageCode | string | A language code (e.g. 'EN' or 'NL') for the language of the CAD product. |
|
| *version | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 400 | Bad Request |
|
| 404 | Not Found |
|
| 500 | Server Error |
Gets the products for the specified criteria.
Gets the products for the specified manufacturerGLNandProductCodes.
Request
POST /api/v{version}/ProductData[?languageCode]Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| manufacturerGLNandProductCodes | >A list of manufacturer GLNs and product codes. |
||
| languageCode | string | A language code (e.g. 'EN' or 'NL') for the language of the CAD product. |
|
| *version | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 400 | Bad Request |
|
| 404 | Not Found |
|
| 500 | Server Error |
ProductDataGTIN
Gets the product for the specified criteria.
Gets the product for the specified gtin/>.
Request
GET /api/v{version}/ProductDataGTIN/{gtin}[?languageCode]Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *gtin | string | The GTIN. |
|
| languageCode | string | A language code (e.g. 'EN' or 'NL') for the language of the CAD product. |
|
| *version | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 400 | Bad Request |
|
| 404 | Not Found |
|
| 500 | Server Error |
ProductValues
Sets the filter for editing.
Gets the product values of the specified product Ids.
Request
POST /api/v{version}/ProductValuesParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| productIds | The product Ids to get the values for. |
||
| *version | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 400 | Bad Request |
|
| 404 | Not Found |
|
| 500 | Server Error |
Products
Gets the product information for the specified filter.
Gets the product information for the specified filter.
Request
GET /api/v{version}/Products/{filterId}/{type}/{disableFields}Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *filterId | string | The id of the filter to use. |
|
| *type | string | The type of selection that is made. Possible values are {'productselection'} or {'interface'}. |
|
| *disableFields | string | The product fields properties that will have selected set to "false" |
|
| *version | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 400 | Bad Request |
|
| 404 | Not Found |
|
| 500 | Server Error |
Sets the filter for editing.
Sets the filter for editing based on the first product from the UOL.Models.CADFilterResult .
Request
POST /api/v{version}/Products[?beautifyErrors]Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| cadFilterResult | The filter to set. |
||
| beautifyErrors | string | A value indicating whether to send back detailed error description, or only throw errors. 1 = detailed error description, 0 = throw errors. |
|
| *version | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 400 | Bad Request |
|
| 404 | Not Found |
|
| 500 | Server Error |
Structures
Gets the structure for a specific EC/MC combination.
Gets the structure of a specific ETIM class code/ETIM modeling class code combination for validation purposes.
Request
GET /api/v{version}/Structures/{etimClassCode}/{etimModelClassCode}[?languageCode]Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *etimClassCode | string | The ETIM class code to use. |
|
| *etimModelClassCode | string | The ETIM modeling class code to use. |
|
| languageCode | string | The language (e.g. {'en'} or {'nl'} for the ETIM structure. |
|
| *version | string |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Success |
|
| 400 | Bad Request |
|
| 404 | Not Found |
|
| 500 | Server Error |