API-Dokumentation

Resources

Addresses-endpoint

Addresses Endpoint

Creates a deviating address

POST /createXXAddress

Parameters

Type	Name	Description	Schema
Body	addressData required	addressData	XXAddress

Responses

HTTP Code	Description	Schema
200	OK	XXAddress
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Determine default address

GET /getAddresses

Responses

HTTP Code	Description	Schema
200	OK	object
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

All-orders-endpoint

All Orders Endpoint

Determines all orders of the logged in customer

GET /allOrders

Parameters

Type	Name	Description	Schema
Query	fromDate optional	fromDate	string
Query	numberOfRows optional	numberOfRows	integer (int32)
Query	orderNumber optional	orderNumber	string
Query	searchString optional	searchString	string
Query	sort optional	sort	string
Query	sortField optional	sortField	string
Query	status optional	status	string
Query	toDate optional	toDate	string
Query	transaction optional	transaction	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Determines all orders with postions of the logged in customer

GET /orders-with-pos

Parameters

Type	Name	Description	Schema
Query	fromDate optional	fromDate	string
Query	isNextList optional	isNextList	boolean
Query	numberOfRows optional	numberOfRows	integer (int32)
Query	orderNumber optional	orderNumber	string
Query	searchString optional	searchString	string
Query	sort optional	sort	string
Query	sortField optional	sortField	string
Query	status optional	status	string
Query	toDate optional	toDate	string

Responses

HTTP Code	Description	Schema
200	OK	OrderWithPosListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Article-info-endpoint

Article Info Endpoint

get some details for a certain item

GET /articleInfo

Parameters

Type	Name	Description	Schema
Query	article optional	article	string

Responses

HTTP Code	Description	Schema
200	OK	object
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Articles-endpoint

Articles Endpoint

calls the item search and returns a list of matching items

GET /articles

Parameters

Type	Name	Description	Schema
Query	numberOfRows optional	numberOfRows	integer (int32)
Query	searchString optional	searchString	string
Query	transaction optional	transaction	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Availability-endpoint

Availability Endpoint

Checks the availability for a certain item with a certain quantity

GET /availability

Parameters

Type	Name	Description	Schema
Query	article optional	article	string
Query	quantity optional	quantity	string

Responses

HTTP Code	Description	Schema
200	OK	< string, string > map
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Change-password-endpoint

Change Password Endpoint

creates a new token and send it per e-Mail to the user for a following reset

POST /createNewToken

Parameters

Type	Name	Description	Schema
Query	mailAddress required	mailAddress	string
Query	scope optional	the scope of the portal e.g. Medical, Supplier, ...	string

Responses

HTTP Code	Description	Schema
200	OK	boolean
201	Created	No Content
400	bad request because of invalid client usage against current server state	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content
500	critical Backend-Errors	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

checks whether the user is still using the initial password given by the administrator

POST /isInitialPassword

Responses

HTTP Code	Description	Schema
200	OK	boolean
201	Created	No Content
400	bad request because of invalid client usage against current server state	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content
500	critical backend-Errors	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

resets a forgotten password to a new one

POST /resetPassword

Parameters

Type	Name	Description	Schema
Body	resetPWDTO required	resetPWDTO	ResetPWDTO

Responses

HTTP Code	Description	Schema
200	OK	< string, string > map
201	Created	No Content
400	bad request because of invalid client usage against current server state	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content
500	critical backend-Errors	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

changes the password if the user still knows the old one

POST /setNewPassword

Parameters

Type	Name	Description	Schema
Body	changePWDTO required	changePWDTO	ChangePWDTO

Responses

HTTP Code	Description	Schema
200	OK	< string, string > map
201	Created	No Content
400	bad request because of invalid client usage against current server state	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content
500	critical backend-Errors	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Contact-message-endpoint

Contact Message Endpoint

Send a message via e-Mail by a contact form

POST /contactMessage

Parameters

