GET api/consumer/v1/customers?page={page}&pageSize={pageSize}&sortField={sortField}&sortAscending={sortAscending}
Get all customers
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| page |
Current page |
integer |
Default value is 1 |
| pageSize |
Page size |
integer |
Default value is 50 |
| sortField |
Name of the field to use for sorting |
string |
Default value is |
| sortAscending |
True for ascending sorting, false otherwise |
boolean |
Default value is True |
Body Parameters
None
Response Information
Resource Description
List of customers
Collection of CustomerDto| Name | Description | Type | Additional information |
|---|---|---|---|
| BusinessUnit |
Business Unit of the customer |
BusinessUnitMinDto |
None |
| Address |
Address of the Customer |
string |
None |
| Cap |
Cap of the Customer |
string |
None |
| City |
City of the Customer |
string |
None |
| Country |
Country of the Customer |
string |
None |
| TelephoneNumber |
Telephone Number of the Customer |
string |
None |
| Fax |
Fax of the Customer |
string |
None |
| WebSite |
Web Site of the Customer |
string |
None |
|
E-mail of the Customer |
string |
None |
|
| Code |
The short code of the element |
string |
None |
| Description |
The description of the element |
string |
None |
| IsActive |
True if the element is active, false otherwise |
boolean |
None |
| Permissions |
Permissions |
PermissionDto |
None |
| CreationDate |
Creation |
date |
None |
| CreatedBy |
The user who has made the insert |
UserMinDto |
None |
| LastUpdateDate |
Date of the last update |
date |
None |
| LastUpdatedBy |
The user who has made the last update |
UserMinDto |
None |
| Id |
Unique ID |
integer |
None |
Response Formats
application/json, text/json
Sample:
[
{
"BusinessUnit": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"Address": "sample string 1",
"Cap": "sample string 2",
"City": "sample string 3",
"Country": "sample string 4",
"TelephoneNumber": "sample string 5",
"Fax": "sample string 6",
"WebSite": "sample string 7",
"Email": "sample string 8",
"Code": "sample string 9",
"Description": "sample string 10",
"IsActive": true,
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"CreationDate": "2024-11-01T19:27:59.0819913+01:00",
"CreatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastUpdateDate": "2024-11-01T19:27:59.0819913+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 12
},
{
"BusinessUnit": {
"Code": "sample string 1",
"Description": "sample string 2",
"Id": 3
},
"Address": "sample string 1",
"Cap": "sample string 2",
"City": "sample string 3",
"Country": "sample string 4",
"TelephoneNumber": "sample string 5",
"Fax": "sample string 6",
"WebSite": "sample string 7",
"Email": "sample string 8",
"Code": "sample string 9",
"Description": "sample string 10",
"IsActive": true,
"Permissions": {
"CanModify": true,
"CanDelete": true
},
"CreationDate": "2024-11-01T19:27:59.0819913+01:00",
"CreatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"LastUpdateDate": "2024-11-01T19:27:59.0819913+01:00",
"LastUpdatedBy": {
"Login": "sample string 1",
"FullName": "sample string 2",
"Avatar": "sample string 3",
"Id": 4
},
"Id": 12
}
]
application/xml, text/xml
Sample:
<ArrayOfCustomerDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
<CustomerDto>
<Id>12</Id>
<CreatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</CreatedBy>
<CreationDate>2024-11-01T19:27:59.0819913+01:00</CreationDate>
<LastUpdateDate>2024-11-01T19:27:59.0819913+01:00</LastUpdateDate>
<LastUpdatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</LastUpdatedBy>
<Code>sample string 9</Code>
<Description>sample string 10</Description>
<IsActive>true</IsActive>
<Permissions>
<CanDelete>true</CanDelete>
<CanModify>true</CanModify>
</Permissions>
<Address>sample string 1</Address>
<BusinessUnit>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</BusinessUnit>
<Cap>sample string 2</Cap>
<City>sample string 3</City>
<Country>sample string 4</Country>
<Email>sample string 8</Email>
<Fax>sample string 6</Fax>
<TelephoneNumber>sample string 5</TelephoneNumber>
<WebSite>sample string 7</WebSite>
</CustomerDto>
<CustomerDto>
<Id>12</Id>
<CreatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</CreatedBy>
<CreationDate>2024-11-01T19:27:59.0819913+01:00</CreationDate>
<LastUpdateDate>2024-11-01T19:27:59.0819913+01:00</LastUpdateDate>
<LastUpdatedBy>
<Id>4</Id>
<Avatar>sample string 3</Avatar>
<FullName>sample string 2</FullName>
<Login>sample string 1</Login>
</LastUpdatedBy>
<Code>sample string 9</Code>
<Description>sample string 10</Description>
<IsActive>true</IsActive>
<Permissions>
<CanDelete>true</CanDelete>
<CanModify>true</CanModify>
</Permissions>
<Address>sample string 1</Address>
<BusinessUnit>
<Id>3</Id>
<Code>sample string 1</Code>
<Description>sample string 2</Description>
</BusinessUnit>
<Cap>sample string 2</Cap>
<City>sample string 3</City>
<Country>sample string 4</Country>
<Email>sample string 8</Email>
<Fax>sample string 6</Fax>
<TelephoneNumber>sample string 5</TelephoneNumber>
<WebSite>sample string 7</WebSite>
</CustomerDto>
</ArrayOfCustomerDto>