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 | Beschreibung |
---|---|---|
vcp:Implements | vcp:ImplementsType* | Information über implementierte Operationen, Transaktionen und ihre Bindungen |
vcp:Property | vcp:PropertyType* | Eigenschaften des Servers als Schlüssel-Wert-Paare |
vcp:UnsupportedQuery | Information über nicht unterstütze QueryParameter, vgl. Belegverwaltung | |
vcp:SpecialRequestReference | Spezielle Referenzen auf Angebote, auf die der Nutzer aufmerksam gemacht werden soll, vgl. Belegart: Offer |
Ein Element vom Typ vcp:ImplementsType ist wie folgt aufgebaut:
Name | Typ/Vorkommen | Beschreibung |
---|---|---|
entweder: vcp:Transaction | vcp:TransactionType | Name der Transaktion |
oder: vcp:Operation | vcp:OperationType | Name der Operation |
vcp:Binding | vcp:BindingType | Bindung |
vcp:URI | xsd:anyURI? | URL, unter der die Transaktion bzw. Operation zu erreichen ist, falls diese von der Standard-URL abweicht. |
Ein Element vom Typ vcp:PropertyType ist wie folgt aufgebaut:
Name | Typ/Vorkommen | Beschreibung |
---|---|---|
vcp:Key | vcp:PropertyKeyType | Schlüssel |
vcp:Value | xsd:normalizedString | Wert |
Ein Element vom Typ vcp:RequestReferenceType ist wie folgt aufgebaut:
Name | Typ/Vorkommen | Beschreibung |
---|---|---|
vcp:RequestReference | xsd:normalizedString | RequestReference zur Verwendung im OfferQueryRequest |
vcp:Description | xsd:normalizedString | Beschreibung der Angebote, die mit dem Suchparameter in RequestReference gesucht werden können |
Die zulässigen Inhalte der Typen vcp:BindingType, vcp:OperationType, vcp:TransactionType, vcp:PropertyKeyType und vcp:UnsupportedQueryType sind folgenden Listen zu entnehmen:
vcp:BindingType
URL
URL-S
XML-POST
XML-POST-S
vcp:OperationType
GetItemDetails Abschnitt 7.5, „Operation: GetItemDetails“
GetItemDetailsList Abschnitt 7.6, „Operation: GetItemDetailsList (neu in Version 1.1)“
GetClassificationSchemeAbschnitt 9.2, „Operation: GetClassificationScheme“
OfferQuery
OfferDetails
OrderConfirmationQuery
OrderConfirmationDetails
DeliveryNoteQuery
DeliveryNoteDetails
InvoiceInformationQuery
InvoiceInformationDetails
GetStatus Abschnitt 6.3, „Operation: GetStatus“
Rollback Abschnitt 6.4, „Operation: Rollback“
vcp:TransactionType
Order Abschnitt 7, „Transaktion: Order“
OrderInOnlineShop Abschnitt 8, „Transaktion: OrderInOnlineShop“
TextSearch Abschnitt 9.1, „Transaktion: TextSearch“
vcp:PropertyKeyType
OrderInOnlineShop.TransactionID
Feste TransactionID zur Kennzeichnung der Transaktion OrderInOnlineShop (Abschnitt 8, „Transaktion: OrderInOnlineShop“)Order.Availability
Indikator, ob Informationen zur Lieferbarkeit bereitgestellt werden. Mögliche Werte:
- true: Lieferbarkeit wird grundsätzlich mitgeteilt
- false: grundsätzlich keine Angaben zur LieferbarkeitOrder.DeliveryDate
Indikator, ob und wie terminierte Bestellungen möglich sind. Mögliche Werte:
- false: terminierte Bestellung nicht möglich
- order: das Lieferdatum bezieht sich auf die gesamte Bestellung
- line: für jede Bestellzeile kann ein individuelles Datum angegeben werden
(vgl. Abschnitt 7, „Transaktion: Order“)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 ist. (vgl. Abschnitt 7, „Transaktion: Order“)Order.Backlog
Indikator, ob und wie die Nachlieferung gesteuert werden kann. Mögliche Werte:
- false: keine Steuerung möglich
- order: einheitliche Steuerung für die gesamte Bestellung
- line: für jede Bestellzeile kann die Nachlieferung gesteuert werden
(vgl. Abschnitt 7, „Transaktion: Order“)Order.BacklogDefault
Indikator zum grundsätzlichen Verhalten bei nicht lieferbaren Artikeln. Mögliche Werte:
- false: keine Nachlieferung
- true: Nachlieferung
(vgl. Abschnitt 7, „Transaktion: Order“)RecommendedRetailPrice.Netto
Indikator, ob die empfohlenen Verkaufspreise als Nettopreise angegeben sind. Mögliche Werte:
- false: empfohlene Verkauspreise sind brutto
- true: empfohlene Verkaufspreise sind nettoquantityUnitCode.EA
Indikator, ob grundsätzlich nur Stück als Einheit verwendet wird. Mögliche Werte:
- false: der Server is in der Lage, korrekte Einheiten zu übermitteln
- true: der Server übermittelt immer nur die Einheit EA (Stück)
(vgl. Regel: Benutzung von Einheiten in Abschnitt 5.4, „Beschreibung von Gegenständen“)
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 übereinstimmt.
vcp:UnsupportQueryType
OrderConfirmation-OrderID: Suche nach OrderID in OrderConfirmationQuery nicht möglich
DeliveryNote-OrderID: Suche nach OrderID in DeliveryNoteQuery nicht möglich
Invoice-OrderID: Suche nach OrderID in InvoiceInformationQuery nicht möglich
DeliveryNote-OrderConfirmationID: Suche nach OrderConfirmationID in DeliveryNoteQuery nicht möglich
Invoice-OrderConfirmationID: Suche nach OrderConfirmationID in InvoiceInformationQuery nicht möglich
Invoice-DeliveryNoteID: Suche nach DeliveryNoteID in InvoiceInformationQuery nicht möglich