GET api/v1/places?Limit={Limit}&Offset={Offset}&OrderBy={OrderBy}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Limit

integer

None.

Offset

integer

None.

OrderBy

string

None.

Body Parameters

PlaceQueryDto
NameDescriptionTypeAdditional information
OrganizationCode

string

None.

SearchText

string

None.

Request Formats

application/json, text/json

Sample:
{
  "organizationCode": "sample string 1",
  "searchText": "sample string 2"
}

application/xml, text/xml

Sample:
<PlaceQueryDto 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>
  <SearchText>sample string 2</SearchText>
</PlaceQueryDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MultiResultResponseOfPlaceDto
NameDescriptionTypeAdditional 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",
      "timeActiveEcho": 3,
      "timeActiveItinerary": 4,
      "timeActiveVisit": 5,
      "organizationId": "41c0482b-fc54-4973-a8d2-0b3d54a77975",
      "organizationCode": "sample string 7",
      "id": "7ff7073c-d54c-4021-be7a-e93d8addbb23",
      "creationDate": "2026-03-21T21:45:26.9201736+00:00",
      "modificationDate": "2026-03-21T21:45:26.9201736+00:00"
    },
    {
      "name": "sample string 1",
      "code": "sample string 2",
      "timeActiveEcho": 3,
      "timeActiveItinerary": 4,
      "timeActiveVisit": 5,
      "organizationId": "41c0482b-fc54-4973-a8d2-0b3d54a77975",
      "organizationCode": "sample string 7",
      "id": "7ff7073c-d54c-4021-be7a-e93d8addbb23",
      "creationDate": "2026-03-21T21:45:26.9201736+00:00",
      "modificationDate": "2026-03-21T21:45:26.9201736+00:00"
    }
  ]
}

application/xml, text/xml

Sample:
<MultiResultResponseOfPlaceDtoq6QXgA_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:PlaceDto>
      <CreationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-21T21:45:26.9201736+00:00</CreationDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">7ff7073c-d54c-4021-be7a-e93d8addbb23</Id>
      <ModificationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-21T21:45:26.9201736+00:00</ModificationDate>
      <d2p1:Code>sample string 2</d2p1:Code>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:OrganizationCode>sample string 7</d2p1:OrganizationCode>
      <d2p1:OrganizationId>41c0482b-fc54-4973-a8d2-0b3d54a77975</d2p1:OrganizationId>
      <d2p1:TimeActiveEcho>3</d2p1:TimeActiveEcho>
      <d2p1:TimeActiveItinerary>4</d2p1:TimeActiveItinerary>
      <d2p1:TimeActiveVisit>5</d2p1:TimeActiveVisit>
    </d2p1:PlaceDto>
    <d2p1:PlaceDto>
      <CreationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-21T21:45:26.9201736+00:00</CreationDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">7ff7073c-d54c-4021-be7a-e93d8addbb23</Id>
      <ModificationDate xmlns="http://schemas.datacontract.org/2004/07/Domain.Objects">2026-03-21T21:45:26.9201736+00:00</ModificationDate>
      <d2p1:Code>sample string 2</d2p1:Code>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:OrganizationCode>sample string 7</d2p1:OrganizationCode>
      <d2p1:OrganizationId>41c0482b-fc54-4973-a8d2-0b3d54a77975</d2p1:OrganizationId>
      <d2p1:TimeActiveEcho>3</d2p1:TimeActiveEcho>
      <d2p1:TimeActiveItinerary>4</d2p1:TimeActiveItinerary>
      <d2p1:TimeActiveVisit>5</d2p1:TimeActiveVisit>
    </d2p1:PlaceDto>
  </Results>
</MultiResultResponseOfPlaceDtoq6QXgA_SU>