GET api/locations/search?addEmptyItem={addEmptyItem}&emptyItemText={emptyItemText}

Returns a list of locations

Request Information

URI Parameters

NameDescriptionTypeAdditional information
addEmptyItem

Indicates if an empty item be added in the list.

boolean

Default value is False

emptyItemText

Text of the empty item

string

Default value is

Body Parameters

None.

Response Information

Resource Description

ListModelOfLocationModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.

ItemsPerPage

integer

None.

CurrentPage

integer

None.

TotalPages

integer

None.

FirstRowOnPage

integer

None.

LastRowOnPage

integer

None.

Rows

Collection of LocationModel

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalItems": 1,
  "ItemsPerPage": 2,
  "CurrentPage": 3,
  "TotalPages": 4,
  "FirstRowOnPage": 5,
  "LastRowOnPage": 6,
  "Rows": [
    {
      "Id": "ff459030-7551-4e6d-abc9-0169d3c300fe",
      "Name": "sample string 2",
      "Active": true
    },
    {
      "Id": "ff459030-7551-4e6d-abc9-0169d3c300fe",
      "Name": "sample string 2",
      "Active": true
    }
  ]
}

application/xml, text/xml

Sample:
<ListModelOfLocationModelMwpvvY5y xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Locations">
    <d2p1:LocationModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Id>ff459030-7551-4e6d-abc9-0169d3c300fe</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:LocationModel>
    <d2p1:LocationModel>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Id>ff459030-7551-4e6d-abc9-0169d3c300fe</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:LocationModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfLocationModelMwpvvY5y>