GET api/v1/zones?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
ZoneQueryDto| Name | Description | Type | Additional information |
|---|---|---|---|
| OrganizationCode | string |
None. |
|
| PlaceCode | string |
None. |
|
| SearchText | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"organizationCode": "sample string 1",
"placeCode": "sample string 2",
"searchText": "sample string 3"
}
application/xml, text/xml
Sample:
<ZoneQueryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Application.Services.Dtos.Query"> <OrganizationCode>sample string 1</OrganizationCode> <PlaceCode>sample string 2</PlaceCode> <SearchText>sample string 3</SearchText> </ZoneQueryDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
MultiResultResponseOfZoneDto| 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": [
{
"name": "sample string 1",
"code": "sample string 2",
"zoneGroupCode": "sample string 3",
"placeId": "f3defcd2-a774-4ea8-87c1-329e66965e05",
"placeCode": "sample string 5",
"isIo": true,
"zoneIntervalDtos": [
{
"startYear": 1,
"startMonth": 1,
"startDay": 1,
"startHour": 1,
"startMinute": 2,
"endYear": 1,
"endMonth": 1,
"endDay": 1,
"endHour": 3,
"endMinute": 4,
"mode": 0,
"zoneCode": "sample string 5",
"id": "0ac54ada-6036-42c0-b91a-4fa8d3b9e419",
"creationDate": "2026-03-23T09:13:33.8912638+00:00",
"modificationDate": "2026-03-23T09:13:33.8912638+00:00"
},
{
"startYear": 1,
"startMonth": 1,
"startDay": 1,
"startHour": 1,
"startMinute": 2,
"endYear": 1,
"endMonth": 1,
"endDay": 1,
"endHour": 3,
"endMinute": 4,
"mode": 0,
"zoneCode": "sample string 5",
"id": "0ac54ada-6036-42c0-b91a-4fa8d3b9e419",
"creationDate": "2026-03-23T09:13:33.8912638+00:00",
"modificationDate": "2026-03-23T09:13:33.8912638+00:00"
}
],
"id": "018c7672-e7bd-4a49-aecd-36d2d4d110f7",
"creationDate": "2026-03-23T09:13:33.8912638+00:00",
"modificationDate": "2026-03-23T09:13:33.8912638+00:00"
},
{
"name": "sample string 1",
"code": "sample string 2",
"zoneGroupCode": "sample string 3",
"placeId": "f3defcd2-a774-4ea8-87c1-329e66965e05",
"placeCode": "sample string 5",
"isIo": true,
"zoneIntervalDtos": [
{
"startYear": 1,
"startMonth": 1,
"startDay": 1,
"startHour": 1,
"startMinute": 2,
"endYear": 1,
"endMonth": 1,
"endDay": 1,
"endHour": 3,
"endMinute": 4,
"mode": 0,
"zoneCode": "sample string 5",
"id": "0ac54ada-6036-42c0-b91a-4fa8d3b9e419",
"creationDate": "2026-03-23T09:13:33.8912638+00:00",
"modificationDate": "2026-03-23T09:13:33.8912638+00:00"
},
{
"startYear": 1,
"startMonth": 1,
"startDay": 1,
"startHour": 1,
"startMinute": 2,
"endYear": 1,
"endMonth": 1,
"endDay": 1,
"endHour": 3,
"endMinute": 4,
"mode": 0,
"zoneCode": "sample string 5",
"id": "0ac54ada-6036-42c0-b91a-4fa8d3b9e419",
"creationDate": "2026-03-23T09:13:33.8912638+00:00",
"modificationDate": "2026-03-23T09:13:33.8912638+00:00"
}
],
"id": "018c7672-e7bd-4a49-aecd-36d2d4d110f7",
"creationDate": "2026-03-23T09:13:33.8912638+00:00",
"modificationDate": "2026-03-23T09:13:33.8912638+00:00"
}
]
}
application/xml, text/xml
Sample:
<MultiResultResponseOfZoneDtoq6QXgA_SU 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.Location">
<d2p1:ZoneDto>
<CreationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</CreationDate>
<Id xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">018c7672-e7bd-4a49-aecd-36d2d4d110f7</Id>
<ModificationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</ModificationDate>
<d2p1:Code>sample string 2</d2p1:Code>
<d2p1:IsIo>true</d2p1:IsIo>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:PlaceCode>sample string 5</d2p1:PlaceCode>
<d2p1:PlaceId>f3defcd2-a774-4ea8-87c1-329e66965e05</d2p1:PlaceId>
<d2p1:ZoneGroupCode>sample string 3</d2p1:ZoneGroupCode>
<d2p1:ZoneIntervalDtos>
<d2p1:ZoneIntervalDto>
<CreationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</CreationDate>
<Id xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">0ac54ada-6036-42c0-b91a-4fa8d3b9e419</Id>
<ModificationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</ModificationDate>
<d2p1:EndDay>1</d2p1:EndDay>
<d2p1:EndHour>3</d2p1:EndHour>
<d2p1:EndMinute>4</d2p1:EndMinute>
<d2p1:EndMonth>1</d2p1:EndMonth>
<d2p1:EndYear>1</d2p1:EndYear>
<d2p1:Mode>Never</d2p1:Mode>
<d2p1:StartDay>1</d2p1:StartDay>
<d2p1:StartHour>1</d2p1:StartHour>
<d2p1:StartMinute>2</d2p1:StartMinute>
<d2p1:StartMonth>1</d2p1:StartMonth>
<d2p1:StartYear>1</d2p1:StartYear>
<d2p1:ZoneCode>sample string 5</d2p1:ZoneCode>
</d2p1:ZoneIntervalDto>
<d2p1:ZoneIntervalDto>
<CreationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</CreationDate>
<Id xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">0ac54ada-6036-42c0-b91a-4fa8d3b9e419</Id>
<ModificationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</ModificationDate>
<d2p1:EndDay>1</d2p1:EndDay>
<d2p1:EndHour>3</d2p1:EndHour>
<d2p1:EndMinute>4</d2p1:EndMinute>
<d2p1:EndMonth>1</d2p1:EndMonth>
<d2p1:EndYear>1</d2p1:EndYear>
<d2p1:Mode>Never</d2p1:Mode>
<d2p1:StartDay>1</d2p1:StartDay>
<d2p1:StartHour>1</d2p1:StartHour>
<d2p1:StartMinute>2</d2p1:StartMinute>
<d2p1:StartMonth>1</d2p1:StartMonth>
<d2p1:StartYear>1</d2p1:StartYear>
<d2p1:ZoneCode>sample string 5</d2p1:ZoneCode>
</d2p1:ZoneIntervalDto>
</d2p1:ZoneIntervalDtos>
</d2p1:ZoneDto>
<d2p1:ZoneDto>
<CreationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</CreationDate>
<Id xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">018c7672-e7bd-4a49-aecd-36d2d4d110f7</Id>
<ModificationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</ModificationDate>
<d2p1:Code>sample string 2</d2p1:Code>
<d2p1:IsIo>true</d2p1:IsIo>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:PlaceCode>sample string 5</d2p1:PlaceCode>
<d2p1:PlaceId>f3defcd2-a774-4ea8-87c1-329e66965e05</d2p1:PlaceId>
<d2p1:ZoneGroupCode>sample string 3</d2p1:ZoneGroupCode>
<d2p1:ZoneIntervalDtos>
<d2p1:ZoneIntervalDto>
<CreationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</CreationDate>
<Id xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">0ac54ada-6036-42c0-b91a-4fa8d3b9e419</Id>
<ModificationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</ModificationDate>
<d2p1:EndDay>1</d2p1:EndDay>
<d2p1:EndHour>3</d2p1:EndHour>
<d2p1:EndMinute>4</d2p1:EndMinute>
<d2p1:EndMonth>1</d2p1:EndMonth>
<d2p1:EndYear>1</d2p1:EndYear>
<d2p1:Mode>Never</d2p1:Mode>
<d2p1:StartDay>1</d2p1:StartDay>
<d2p1:StartHour>1</d2p1:StartHour>
<d2p1:StartMinute>2</d2p1:StartMinute>
<d2p1:StartMonth>1</d2p1:StartMonth>
<d2p1:StartYear>1</d2p1:StartYear>
<d2p1:ZoneCode>sample string 5</d2p1:ZoneCode>
</d2p1:ZoneIntervalDto>
<d2p1:ZoneIntervalDto>
<CreationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</CreationDate>
<Id xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">0ac54ada-6036-42c0-b91a-4fa8d3b9e419</Id>
<ModificationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-23T09:13:33.8912638+00:00</ModificationDate>
<d2p1:EndDay>1</d2p1:EndDay>
<d2p1:EndHour>3</d2p1:EndHour>
<d2p1:EndMinute>4</d2p1:EndMinute>
<d2p1:EndMonth>1</d2p1:EndMonth>
<d2p1:EndYear>1</d2p1:EndYear>
<d2p1:Mode>Never</d2p1:Mode>
<d2p1:StartDay>1</d2p1:StartDay>
<d2p1:StartHour>1</d2p1:StartHour>
<d2p1:StartMinute>2</d2p1:StartMinute>
<d2p1:StartMonth>1</d2p1:StartMonth>
<d2p1:StartYear>1</d2p1:StartYear>
<d2p1:ZoneCode>sample string 5</d2p1:ZoneCode>
</d2p1:ZoneIntervalDto>
</d2p1:ZoneIntervalDtos>
</d2p1:ZoneDto>
</Results>
</MultiResultResponseOfZoneDtoq6QXgA_SU>