GET api/v1/customerareas?Limit={Limit}&Offset={Offset}&OrderBy={OrderBy}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Limit | integer |
None. |
|
| Offset | integer |
None. |
|
| OrderBy | string |
None. |
Body Parameters
None.
Response Information
Resource Description
MultiResultResponseOfCustomerAreaDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Meta | MetaMultiResult |
None. |
|
| Notifications |
None. |
Response Formats
application/json, text/json
Sample:
{
"meta": {
"limit": 1,
"offset": 2,
"totalResults": 3
},
"notifications": [
{},
{}
],
"results": [
{
"id": "71a5cb37-ca2a-4fd0-a9d0-c9249a77b6d1",
"zipCode": "sample string 1",
"city": "sample string 2",
"region": "sample string 3",
"country": "sample string 4",
"latitude": "sample string 5",
"longitude": "sample string 6",
"canDelete": true
},
{
"id": "71a5cb37-ca2a-4fd0-a9d0-c9249a77b6d1",
"zipCode": "sample string 1",
"city": "sample string 2",
"region": "sample string 3",
"country": "sample string 4",
"latitude": "sample string 5",
"longitude": "sample string 6",
"canDelete": true
}
]
}
application/xml, text/xml
Sample:
<MultiResultResponseOfCustomerAreaDtoaM_S85dVU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
<Meta>
<Limit>1</Limit>
<Offset>2</Offset>
<TotalResults>3</TotalResults>
</Meta>
<Notifications>
<Notification />
<Notification />
</Notifications>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Domain.Dtos">
<d2p1:CustomerAreaDto>
<d2p1:CanDelete>true</d2p1:CanDelete>
<d2p1:City>sample string 2</d2p1:City>
<d2p1:Country>sample string 4</d2p1:Country>
<d2p1:Id>71a5cb37-ca2a-4fd0-a9d0-c9249a77b6d1</d2p1:Id>
<d2p1:Latitude>sample string 5</d2p1:Latitude>
<d2p1:Longitude>sample string 6</d2p1:Longitude>
<d2p1:Region>sample string 3</d2p1:Region>
<d2p1:ZipCode>sample string 1</d2p1:ZipCode>
</d2p1:CustomerAreaDto>
<d2p1:CustomerAreaDto>
<d2p1:CanDelete>true</d2p1:CanDelete>
<d2p1:City>sample string 2</d2p1:City>
<d2p1:Country>sample string 4</d2p1:Country>
<d2p1:Id>71a5cb37-ca2a-4fd0-a9d0-c9249a77b6d1</d2p1:Id>
<d2p1:Latitude>sample string 5</d2p1:Latitude>
<d2p1:Longitude>sample string 6</d2p1:Longitude>
<d2p1:Region>sample string 3</d2p1:Region>
<d2p1:ZipCode>sample string 1</d2p1:ZipCode>
</d2p1:CustomerAreaDto>
</Results>
</MultiResultResponseOfCustomerAreaDtoaM_S85dVU>