Type	Name	Description	Schema
Query	email required	email	string
Query	firstname required	firstname	string
Query	lastname required	lastname	string
Query	message required	message	string
Query	ordernumber optional	ordernumber	string
Query	phone required	phone	string
Query	salutation required	salutation	string
Query	subject required	subject	string

Responses

HTTP Code	Description	Schema
200	OK	string
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Delivery-endpoint

Delivery Endpoint

Returns a list of all or a certain deliveries/delivery for the customer

GET /allDeliveries

Parameters

Type	Name	Description	Schema
Query	deliveryNumber optional	deliveryNumber	string
Query	fromDate optional	fromDate	string
Query	numberOfRows optional	numberOfRows	integer (int32)
Query	toDate optional	toDate	string
Query	transaction optional	transaction	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Delivery-positions-endpoint

Delivery Positions Endpoint

Display of all positions for a delivery bill

GET /openDeliveryPositions

Parameters

Type	Name	Description	Schema
Query	deliveryNumber optional	deliveryNumber	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Delivery-tracking-endpoint

Delivery Tracking Endpoint

Display of all tracking numbers for a delivery bill

GET /deliveryTracking

Parameters

Type	Name	Description	Schema
Query	deliveryNumber optional	deliveryNumber	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Device-controller

Device Controller

Load device detail for one device, which is assigned to the requesting user

GET /device

Parameters

Type	Name	Description	Schema
Query	articleNr required	articleNr	string
Query	serialNr required	serialNr	string
Query	supplierBranchNr optional	supplierBranchNr	string
Query	supplierNr optional	supplierNr	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	No device found	No Content

Produces

```
\*/*
```

Load ticket history for a device, which is assigned to the requesting user

GET /device/ticket-history

Parameters

Type	Name	Description	Schema
Query	articleNr required	articleNr	string
Query	serialNr required	serialNr	string
Query	supplierBranchNr optional	supplierBranchNr	string
Query	supplierNr optional	supplierNr	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Load devices, which are assigned to the requesting user

GET /devices

Parameters

Type	Name	Description	Schema
Query	articleTagIds optional	articleTagIds	string
Query	search optional	search	string
Query	serialNrStates optional	serialNrStates	< string > array(multi)

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Document-controller

Document Controller

Download the available document, which is assigned to the requesting user

GET /document/download

Parameters

Type	Name	Description	Schema
Query	obid required	obid	string

Responses

HTTP Code	Description	Schema
200	OK	DownloadFile
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Load all available documents, which is assigned to the requesting user

GET /documents

Parameters

Type	Name	Description	Schema
Query	documentType optional	just load documents for document type	< string > array(multi)
Query	fromDate optional	just load documents last updated after given date	string (date)
Query	search optional	free search	string
Query	toDate optional	just load documents last updated before given date	string (date)

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Load available documents for a device, which is assigned to the requesting user

GET /documents/device

Parameters

Type	Name	Description	Schema
Query	articleNr required	articleNr	string
Query	serialNr required	serialNr	string
Query	supplierBranchNr optional	supplierBranchNr	string
Query	supplierNr optional	supplierNr	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Load available documents for an item

GET /documents/item

Parameters

Type	Name	Description	Schema
Query	articleNr required	articleNr	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Load available documents for a order, which is assigned to the requesting user

GET /documents/order

Parameters

Type	Name	Description	Schema
Query	orderNr required	orderNr	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Generic-endpoint

Generic Endpoint

performGenericCall

POST /performGenericCall

Parameters

Type	Name	Description	Schema
Query	method required	method	string
Body	parameters required	parameters	string

Responses

