Operation: GetProfile
- Michelle Zaczek (Unlicensed)
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 about implemented operations, transactions and their bindings. |
vcp:Property | vcp:PropertyType* | Server properties as key-value pairs. |
vcp:UnsupportedQuery | Information about unsupported QueryParameters, refer to document management. | |
vcp:SpecialRequestReference | 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 | Type/occurrence | Description |
|---|---|---|
entweder: vcp:Transaction | vcp:TransactionType | Transaction's name. |
oder: vcp:Operation | vcp:OperationType | Operation's name. |
vcp:Binding | vcp:BindingType | Binding. |
vcp:URI | xsd:anyURI? | URL 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 | Type/occurrence | Description |
|---|---|---|
vcp:Key | vcp:PropertyKeyType | Key. |
vcp:Value | xsd:normalizedString | Value. |
An element of type vcp:RequestReferenceType has the following structure:
Name | Type/occurrence | Description |
|---|---|---|
vcp:RequestReference | xsd:normalizedString | RequestReference for use in OfferQueryRequest. |
vcp:Description | xsd:normalizedString | 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 and vcp:UnsupportedQueryType can be found in the following lists:
vcp:BindingType
URL
URL-S
XML-POST
XML-POST-S
vcp:OperationType
GetItemDetails: Refer to Operation: GetItemDetails
GetItemDetailsList: Refer to Operation: GetItemDetailsList
GetClassificationScheme: Refer to Operation: GetClassificationScheme
OfferQuery: Refer to Operation: OfferQuery
OfferDetails: Refer to Operation: OfferDetails
OrderConfirmationQuery: Refer to Operation: OrderConfirmationQuery
OrderConfirmationDetails: Refer to Operation: OrderConfirmationDetails
DeliveryNoteQuery: Refer to Operation: DeliveryNoteQuery
DeliveryNoteDetails: Refer to Operation: DeliveryNoteDetails
InvoiceInformationQuery: Refer to Operation: InvoiceInformationQuery
InvoiceInformationDetails: Refer to Operation: InvoiceInformationDetails
GetStatus: Refer to Operation: GetStatus
Rollback: Refer to Operation: Rollback
vcp:TransactionType
Order: Refer to Transaktion: Order
OrderInOnlineShop: Refer to Transaktion: OrderInOnlineShop
TextSearch: Refer to Transaktion: TextSearch
vcp:PropertyKeyType
OrderInOnlineShop.TransactionID
Fixed TransactionID to identify the transaction OrderInOnlineShop.Order.Availability
Indicator whether information on availability is provided. Possible values:
- true: Availability is always communicated.
- false: Basically no information on availability.Order.DeliveryDate
Indicator whether and how scheduled orders are possible. Possible values:
- false: Scheduled orders not possible.
- order: Delivery date applies to entire order.
- line: An individual date can be specified for each order line.Order.ExpectingDelivery
If 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
Indicator whether and how subsequent delivery can be controlled. Possible values:
- false: No control possible.
- order: Standardized control for the entire order.
- line: Subsequent delivery can be controlled for each order line.Order.BacklogDefault
Indicator of the basic behaviour of non-available items. Possible values:
- false: No subsequent delivery.
- true: Subsequent delivery.RecommendedRetailPrice.Netto
Indicator whether the recommended sales prices are specified as net. Possible values:
- false: Recommended sales prices are gross.
- true: Recommended sales prices are net.quantityUnitCode.EA
Indicator whether only piece is used as a unit. Possible values:
- false: The server is able to communicate correct units.
- true: The server only communicates the unit EA (each).
A 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: Search for OrderID in OrderConfirmationQuery not possible.
DeliveryNote-OrderID: Search for OrderID in DeliveryNoteQuery not possible.
Invoice-OrderID: Search for OrderID in InvoiceInformationQuery not possible.
DeliveryNote-OrderConfirmationID: Search for OrderConfirmationID in DeliveryNoteQuery not possible.
Invoice-OrderConfirmationID: Search for OrderConfirmationID in InvoiceInformationQuery not possible.
Invoice-DeliveryNoteID: Search for DeliveryNoteID in InvoiceInformationQuery not possible.