GET api/Location?onlyActive={onlyActive}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| onlyActive | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of Location| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationID | integer |
None. |
|
| LocationName | string |
None. |
|
| OrganizationID | integer |
None. |
|
| TimeZoneID | integer |
None. |
|
| TimeZoneName | string |
None. |
|
| LocationDatabaseName | string |
None. |
|
| ServerID | integer |
None. |
|
| ServerHostname | string |
None. |
|
| Enabled | integer |
None. |
|
| DateCreated | date |
None. |
|
| enabled | boolean |
None. |
|
| id | integer |
None. |
|
| name | string |
None. |
|
| displayName | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"LocationID": 1,
"LocationName": "sample string 2",
"OrganizationID": 3,
"TimeZoneID": 4,
"TimeZoneName": "sample string 5",
"LocationDatabaseName": "sample string 6",
"ServerID": 7,
"ServerHostname": "sample string 8",
"Enabled": 9,
"DateCreated": "2025-12-10T11:56:05.7940134+00:00",
"enabled": true,
"id": 12,
"name": "sample string 13",
"displayName": "sample string 14"
},
{
"LocationID": 1,
"LocationName": "sample string 2",
"OrganizationID": 3,
"TimeZoneID": 4,
"TimeZoneName": "sample string 5",
"LocationDatabaseName": "sample string 6",
"ServerID": 7,
"ServerHostname": "sample string 8",
"Enabled": 9,
"DateCreated": "2025-12-10T11:56:05.7940134+00:00",
"enabled": true,
"id": 12,
"name": "sample string 13",
"displayName": "sample string 14"
}
]
application/xml, text/xml
Sample:
<ArrayOfLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models.BackOffice">
<Location>
<displayName xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">sample string 14</displayName>
<enabled xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">true</enabled>
<id xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">12</id>
<name xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">sample string 13</name>
<DateCreated>2025-12-10T11:56:05.7940134+00:00</DateCreated>
<Enabled>9</Enabled>
<LocationDatabaseName>sample string 6</LocationDatabaseName>
<LocationID>1</LocationID>
<LocationName>sample string 2</LocationName>
<OrganizationID>3</OrganizationID>
<ServerHostname>sample string 8</ServerHostname>
<ServerID>7</ServerID>
<TimeZoneID>4</TimeZoneID>
<TimeZoneName>sample string 5</TimeZoneName>
</Location>
<Location>
<displayName xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">sample string 14</displayName>
<enabled xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">true</enabled>
<id xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">12</id>
<name xmlns="http://schemas.datacontract.org/2004/07/libMIMO.models">sample string 13</name>
<DateCreated>2025-12-10T11:56:05.7940134+00:00</DateCreated>
<Enabled>9</Enabled>
<LocationDatabaseName>sample string 6</LocationDatabaseName>
<LocationID>1</LocationID>
<LocationName>sample string 2</LocationName>
<OrganizationID>3</OrganizationID>
<ServerHostname>sample string 8</ServerHostname>
<ServerID>7</ServerID>
<TimeZoneID>4</TimeZoneID>
<TimeZoneName>sample string 5</TimeZoneName>
</Location>
</ArrayOfLocation>