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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"customers":[{"id":0,"firstName":"String","lastName":"String","street":"String","zip":"String","place":"String"}],"totalEntities":0,"page":0,"pageSize":0,"property":"String","isAscending":false}