HTTP Code	Description	Schema
200	OK	BackendTable«Data»
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/xml
```

Produces

```
application/json
```

Get-address-and-bank-data-endpoint

Get Address And Bank Data Endpoint

Provides address, billing address and bank details of a user

POST /addressAndBankData

Responses

HTTP Code	Description	Schema
200	OK	< string, string > map
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Get-countries

Get Countries

Returns a list of existing country numbers and country names

POST /getCountries

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Get-delivery-addresses

Get Delivery Addresses

Delivers the delivery addresses used in the customer's orders for the last twelve months

POST /deliveryAddresses

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Get-personal-accounts-open-items

Get Personal Accounts Open Items

Delivers the open invoices / open items of a user

POST /getPersonalAccountsOpenItems

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Invoice-endpoint

Invoice Endpoint

Display of all invoices of the customer with search options

GET /allInvoices

Parameters

Type	Name	Description	Schema
Query	Status optional	Status	string
Query	fromDate optional	fromDate	string
Query	invoiceNumber optional	invoiceNumber	string
Query	toDate optional	toDate	string
Query	transaction optional	transaction	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Invoice-positions-endpoint

Invoice Positions Endpoint

Display of all positions for an invoice

GET /openInvoicePositions

Parameters

Type	Name	Description	Schema
Query	entryClassification optional	entryClassification	string
Query	invoiceNumber optional	invoiceNumber	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Language-endpoint

Language Endpoint

change language, which is supported for portal connect oo2021 (version 1.2)

PUT /language

Parameters

Type	Name	Description	Schema
Query	language required	language	string

Responses

HTTP Code	Description	Schema
200	returns the changed language / language is already changed	Language
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content
406	language is not available for portal connect (TBV SPR)	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

change language

GET /setLanguage

This operation is deprecated.

Parameters

Type	Name	Description	Schema
Query	language required	language	string

Responses

HTTP Code	Description	Schema
200	OK	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Open-entities-endpoint

Open Entities Endpoint

Determine for a customer the number of articles, the number of orders, the number of delivery bills, the number of invoices and the number of different articles in the catalog

GET /entities

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Open-order-positions-endpoint

Open Order Positions Endpoint

Display of all order items for a sales order (of the logged in customer)

GET /openOrderPositions

Parameters

Type	Name	Description	Schema
Query	orderNumber optional	orderNumber	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Open-orders-endpoint

Open Orders Endpoint

Display of open sales orders of the logged in customer

GET /openOrders

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Order-endpoint

Order Endpoint

Adds positions to a sales order. If no sales order exists yet, it will be created with the first position

POST /addOrderPosition

Parameters

Type	Name	Description	Schema
Query	deliveryDate required	deliveryDate	string
Query	item required	item	string
Query	quantity required	quantity	number (double)

Responses

HTTP Code	Description	Schema
200	OK	Order
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Posts the sale order

POST /book

Responses

HTTP Code	Description	Schema
200	OK	string
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Cancels the sales order

POST /cancelOrder

Responses

HTTP Code	Description	Schema
200	OK	string
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Deletes an item of the sales order

DELETE /deleteOrderPosition

Parameters

Type	Name	Description	Schema
Query	positionNr optional	positionNr	integer (int32)

Responses

HTTP Code	Description	Schema
200	OK	string
204	No Content	No Content
401	Unauthorized	No Content
403	Forbidden	No Content

Produces

```
\*/*
```

Loads sale orders

GET /getOrder

Responses

HTTP Code	Description	Schema
200	OK	Order
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Loads the default billing address

GET /loadBillingAddress

Responses

HTTP Code	Description	Schema
200	OK	Address
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Loads the default delivery address

GET /loadDeliveryAddress

Responses

HTTP Code	Description	Schema
200	OK	Address
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Save billing address, an existing billing address can optionally be overwritten

POST /storeBillingAddress

Parameters

Type	Name	Description	Schema
Query	countryNumber optional	countryNumber	string
Query	name1 optional	name1	string
Query	name2 optional	name2	string
Query	name3 optional	name3	string
Query	name4 optional	name4	string
Query	place optional	place	string
Query	plz optional	plz	string
Query	street optional	street	string

Responses

HTTP Code	Description	Schema
200	OK	Address
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Save delivery address, an existing delivery address can optionally be overwritten

POST /storeDeliveryAddress

Parameters

Type	Name	Description	Schema
Query	countryNumber optional	countryNumber	string
Query	name1 optional	name1	string
Query	name2 optional	name2	string
Query	name3 optional	name3	string
Query	name4 optional	name4	string
Query	place optional	place	string
Query	plz optional	plz	string
Query	street optional	street	string

Responses

HTTP Code	Description	Schema
200	OK	Address
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Saves the order header. Optionally, a customer order number, customer order details, and delivery details can be specified

POST /storeHeader

Parameters

Type	Name	Description	Schema
Query	completeOrder optional	completeOrder	boolean
Query	contactDetails optional	contactDetails	string
Query	customerOrderEntries optional	customerOrderEntries	string
Query	customerOrderNumber optional	customerOrderNumber	string
Query	deliveryDetails1 optional	deliveryDetails1	string
Query	deliveryDetails2 optional	deliveryDetails2	string
Query	eMail optional	eMail	string
Query	shippingMethod optional	shippingMethod	string

Responses

HTTP Code	Description	Schema
200	OK	OrderHeader
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Order-status

Order Status

Load available VKS order status values from FRD 406. (with order status lower 24)

GET /orderStatus

This operation is deprecated.

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Price-determination-endpoint

Price Determination Endpoint

Performs a price determination for an item

GET /priceDetermination

Parameters

Type	Name	Description	Schema
Query	article optional	article	string
Query	quantity optional	quantity	string

Responses

HTTP Code	Description	Schema
200	OK	< string, string > map
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Product-catalog-endpoint

Product Catalog Endpoint

Display of all articles in the catalog stored in the customer's internet profile

GET /articlesCatalog

Parameters

Type	Name	Description	Schema
Query	numberOfRows optional	numberOfRows	integer (int32)
Query	searchString optional	searchString	string
Query	transaction optional	transaction	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Display of all articles of a catalog (oBS)

GET /catalogArticles

Parameters

Type	Name	Description	Schema
Query	catalog optional	catalog	string
Query	specification optional	specification	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Display of the catalog structure (oBS)

GET /catalogStructure

Responses

HTTP Code	Description	Schema
200	OK	string
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Registration-endpoint

Registration Endpoint

Accepts a user's registration request and sends confirmation emails

POST /registrateUser

Parameters

Type	Name	Description	Schema
Body	registrationInfo required	registrationInfo	RegistrationInfo

Responses

HTTP Code	Description	Schema
200	OK	ResponseEntity
201	Created	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content
409	Empty required field	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Tbv-controller

Tbv Controller

Load available article tags/categories from FRD PCO

GET /article-tags

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Load available damage pattern from FRD SBI

GET /damage-pattern

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Load available document types from FRD DKT

GET /document-types

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Load available help desk states from FRD AHD

GET /helpdesk-states

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Load available help desk operation types from FRD AHP

GET /operation-types

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Load available VKS order status values from FRD 406. Optional filter for max order status.

GET /order-status

Parameters

Type	Name	Description	Schema
Query	maxOrderStatus optional	maxOrderStatus	integer (int32)

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content
406	Only two-digit allowed for max order status	No Content

Produces

```
\*/*
```

Load available salutations from FRD 267

GET /salutations

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Load available serial number states from FRD SSN

GET /serial-number-states

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Ticket-controller

Ticket Controller

Create a new ticket

POST /ticket

Parameters

Type	Name	Description	Schema
Query	articleNr required	articleNr	string
Query	contactPerson optional	contactPerson	string
Query	damagePattern optional	damagePattern	string
Query	helpDeskOperationType optional	helpDeskOperationType	string
Query	salutation optional	salutation	string
Query	serialNr required	serialNr	string
Query	supplierBranchNr optional	supplierBranchNr	string
Query	supplierNr optional	supplierNr	string
Query	textFirstContact required	textFirstContact	string

Responses

HTTP Code	Description	Schema
200	OK	Ticket
201	Created ticket with id	Ticket
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Load a ticket, which are assigned to the requesting user

GET /ticket

Parameters

Type	Name	Description	Schema
Query	ticketNr required	ticketNr	string

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	No ticket found	No Content
409	Required ticket number is empty	No Content

Produces

```
\*/*
```

Upload a photo for a ticket

PUT /ticket/photo

Parameters

Type	Name	Description	Schema
Query	fileName required	fileName	string
Body	ticket required	ticket	Ticket

Responses

HTTP Code	Description	Schema
200	OK	ResponseEntity
201	Created	No Content
400	Not valid ticket / base64 encoded image or filename is blank / missing file extension	No Content
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content
406	A document with the same name already exists	No Content

Consumes

```
application/json
```

Produces

```
\*/*
```

Create a return form (RMA) for a ticket (base64 encoded pdf)

GET /ticket/return-form

Parameters

Type	Name	Description	Schema
Query	ticketNr required	ticketNr	string

Responses

HTTP Code	Description	Schema
200	OK	DownloadFile
401	Unauthorized	No Content
403	Forbidden	No Content
404	No ticket found for ticketNr	No Content

Produces

```
\*/*
```

Create a return form (RMA.pdf) for a ticket

GET /ticket/return-form/pdf

Parameters

Type	Name	Description	Schema
Query	ticketNr required	ticketNr	string

Responses

HTTP Code	Description	Schema
200	OK	string (byte)
401	Unauthorized	No Content
403	Forbidden	No Content
404	No ticket found for ticketNr	No Content

Produces

```
application/octet-stream
```

Load tickets, which are assigned to the requesting user

GET /tickets

Parameters

Type	Name	Description	Schema
Query	helpDeskStates optional	helpDeskStates	< string > array(multi)
Query	search optional	search	string
Query	sortAscendingTicketNr optional	sortAscendingTicketNr	boolean

Responses

HTTP Code	Description	Schema
200	OK	ListResponse
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

User

User Aktionen

Logs in the user

POST /login

Parameters

Type	Name	Schema
FormData	password required	string
FormData	username required	string

Responses

HTTP Code	Description	Schema
200	Login was successful	No Content
403	Username or password incorrect	No Content
503	Backend servers are not available	No Content

Consumes

```
application/x-www-form-urlencoded
```

Logs out the user

POST /logout

Responses

HTTP Code	Description	Schema
200	Logout successful	No Content

Consumes

```
application/x-www-form-urlencoded
```

User-info-endpoint

User Info Endpoint

Returns the Internet permissions stored for the logged-in user

GET /userAuthorizations

Responses

HTTP Code	Description	Schema
200	OK	< string, < string > array > map
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Display the current login information of the user

GET /userInfo

Responses

HTTP Code	Description	Schema
200	OK	< string, string > map
401	Unauthorized	No Content
403	Forbidden	No Content
404	Not Found	No Content

Produces

```
\*/*
```

Definitions

Address

Name	Schema
countryName optional	string
countryNumber optional	string
name1 optional	string
name2 optional	string
name3 optional	string
name4 optional	string
place optional	string
plz optional	string
street optional	string

Atr

Type : < string, string > map

BackendTable«Data»

Name	Schema
rows optional	< Data > array

Calendar

Name	Schema
calendarType optional	string
fieldsComputed optional	integer (int32)
fieldsNormalized optional	integer (int32)
firstDayOfWeek optional	integer (int32)
lenient optional	boolean
minimalDaysInFirstWeek optional	integer (int32)
time optional	string (date-time)
timeInMillis optional	integer (int64)
timeZone optional	TimeZone
weekCountData optional	Locale
weekDateSupported optional	boolean
weekYear optional	integer (int32)
weeksInWeekYear optional	integer (int32)
zoneShared optional	boolean

ChangePWDTO

Name	Description	Schema
encrypted optional	use encrypted pws Example : true	boolean
newPW optional	the better new password Example : "MyB3tt3rN3wP@$$w0rd"	string
oldPW optional	the old password Example : "MyOldPassword"	string

Character

Type : object

Chart

Name	Schema
borderline optional	integer (int32)
decimal optional	integer (int32)
elements optional	< ChartElement > array
eof optional	boolean
maximum optional	number (double)
minimum optional	number (double)
title optional	string
values optional	< ChartValues > array
xaxisLabel optional	string
yaxisLabel optional	string

ChartElement

Name	Schema
cls optional	string
key optional	< string, string > map
label optional	string

ChartValue

Name	Schema
description optional	string
value optional	number (double)

ChartValues

Name	Schema
key optional	< string, string > map
label optional	string
values optional	< ChartValue > array

Color

Name	Schema
alpha optional	integer (int32)
blue optional	integer (int32)
colorSpace optional	ColorSpace
green optional	integer (int32)
red optional	integer (int32)
rgb optional	integer (int32)
transparency optional	integer (int32)

ColorSpace

Name	Schema
cs_sRGB optional	boolean
numComponents optional	integer (int32)
type optional	integer (int32)

Data

Type : < string, string > map

DataTree

Name	Schema
cells optional	< < TreeCell > array > array
childCount optional	integer (int32)
cls optional	< string, string > map
description optional	string
entries optional	< DataTree > array
eof optional	boolean
expanded optional	boolean
format optional	string
freeSearch optional	string
hasChildren optional	boolean
help optional	string
key optional	< string, string > map
keytype optional	string
orgDescription optional	string
orgValue optional	string
parent optional	DataTree
record optional	< string, string > map
selected optional	boolean
value optional	string

DownloadFile

Name	Schema
base64Encoding optional	string
fileName optional	string
mimeType optional	string

DynamicFieldDescription

Name	Schema
classjoin optional	string
cls optional	string
enabled optional	boolean
height optional	integer (int32)
help optional	string
id optional	string
length optional	integer (int32)
matchcode optional	FieldMatchcode
maxheight optional	integer (int32)
maxlength optional	integer (int32)
options optional	< string, string > map
type optional	string

DynamicFieldDescriptionList

Name	Schema
fields optional	< DynamicFieldDescription > array

FieldMatchcode

Name	Schema
options optional	< string, string > map

GanttChart

Name	Schema
columns optional	< GanttColumn > array
dragStepping optional	number (float)
elements optional	< LegendElement > array
format optional	string
formats optional	< GanttFormat > array
max optional	string
min optional	string
parameters optional	< string, string > map
resizeStepping optional	number (float)
rows optional	< GanttRow > array
scale optional	string
stepping optional	integer (int32)
stopX optional	boolean
stopY optional	boolean
zoom optional	number (double)

GanttColumn

Name	Schema
align optional	string
description optional	string
help optional	string
label optional	string
options optional	< string, string > map
width optional	integer (int32)

GanttFormat

Name	Schema
format optional	string
from optional	string
to optional	string

GanttIcon

Name	Schema
align optional	string
name optional	string

GanttRow

Name	Schema
comparator optional	GanttValueComparator
formats optional	< GanttFormat > array
key optional	< string, string > map
label optional	string
labels optional	< string > array
refreshServerLevel optional	integer (int32)
serverLevels optional	boolean
values optional	< GanttValue > array

GanttValue

Name	Schema
format optional	string
from optional	string
group optional	GanttValueGroup
key optional	< string, string > map
level optional	integer (int32)
levelBeforeDrag optional	integer (int32)
maxTo optional	string
minFrom optional	string
parameters optional	< string, string > map
row optional	GanttRow
to optional	string

GanttValueComparator

Name	Schema
valueNumeric optional	boolean

GanttValueGroup

Name	Schema
icons optional	< GanttIcon > array
members optional	< GanttValue > array
parameters optional	< string, string > map

Key

Type : < string, string > map

Language

Name	Schema
languageId optional	string

LegendElement

Name	Schema
description optional	string
format optional	string

ListResponse

Name	Schema
header optional	< string, string > map
info optional	< string, string > map
table optional	Table

Locale

Name	Schema
country optional	string
displayCountry optional	string
displayLanguage optional	string
displayName optional	string
displayScript optional	string
displayVariant optional	string
extensionKeys optional	< Character > array
iso3Country optional	string
iso3Language optional	string
language optional	string
script optional	string
unicodeLocaleAttributes optional	< string > array
unicodeLocaleKeys optional	< string > array
variant optional	string

Order

Name	Schema
currency optional	string
netPrice optional	number (double)
netShippingCost optional	number (double)
orderHeader optional	OrderHeader
orderNr optional	string
orderPositions optional	< OrderPosition > array
positionsCount optional	integer (int32)

OrderHeader

Name	Schema
billingAddress optional	Address
completeOrder optional	string
contactDetails optional	string
customerOrderEntries optional	string
customerOrderNr optional	string
deliveryAddress optional	Address
deliveryDetails1 optional	string
deliveryDetails2 optional	string
email optional	string
shippingMethod optional	string

OrderPos

Name	Schema
posData optional	< TableCell > array

OrderPosition

Name	Schema
deliveryDate optional	string (date-time)
grossPrice optional	number (double)
item optional	string
itemDescription optional	string
lieferdatumAbweichend optional	boolean
netPrice optional	number (double)
positionCounter optional	integer (int32)
positionNr optional	integer (int32)
priceDimension optional	string
quantity optional	number (double)
quantityUnit optional	string

OrderWithPos

Name	Schema
headData optional	< TableCell > array
positions optional	< OrderPos > array

OrderWithPosListResponse

Name	Schema
info optional	< string, string > map
orders optional	< OrderWithPos > array

OxaionException

Name	Schema
action optional	string
cause optional	Throwable
code optional	string
field optional	string
localizedMessage optional	string
message optional	string
priority optional	integer (int32)
reason optional	string
stackTrace optional	< StackTraceElement > array
suppressed optional	< Throwable > array
title optional	string

RegistrationInfo

Name	Schema
company optional	string
firstName optional	string
mailAddress optional	string
name optional	string
place optional	string
street optional	string
zipCode optional	string

ResetPWDTO

Name	Description	Schema
encrypted optional	use encrypted pw Example : true	boolean
newPW optional	the new password Example : "MyN3wP@$$w0rd"	string
token optional	the generated reset token	string

ResponseEntity

Name	Schema
body optional	object
statusCode optional	enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)
statusCodeValue optional	integer (int32)

StackTraceElement

Name	Schema
classLoaderName optional	string
className optional	string
fileName optional	string
lineNumber optional	integer (int32)
methodName optional	string
moduleName optional	string
moduleVersion optional	string
nativeMethod optional	boolean

Stream

Name	Schema
contents optional	< StreamContent > array
eof optional	boolean
header optional	< string, string > map

StreamContent

Name	Schema
content optional	string

StringBuffer

Name	Schema
length optional	integer (int32)

StringTransferable

Name	Schema
value optional	string

Table

Name	Schema
cells optional	< TableCell > array
checkmarked optional	boolean
columns optional	< TableColumn > array
eof optional	boolean
error optional	boolean
expanded optional	boolean
format optional	string
freeSearch optional	string
index optional	integer (int32)
key optional	< string, string > map
position optional	string
protect optional	boolean
rows optional	< TableRow > array
selected optional	string
size optional	integer (int32)
title optional	string
top optional	boolean
treeTable optional	boolean
updateCount optional	integer (int32)
viewNames optional	< string > array
viewPositions optional	< integer (int32) > array

TableCell

Name	Schema
attributes optional	< string, string > map
error optional	boolean
errorReason optional	OxaionException
format optional	string
name optional	string
textValueList optional	< string > array
value optional	string
valueList optional	< string > array

TableColumn

Name	Schema
align optional	string
classjoin optional	string
cls optional	string
description optional	string
distinctSelectable optional	boolean
editable optional	boolean
format optional	string
helpURL optional	string
length optional	integer (int32)
name optional	string
options optional	< string, string > map
selectable optional	boolean
selected optional	boolean
sortable optional	boolean
sorted optional	string
sum optional	string
titles optional	< string > array
type optional	string
width optional	integer (int32)

TableRow

Name	Schema
cells optional	< TableCell > array
checkmarked optional	boolean
error optional	boolean
expanded optional	boolean
format optional	string
index optional	integer (int32)
key optional	< string, string > map
protect optional	boolean
rows optional	< TableRow > array
updateCount optional	integer (int32)

Throwable

Name	Schema
cause optional	Throwable
localizedMessage optional	string
message optional	string
stackTrace optional	< StackTraceElement > array
suppressed optional	< Throwable > array

Ticket

Name	Schema
base64EncodedImage optional	string
obid optional	string
ticketNr optional	string

TimeZone

Name	Schema
displayName optional	string
dstsavings optional	integer (int32)
id optional	string
rawOffset optional	integer (int32)

Timetable

Name	Schema
color optional	Color
entries optional	< TimetableEntry > array
key optional	< string, string > map
name optional	string
options optional	< string, string > map
visible optional	boolean

TimetableEntry

Name	Schema
clsData optional	< string, string > map
description optional	string
elementTypeIcon optional	string
end optional	Calendar
key optional	< string, string > map
location optional	string
masterclass optional	string
options optional	< string, string > map
start optional	Calendar
statusIcon optional	string

TimetableList

Name	Schema
elements optional	< LegendElement > array
timetables optional	< Timetable > array

TreeCell

Name	Schema
description optional	string
value optional	string

UIDescriptionEntity

Name	Schema
xml optional	StringBuffer

XXAddress

Name	Schema
alphaMatchcode optional	string
branchNumber optional	string
countryName optional	string
countryNumber optional	string
formOfAddress optional	string
name1 optional	string
name2 optional	string
name3 optional	string
name4 optional	string
personalAccountNumber optional	string
place optional	string
plz optional	string
shippingCostAgreement optional	string
street optional	string
street1 optional	string
street2 optional	string
street3 optional	string
street4 optional	string
xxAddressID optional	string

Seitenhierarchie

API-Dokumentation

Tags

Resources

Addresses-endpoint

Creates a deviating address

Parameters

Responses

Consumes

Produces

Determine default address

Responses

Produces

All-orders-endpoint

Determines all orders of the logged in customer

Parameters

Responses

Produces

Determines all orders with postions of the logged in customer

Parameters

Responses

Produces

Article-info-endpoint

get some details for a certain item

Parameters

Responses

Produces

Articles-endpoint

calls the item search and returns a list of matching items

Parameters

Responses

Produces

Availability-endpoint

Checks the availability for a certain item with a certain quantity

Parameters

Responses

Produces

Change-password-endpoint

creates a new token and send it per e-Mail to the user for a following reset

Parameters

Responses

Consumes

Produces

checks whether the user is still using the initial password given by the administrator

Responses

Consumes

Produces

resets a forgotten password to a new one

Parameters

Responses

Consumes

Produces

changes the password if the user still knows the old one

Parameters

Responses

Consumes

Produces

Contact-message-endpoint

Send a message via e-Mail by a contact form

Parameters

Responses

Consumes

Produces

Delivery-endpoint

Returns a list of all or a certain deliveries/delivery for the customer

Parameters

Responses

Produces

Delivery-positions-endpoint

Display of all positions for a delivery bill

Parameters

Responses

Produces

Delivery-tracking-endpoint

Display of all tracking numbers for a delivery bill

Parameters

Responses

Produces

Device-controller

Load device detail for one device, which is assigned to the requesting user