-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiary.apib
335 lines (275 loc) · 11.8 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
FORMAT: 1A
HOST: https://www.uponor.de/
# Uponor PRO App - API
Folalowing API is designated to be used with UPONOR PRO APP.
## News [/api/UponorInternet/Newslist/{?language,count}]
### Newslist [GET]
+ Parameters
+ language: `de-de` (string, required) - Language code in which should the news be displayed
+ count (number, optional) - Ammount of items in news
+ Response 200 (application/json)
{
status: "1",
message: "News Get Successfully",
news: [
{
id: "{FBC4267C-DE68-4874-8AF6-57F551834718}",
title: "Zweimal auf dem Treppchen ",
description: "Bei einer Leserwahl des Fachportals haustec.de hat Uponor zwei hervorragende zweite Plätze erreicht: einmal mit der Einzelraumregelung Smatrix Pulse und einmal mit dem Online-Konfigurator für Verteilerstationen von Heiz- und Kühlsystemen. ",
mediaType: "image",
createDate: "2021-04-08",
mediaFile: "https://www.uponor.de/-/media/country-specific/dach-benelux/news/newsarticle/haustec-leserwahl/haustec-leserwahl-510x320.jpg?h=300&w=400&usecustomfunctions=1¢ercrop=1&hash=235C6C1513E44BCDA18A2D2A2E96EFF67A019E92",
mediaFileThumb: "https://www.uponor.de/-/media/country-specific/dach-benelux/news/newsarticle/haustec-leserwahl/haustec-leserwahl-510x320.jpg?h=100&w=100&usecustomfunctions=1¢ercrop=1&hash=73CDF9EC64556499B01BBFA8FE40B99ECE542579",
url: "https://www.uponor.de/unternehmen/news/newsartikel/2021-04-haustec-leserwahl",
},
],
}
+ Attributes
+ status (string) - Status number (1 = success | 0 = ??)
+ message (string) - Status message
+ news (array [News item]) - list of news items
## Sales Locator [/api/UponorInternet/SalesLocator/{?plz,type}]
+ Parameters
+ plz (number) - ??
+ type (number, optional) - ??
### Get some [GET]
+ Response 200 (application/json)
{
ItemName: "Sales Locator List"
Values: [
{
Company: "Uponor GmbH",
IdNo: "67",
Person: "Sven Argo",
Street: "",
PoBox: "",
Zipcode: "16761",
City: "Hennigsdorf",
Region: "",
Country: "Deutschland",
Phone: "03302 201809",
Mobile: "0172 4077723",
Fax: "09521 690 99232",
Email: "[email protected]",
Web: "www.uponor.de",
Image: "/-/media/uponor-internet/professional-images/argo-sven.jpg",
MembershipStartColumn: "",
RoleId: "de-DE",
Plz: "1"
},
]
}
+ Attributes
+ ItemName (string) - Item name
+ Values (array [Sales locator item]) - list of news items
## Contacts [/api/UponorInternet/Contact{?language,type}]
+ Parameters
+ language: `de-de` (string, required) - Language code in which should the contacts be displayed
+ type (enum[string], optional) - Contact type filter
+ Members
+ `academy`
+ `uponorandmore`
+ `customerservice`
+ `technicalhotline`
### Get some [GET]
+ Response 200 (application/json)
{
Name: "Contact Service",
IsoCode: "de-DE",
Values: [
{
ContactType: "academy",
ContactName: "Academy",
ContactPhone: "+ 49 800 7780050 ",
ContactFax: "",
ContactMobile: "",
ContactMailLink: {
LinkDescription: "[email protected]",
Mailto: "[email protected]",
ContactMailSubject: "Uponor Academy"
}
}
],
}
+ Attributes
+ Name (string) - Name
+ IsoCode (string) - Item iso code
+ Values (array [Contact item]) - List of contact service items
## Locators/Profesionals [/api/UponorInternet/Map/professionals{?type,language,updateDate}]
+ Parameters
+ language: `de-de` (string, required) - Language code in which should the content be displayed
+ type: `Dealer` (enum[string], required) - Profesional type filter
+ Members
+ `Dealer`
+ `Sales`
+ `Installer`
### Get some [GET]
+ Response 200 (application/json)
{
ItemName: "Germany Wholesaler",
ItemCountry: "de-DE",
Profesionals: [
{
Name: "Neugart KG - Fachgroßhandel für Haustechnik",
StreetAddress: "Max-Planck-Straße 2",
ZipCode: "53773",
Municipality: "",
City: "Hennef",
Country: "",
Telephone: "+49 (0)2242-9050-0",
Mobile: "",
Fax: "",
Email: "",
WebAddress: "http://www.neugart-kg.de",
TypeName: "Großhändler",
TypeIcon: "wholesaler",
Specialities: [ ],
AdditionalInformation: '<img style="width:25px" src="https://www.uponor.de/images/Website/merchanicTypes/heat.png"/> Heizen/Kühlen<br/><img style="width:25px" src="https://www.uponor.de/images/Website/merchanicTypes/sani.png"/> Installation<br/><img style="width:25px" src="https://www.uponor.de/images/Website/merchanicTypes/supply.png"/> Versorgung',
Latitude: "50.7664873",
Longitude: "7.3171985"
},
],
}
+ Attributes
+ ItemName (string) - Name
+ ItemCountry (string) - Item country
+ Professionals (array [Profesionals locator item]) - List of professionals
## Downloadcenter [/api/UponorInternet/CatalogueDownloadList{?language,section,doc}]
+ Parameters
+ language: `de-de` (string, required) - Language code in which should the content be displayed
+ section: `BLD` (enum[string], optional) - Section type filter
+ Members
+ `BLD`
+ `Infra`
+ doc: `E9E99F72DDE3483C862B50A5A37A3BB4` (string, optional) - Document type filter
### Get some [GET]
+ Response 200 (application/json)
{
ItemName: "DownloadCenter",
IsoCode: "de-DE",
Profesionals: [
{
BrochureID: "1089122",
Date: "12.03.2017",
Description: "Produktbroschüre",
DocumentType: "Produktbroschüren ",
DownloadLink: "https://www.uponor.de/-/media/country-specific/dach-benelux/downloadcenter-archiv/01-salesfolder-archiv/uponor-sf-fluvia-t-push-12-de-1089122-201703.pdf?v=b704c33d-e210-4027-a948-db59cd6154ec",
FileType: "pdf",
FileTypeIcon: "https://www.uponor.de/UponorInternet/Images/Mimetypes/pdf.png",
ItemID: "{8B77D29D-A19B-4154-A9F4-B40DB895E68D}",
NewIcon: "",
Size: "1.12MB",
Thumbnail: "https://www.uponor.de/-/media/uponor-internet/thumbnails/pdfs/8/8b77d29da19b4154a9f4b40db895e68d.jpg?h=360&w=250&usecustomfunctions=1¢ercrop=1&hash=7B2718BE9ED854680F4BE604085983D83EC824AC",
Title: "Uponor Fluvia T Push-12 Kleinstpumpengruppen "
},
],
}
+ Attributes
+ Name (string) - Name
+ IsoCode (string) - Item iso code
+ Values (array [DLC Item]) - List of DLC items
## Faq List [/api/UponorInternet/faq/list{?language}]
+ Parameters
+ language: `de-de` (string, optional) - Language code in which should the content be displayed
### Get all [GET]
+ Response 200 (application/json)
{
title: " "
Faqs: [
{
ID: "{74C75D1E-450A-4C89-AB49-0D1381F8EA68}",
Question: "<strong>Sind S-Press PLUS Komponenten kompatibel mit dem bestehenden Uponor Verbundrohrsystem?</strong>",
Answer: "Alle S-Press PLUS Komponenten sind vollständig kompatibel mit dem Uponor Verbundrohrsystem. Es werden auch keine anderen Werkzeuge benötigt."
}
]
}
+ Attributes
+ Title (string) - Title
+ Faqs (array[object])
+ ID (string) - Item ID
+ Question (string) - FAQ Question
+ Answer (string) - FAQ Answer
## Product online catalogue [/api/UponorInternet/poc{?language}]
+ Parameters
+ language: `de-de` (string, optional) - Language code in which should the content be displayed
### Get JSON [GET]
+ Response 200 (application/json)
{
Name: "Product online Catalogue",
IsoCode: "de-DE",
LastUpdated: "2021-02-16",
DownloadLink: "https://www.uponor.de/-/media/uponor-internet/poc/dedepocjson.json",
}
+ Attributes
+ Name (string) - Name
+ IsoCode (string) - Item iso code
+ LastUpdated (string) - Date of last updateDate
+ DownloadLink (string) - Absolute URL to download products JSON
# Data Structures
## News item (object)
+ id (string) - Item unique id
+ title (string) - Item title
+ description (string) - item perex (short description)
+ mediaType (string) - mediaFile type
+ mediaFile (string) - URL to media file
+ mediaFileThumb (string) - URL to media file type
+ url (string) - Item URL
## Sales locator item (object)
+ Company (string) - Company ItemName
+ IdNo (string) - ID NO
+ Person (string) - Person name
+ Street (string) - Street name
+ PoBox (string) - Po Box
+ Zipcode (string) - Zipcode
+ City (string) - City name
+ Region (string) - Region name
+ Country (string) - Country name
+ Phone (string) - Phone number
+ Mobile (string) - Mobile number
+ Fax (string) - Fax number
+ Email (string) - Email address
+ Web (string) - Website address
+ Image (string) - Image URL (relative)
+ MemberShipStartColumn (string) - ???
+ RoleID (string) - ????
+ Plz (string) - ????
## Contact item (object)
+ ContactType (string) - Contact type
+ ContactName (string) - Contact name
+ ContactPhone (string) - Contact Phone
+ ContactFax (string) - Contact Fax
+ ContactMobile (string) - Contact mobile
+ ContactMailLink (object) - Contact Mail ContactMailLink
+ LinkDescription (string) - Link description
+ Mailto (string) - Mailto email address
+ ContactMailSubject (string) - Contact email subject
## Profesionals locator item (object)
+ Name (string) - Name
+ StreetAddress (string) - Street address
+ Zipcode (string) - Zipcode
+ Municipality (string) - Municipality
+ City (string) - City name
+ Country (string) - Country name
+ Telephone (string) - Telephone number
+ Mobile (string) - Mobile number
+ Fax (string) - Fax number
+ WebAddress (string) - Website address
+ TypeName (string) - Type name
+ TypeIcon (string) - Type icon
+ Specialities (array) - Specialitites
+ AdditionalInformation (string) - AdditionalInformation
+ Latitude (string) - Item latitude
+ Longitude (string) - Item longitude
## DLC Item (object)
+ BrochureID (string) - Brochure ID
+ Date (string) - Date
+ Description (string) - Description
+ DocumentType (string) - Document type
+ DownloadLink (string) - Absolute URL to download file
+ FileType (string) - File type (extension)
+ FileTypeIcon (string) - Absolute URL to FileType icon
+ ItemID (string) - Item ID
+ NewIcon (string) - New Icon
+ Size (string) - File size
+ Thumbnail (string) - Absolute URL to file thumbnail
+ Title (string) - File Title