Mauve.Bestellforum

<back to all web services

GetCustomerByExternalId

Get a customer via its external id.

Requires Authentication
Required permission:all
The following routes are available for this service:
GET/customer/externalid/{ExternalId}
GetCustomerByExternalId Parameters:
NameParameterData TypeRequiredDescription
ExternalIdpathstringYesThe external id to get the customer by.
Customer Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe id of the customer.
ExternalIdformstringNoThe external id of the customer.
AddressIdformintNoThe id of the customer's primary address.

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /customer/externalid/{ExternalId} HTTP/1.1 
Host: bestellforum.api.mauve.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mauve.Bestellforum.ServiceModel.Types">
  <AddressId>0</AddressId>
  <ExternalId>String</ExternalId>
  <Id>String</Id>
</Customer>