| Table of Contents | ||
|---|---|---|
|
Die Operation GetProfile muss von jedem veloconnect-konformen Server in der URL-Bindung oder der URL-S-Bindung implementiert werden. Auf eine Anfrage vcp:GetProfileRequest vom Typ vct:RequestType liefert ein veloconnect-konformer Server die Antwort vcp:GetProfileResponse zurück. Diese erweitert den Typ vct:ResponseType um die beiden optionalen Elemente vcp:SellerName und vcp:Message und das Pflicht-Element vcp:VeloconnectProfile.
Im Element vcp:SellerName soll der Name des Lieferanten im Klartext angegeben werden, vcp:Message kann dazu benutzt werden eine kurze Information an den Benutzer des Client zu übergeben. Vor Benutzung der anderen Operationen und Transaktionen sollte der Client, die Angaben in vcp:VeloconnectProfile auswerten, da die dortigen Informationen Einfluss auf die Aufbereitung der Daten für den Endbenutzer haben können. Es kann davon ausgegangen werden, dass die Informationen im Profil 24 Stunden gültig bleiben.
Das Element vcp:VeloconnectProfile ist wie folgt definiert:
...
Name
...
Typ/Vorkommen
...
The GetProfile operation must be implemented by each Veloconnect-compliant server in the URL binding or URL-S binding. On issue of a vcp:GetProfileRequest of type vct:RequestType, a Veloconnect-compliant server responds with vcp:GetProfileResponse. This extends the vct:ResponseType with the two optional elements vcp:SellerName and vcp:Message, as well as the compulsory element vcp:VeloconnectProfile.
The element vcp:SellerName is to specify the supplier's name in plain text; vcp:Message can be used to convey brief information to the client's user. Before executing the other operations and transactions, the client should evaluate the information in vcp:VeloconnectProfile because this information can influence data processing for the end user. The information in the profile can be assumed to remain valid for 24 hours.
The element vcp:VeloconnectProfile is defined as follows:
Name | Type/occurrence | Description |
|---|---|---|
vcp:Implements | vcp:ImplementsType* | Information über implementierte Operationen, Transaktionen und ihre Bindungenabout implemented operations, transactions and their bindings. |
vcp:Property | vcp:PropertyType* | Eigenschaften des Servers als Schlüssel-Wert-PaareServer properties as key-value pairs. |
vcp:UnsupportedQuery | Information über nicht unterstütze QueryParameter, vgl. Belegverwaltungabout unsupported QueryParameters, refer to document management. | |
vcp:SpecialRequestReference | Spezielle Referenzen auf Angebote, auf die der Nutzer aufmerksam gemacht werden soll, vgl. Belegart: Offer |
...
Special references to offers for the user's attention, refer to document type: offer. |
An element of type vcp:ImplementsType has the following structure:
Name | TypType/Vorkommenoccurrence | BeschreibungDescription |
|---|---|---|
entweder: vcp:Transaction | vcp:TransactionTypeName der Transaktion | Transaction's name. |
oder: vcp:Operation | vcp:OperationType | Name der Operation's name. |
vcp:Binding | vcp:BindingType | BindungBinding. |
vcp:URI | xsd:anyURI? | URL , unter der die Transaktion bzw. Operation zu erreichen ist, falls diese von der Standard-URL abweicht. |
...
at which the transaction or operation can be accessed, if different from the default URL. |
An element of type vcp:PropertyType has the following structure:
Name | TypType/Vorkommenoccurrence | BeschreibungDescription |
|---|---|---|
vcp:Key | vcp:PropertyKeyType | SchlüsselKey. |
vcp:Value | xsd:normalizedString | Wert |
...
Value. |
An element of type vcp:RequestReferenceType ist wie folgt aufgebauthas the following structure:
Name | TypType/Vorkommenoccurrence | BeschreibungDescription |
|---|---|---|
vcp:RequestReference | xsd:normalizedString | RequestReference zur Verwendung im OfferQueryRequestfor use in OfferQueryRequest. |
vcp:Description | xsd:normalizedString | Beschreibung der Angebote, die mit dem Suchparameter in RequestReference gesucht werden können |
...
Description of the offers which can be searched with the search parameter in RequestReference. |
The permissible contents of the types vcp:BindingType, vcp:OperationType, vcp:TransactionType, vcp:PropertyKeyType und and vcp:UnsupportedQueryType sind folgenden Listen zu entnehmencan be found in the following lists:
vcp:BindingType
URL
URL-S
XML-POST
XML-POST-S
vcp:OperationType
GetItemDetails: vgl. Refer to Operation: GetItemDetails
GetItemDetailsList: vgl. Refer to Operation: GetItemDetailsList
GetClassificationScheme: vgl. Refer to Operation: GetClassificationScheme
OfferQuery, vgl. : Refer to Operation: OfferQuery
OfferDetails, vgl. : Refer to Operation: OfferDetails
OrderConfirmationQuery: vgl. Refer to Operation: OrderConfirmationQuery
OrderConfirmationDetails: vgl. Refer to Operation: OrderConfirmationDetails
DeliveryNoteQuery: vgl. Refer to Operation: DeliveryNoteQuery
DeliveryNoteDetails: vgl. Refer to Operation: DeliveryNoteDetails
InvoiceInformationQuery: vgl. Refer to Operation: InvoiceInformationQuery
InvoiceInformationDetails: vgl. Refer to Operation: InvoiceInformationDetails
GetStatus: vgl.Refer to Operation: GetStatus
Rollback: vgl. Refer to Operation: Rollback
vcp:TransactionType
Order: vgl. Refer to Transaktion: Order
OrderInOnlineShop: vgl. Refer to Transaktion: OrderInOnlineShop
TextSearch: vgl. Refer to Transaktion: TextSearch
vcp:PropertyKeyType
OrderInOnlineShop.TransactionID
Feste TransactionID zur Kennzeichnung der Transaktion OrderInOnlineShopFixed TransactionID to identify the transaction OrderInOnlineShop.Order.Availability
Indikator, ob Informationen zur Lieferbarkeit bereitgestellt werden. Mögliche WerteIndicator whether information on availability is provided. Possible values:
- true: Lieferbarkeit wird grundsätzlich mitgeteiltAvailability is always communicated.
- false: grundsätzlich keine Angaben zur LieferbarkeitBasically no information on availability.Order.DeliveryDate
Indikator, ob und wie terminierte Bestellungen möglich sind. Mögliche WerteIndicator whether and how scheduled orders are possible. Possible values:
- false: terminierte Bestellung nicht möglichScheduled orders not possible.
- order: das Lieferdatum bezieht sich auf die gesamte BestellungDelivery date applies to entire order.
- line: für jede Bestellzeile kann ein individuelles Datum angegeben werdenAn individual date can be specified for each order line.Order.ExpectingDelivery
Falls der Server die Verfügbarkeit von Artikeln mitteilt, hierbei den Code expecting_delivery verwendet, aber keine Angaben zum erwarteten Lieferdatum macht, so wird mit dieser Eigenschaft die Anzahl von Tagen mitgeteilt, innnerhalb derer mit einer Lieferung zu rechnen istIf the server communicates availability of items whilst using the code expecting_delivery without providing any information about the expected delivery date, this property indicates the number of days within which delivery is expected.Order.Backlog
Indikator, ob und wie die Nachlieferung gesteuert werden kann. Mögliche WerteIndicator whether and how subsequent delivery can be controlled. Possible values:
- false: keine Steuerung möglichNo control possible.
- order: einheitliche Steuerung für die gesamte BestellungStandardized control for the entire order.
- line: für jede Bestellzeile kann die Nachlieferung gesteuert werdenSubsequent delivery can be controlled for each order line.Order.BacklogDefault
Indikator zum grundsätzlichen Verhalten bei nicht lieferbaren Artikeln. Mögliche WerteIndicator of the basic behaviour of non-available items. Possible values:
- false: keine NachlieferungNo subsequent delivery.
- true: NachlieferungSubsequent delivery.RecommendedRetailPrice.Netto
Indikator, ob die empfohlenen Verkaufspreise als Nettopreise angegeben sind. Mögliche WerteIndicator whether the recommended sales prices are specified as net. Possible values:
- false: empfohlene Verkauspreise sind bruttoRecommended sales prices are gross.
- true: empfohlene Verkaufspreise sind nettoRecommended sales prices are net.quantityUnitCode.EA
Indikator, ob grundsätzlich nur Stück als Einheit verwendet wird. Mögliche WerteIndicator whether only piece is used as a unit. Possible values:
- false: der Server is in der Lage, korrekte Einheiten zu übermittelnThe server is able to communicate correct units.
- true: der Server übermittelt immer nur die Einheit The server only communicates the unit EA (Stückeach).
Ein veloconnect-konformer Server muss nicht zu jedem Schlüssel einen Wert angeben. Falls für die Werte eine Auswahliste angegeben ist, kann ein veloconnect-Client davon ausgehen, dass der entsprechende Schlüssel den ersten Wert in dieser Liste hat, wenn im Profil dieser Schlüssel nicht aufgeführt wird oder der Wert nicht mit einem Wert aus der Liste übereinstimmtA Veloconnect-compliant server does not have to specify a value for each key. If a selection list is provided for the values, a Veloconnect client can assume that the corresponding key has the first value in this list, assuming this key is not mentioned in the profile or the value does not match a value from the list.
vcp:UnsupportQueryType
OrderConfirmation-OrderID: Suche nach Search for OrderID in OrderConfirmationQuery nicht möglichnot possible.
DeliveryNote-OrderID: Suche nach Search for OrderID in DeliveryNoteQuery nicht möglichnot possible.
Invoice-OrderID: Suche nach Search for OrderID in InvoiceInformationQuery nicht möglichnot possible.
DeliveryNote-OrderConfirmationID: Suche nach Search for OrderConfirmationID in DeliveryNoteQuery nicht möglichnot possible.
Invoice-OrderConfirmationID: Suche nach Search for OrderConfirmationID in InvoiceInformationQuery nicht möglichnot possible.
Invoice-DeliveryNoteID: Suche nach Search for DeliveryNoteID in InvoiceInformationQuery nicht möglichnot possible.