heilog.ch.Api

<back to all web services

GetCustomersRequest

The following routes are available for this service:
GET/customer
GetCustomersRequest Parameters:
NameParameterData TypeRequiredDescription
SearchFilterquerystringNo
PageSizequeryintNo
PagequeryintNo
PropertyquerystringNo
IsAscendingqueryboolNo
GetCustomersResponse Parameters:
NameParameterData TypeRequiredDescription
CustomersformList<CustomerPreviewDto>No
TotalEntitiesformlongNo
PageformintNo
PageSizeformintNo
PropertyformstringNo
IsAscendingformboolNo
CustomerPreviewDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
FirstNameformstringNo
LastNameformstringNo
StreetformstringNo
ZipformstringNo
PlaceformstringNo

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 HTTP/1.1 
Host: heidak-api.test.exanic.ch 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCustomersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/heilog.ch.Api.ServiceModel.Customer">
  <Customers xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Customer">
    <d2p1:CustomerPreviewDto>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:Place>String</d2p1:Place>
      <d2p1:Street>String</d2p1:Street>
      <d2p1:Zip>String</d2p1:Zip>
    </d2p1:CustomerPreviewDto>
  </Customers>
  <IsAscending>false</IsAscending>
  <Page>0</Page>
  <PageSize>0</PageSize>
  <Property>String</Property>
  <TotalEntities>0</TotalEntities>
</GetCustomersResponse>