Operation: GetProfile

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

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

vcp:UnsupportedQueryType*

Information Ă¼ber nicht unterstĂ¼tze QueryParameter, vgl. Belegverwaltung

vcp:SpecialRequestReference

vcp:RequestReferenceType*

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

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

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

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 (nur bis Version 1.3)

  • URL-S (nur bis Version 1.3)

  • XML-POST

  • XML-POST-S

vcp:OperationType

vcp:TransactionType

vcp:PropertyKeyType

  • OrderInOnlineShop.TransactionID
    Feste TransactionID zur Kennzeichnung der 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 Lieferbarkeit

  • Order.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

  • 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.

  • 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

  • Order.BacklogDefault
    Indikator zum grundsätzlichen Verhalten bei nicht lieferbaren Artikeln. Mögliche Werte:
    - false: keine Nachlieferung
    - true: Nachlieferung

  • RecommendedRetailPrice.Netto
    Indikator, ob die empfohlenen Verkaufspreise als Nettopreise angegeben sind. Mögliche Werte:
    - false: empfohlene Verkauspreise sind brutto
    - true: empfohlene Verkaufspreise sind netto

  • quantityUnitCode.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)

  • Catalog.ItemInformation.ProductData
    Indikator, ob dieser Server möglicherweise das product_data Element von v1.5 in ItemInformation senden kann. Mögliche Werte:
    - false: der Server sendet das Element product_data in ItemInformation nicht (Standard)
    - true: der Server kann ggf. das Element product_data in ItemInformation senden

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

 

Related pages