CustomersGetByName


 

Overview

Quick Links

Retrieves Customers by the specified name.


Resource Information



Request FormatXML
Response FormatXML

Request Header

NameTypeDescription
StringStringAuthentication Token

Request Body

NameTypeDescription
customerNameStringThe Customer name to search for

Response

NameTypeDescription
ResultStringReturns the details of the Customer in the system.
ResultCodeStringString indicating the result. Either "Success" or "Error".
ResultMessageStringEmpty when call successful, error message otherwise.

In the case of an internal unhandled fault, a Fault object is returned instead. Providing information on what occurred exactly.

Examples

Request

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
 <Body>
 <CustomersGetByName xmlns="http://tempuri.org/">
 <customerName>Customer 010</customerName>
 </CustomersGetByName>
 </Body>
</Envelope>

Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
 <s:Body>
 <CustomersGetByNameResponse xmlns="http://tempuri.org/">
 <CustomersGetByNameResult xmlns:a="http://schemas.datacontract.org/2004/07/Kolonel.Public.Service.API.Contracts.V1_0" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
 <a:Result>
 <a:Customer>
 <a:Addresses>
 <a:Address>
 <a:AddressLine1>Laapersveld 61</a:AddressLine1>
 <a:AddressLine2/>
 <a:AddressLine3/>
 <a:AddressLine4/>
 <a:AddressLine5/>
 <a:City>Hilversum</a:City>
 <a:Country>Nederland</a:Country>
 <a:HouseNumber/>
 <a:HouseNumberAddition/>
 <a:Name>Invoice Address</a:Name>
 <a:PostalCode>1213 VB</a:PostalCode>
 </a:Address>
 </a:Addresses>
 <a:BillFromDate>2014-04-01T13:34:56.789+02:00</a:BillFromDate>
 <a:BillingBatchReference i:nil="true"/>
 <a:CreatedDate>2014-01-01T12:34:56.789+01:00</a:CreatedDate>
 <a:CustomerClusterId>5491c6f6ae8b10e33a13a594</a:CustomerClusterId>
 <a:CustomerCode>C010</a:CustomerCode>
 <a:CustomerName>Customer 010</a:CustomerName>
 <a:DateValues/>
 <a:EmailAddresses i:nil="true"/>
 <a:Id>5491c6f7ae8b10e33a13a5f8</a:Id>
 <a:ImportTagName i:nil="true"/>
 <a:InvoicePeriodAlignToUOM>true</a:InvoicePeriodAlignToUOM>
 <a:InvoicePeriodSize>1</a:InvoicePeriodSize>
 <a:InvoicePeriodUOM>Month</a:InvoicePeriodUOM>
 <a:InvoiceRunReference i:nil="true"/>
 <a:InvoiceSeparatelyPerPeriod>true</a:InvoiceSeparatelyPerPeriod>
 <a:IsBillingSuspended>false</a:IsBillingSuspended>
 <a:IsBusyBilling>false</a:IsBusyBilling>
 <a:IsBusyImporting>false</a:IsBusyImporting>
 <a:IsBusyInvoicing>false</a:IsBusyInvoicing>
 <a:IsReservedForBilling>false</a:IsReservedForBilling>
 <a:LCID>1033</a:LCID>
 <a:LastInvoiceDate i:nil="true"/>
 <a:LastPurchaseImportDate i:nil="true"/>
 <a:NumericValues>
 <a:NameValuePair>
 <a:Name>price</a:Name>
 <a:Value>2</a:Value>
 </a:NameValuePair>
 <a:NameValuePair>
 <a:Name>cost</a:Name>
 <a:Value>3</a:Value>
 </a:NameValuePair>
 </a:NumericValues>
 <a:ReservedForBillingDate>2014-12-22T12:12:21.837+01:00</a:ReservedForBillingDate>
 <a:StringValues>
 <a:NameValuePair>
 <a:Name>MSISDN</a:Name>
 <a:Value>31600000010</a:Value>
 </a:NameValuePair>
 <a:NameValuePair>
 <a:Name>bill</a:Name>
 <a:Value>1</a:Value>
 </a:NameValuePair>
 </a:StringValues>
 <a:TimezoneId>W. Europe Standard Time</a:TimezoneId>
 <a:UpdatedDate i:nil="true"/>
 </a:Customer>
 </a:Result>
 <a:ResultCode>Success</a:ResultCode>
 <a:ResultMessage/>
 </CustomersGetByNameResult>
 </CustomersGetByNameResponse>
 </s:Body>
</s:Envelope>