Data schema
Product
The product consist of the folloing objects.
Scheme
The ProductDeliveryTime provides delivery time information about a given number The number could ba a IamNumber or a OemNumber.
Details
Product
The Product includes all product information wich are available.
| Property | Type | Description |
|---|---|---|
Id |
string |
The unique id of the product . |
BnrShortText |
MultiLocaleText array |
A array of MultiLocaleText objects that provides the brn short text for multiple languages. |
MaterialShortText |
MultiLocaleText array |
A array of MultiLocaleText objects that provides the material short text for multiple languages. |
IamNumber |
string |
The unique IAM number of the product. |
Image |
(optional) DownloadableFileResource |
The image could be a base64 string or a downloadable file. It could be null. |
Properties |
Property array |
A array of Property objects that provide a list of properties. |
Resources |
FileResource array |
A array of FileResource objects that provides multiple files that depends to the product like product documentation, repair manual etc. |
SparePartInformation |
(optional) SparePartInformation |
The SparePartInformation object which contains the spare parts. It could be null. |
ShortDescription |
MultiLocaleText array |
A array of MultiLocaleText objects that provides the short description text for multiple languages. |
Description |
MultiLocaleText array |
A array of MultiLocaleText objects that provides the description text for multiple languages. |
Features |
MultiLocaleTextArray array |
A array of MultiLocaleTextArray objects that provides the a list of features as text for multiple languages. |
SparePartInformation
The SparePartInformation object which contains the spare parts and the installation drawing.
| Property | Type | Description |
|---|---|---|
SpareParts |
SparePart array |
A array of SparePart objects that provides the spare parts. |
InstallationDrawing |
(optional) DownloadableFileResource |
The installation drawing for the spare parts. It could be null. |
MultiLocaleText
The MultiLocaleText object defines for a language a special text.
| Property | Type | Description |
|---|---|---|
Language |
string |
The language description like DE, EN etc. Must be a valid locale string based on Microsoft CultureInfo. |
Text |
string |
The text in the expected language. |
MultiLocaleTextArray
The MultiLocaleTextArray object defines for a language a special list of texts.
| Property | Type | Description |
|---|---|---|
Language |
string |
The language description like DE, EN etc. Must be a valid locale string based on Microsoft CultureInfo. |
Texts |
string array |
The lists of texts in the expected language. |
Property
A property has a name and a value
| Property | Type | Description |
|---|---|---|
Name |
string |
The name of the property. |
Value |
The value object. |
ValueBase
A ValueTypeBase is a abstract object and could be a:
To identify the type there is a property named kind.
| Property | Kind |
|---|---|
number |
|
text |
|
physical |
|
bool |
FileResource
The FileResource ia a object that defines a resource type and multiple language-dependent resources can be attached for this type
| Property | Type | Description |
|---|---|---|
ResourceType |
string |
The ResourceType is a string. The possible string should be listed. |
LocalizedResources |
MultiLocaleResource array |
A array of MultiLocaleResource objects that provides a resource for multiple languages. |
MultiLocaleResource
The MultiLocaleResource object defines a special file of a given language.
| Property | Type | Description |
|---|---|---|
Language |
string |
The language description like DE, EN etc. Must be a valid locale string based on Microsoft CultureInfo. |
FileResource |
The file resource. |
|
Title |
string |
The title of the resource. |
DownloadableFileResource
The DownloadableFileResource is contains a resource id for download.
| Property | Type | Description |
|---|---|---|
MimeType |
string |
The mime type |
FileName |
(optional) It could be null.string |
The file name. It could be null. |
ResourceId |
Guid |
The resource id. |
SparePart
The SparePart object defines a spare part of the product. A spare part is also a product. With the spare part id you can get the product information of the pare part product.
| Property | Type | Description |
|---|---|---|
BnrShortText |
MultiLocaleText array |
A array of BnrShortText objects that provides the brn short text for multiple. |
MaterialShortText |
MultiLocaleText array |
A array of MultiLocaleText objects that provides the material short text for multiple. |
Pos |
int |
The position number. |
Amount |
int |
The amount of the spare part. |
IamNumber |
string |
The unique IAM number ot the product. |
SparePartInformation |
(optional) SparePartInformation |
The SparePartInformation object which contains the spare parts. It could be null. |
ProductDeliveryTime
The ProductDeliveryTime object contains a delivery time information about a given number.
| Property | Type | Description |
|---|---|---|
MaxQuantity |
double? |
Maximum order quantity |
Current |
int? |
Current standard delivery time in working days. |
Fallback |
int? |
Fallback delivery time if order quantity → maxQuantity |
MaxLength |
double? |
The maximum length |
Region |
string? |
Region |
Resource
The resource provides the resource content of a product resource. With the resource id you can download the expected resource as a byte array that represent a file.
Metric
The metric provides functionality to add some metric information to the service.
Details
The Metric object contains a specific metric that is assosiatetd to a IAM Number.
| Property | Type | Description |
|---|---|---|
Data |
The assosiatetd metric. |
|
IamNumber |
string |
The unique IAM number of the product. |
MetricTypeBase
The MetricTypeBase is a abstract object and could be a:
-
PurchaseIntentionMetric PurchaseIntentionMetric
To identify the type there is a property named kind.
| Property | Kind |
|---|---|
purchaseIntention |
PurchaseIntentionMetric
The PurchaseIntentionMetric object contains information about a purchase intention of a customer.
| Property | Type | Description |
|---|---|---|
CustomerInformation |
The customer information that has a purchase intention. |
|
IamNumber |
string |
The unique IAM number of the product. |
CustomerInformation
The CustomerInformation object contains information about the customer who has a purchase intention.
| Property | Type | Description |
|---|---|---|
Identifier |
string |
A anonymized identifier. |
Origin |
string |
The origin e.g. the country of the customer. |
Language |
string |
The language of the customer. |
Health
The health provides functionality to get information about the health status of our service.
Details
HealtReportSummary
The object contains information about the status of the service.
| Property | Type | Description |
|---|---|---|
Status |
The health status of the service. |
|
TotalDuration |
TimeSpan |
The total duration of all health ckecks. |
Results |
HealthCheckEntity array |
A array of HealthCheckEntity objects. |
HealthStatus
The HealthStatus is a enum and could be a:
| Value | Description |
|---|---|
Unhealthy |
Indicates that the health check determined that the component was unhealthy, or an unhandled exception was thrown while executing the health check. |
Degraded |
Indicates that the health check determined that the component was in a degraded state. |
Healthy |
Indicates that the health check determined that the component was healthy. |
HealthCheckEntity
The HealthCheckEntity object contains information about a system health check.
| Property | Type | Description |
|---|---|---|
Name |
string |
The name of the health check. |
Status |
The health status of the ckecked system. |
|
Description |
string |
Description of the system. |
Duration |
TimeSpan |
The duration of the system health check. |