GET api/v1/Facilities
Returns a list of FacilityViewModels that the API token has rights to view
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of FacilityViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| FacilityId |
Represents the PK of an existing Facility in BluSKY |
globally unique identifier |
None. |
| Name |
Represents the name of an existing Facility in BluSKY |
string |
None. |
| ACSystemId |
Represents the PK of the Access Control System for the Facility |
globally unique identifier |
None. |
| ACSystemName |
Represents the name of the Access Control System for the Facility |
string |
None. |
| Deleted |
Represents whether the Facility is deleted or not. |
boolean |
None. |
| TimeZoneInfoId |
Represents the TimeZone of the Facility |
string |
None. |
| StreetAddress1 |
Represents the primary street address of the Facility |
string |
None. |
| StreetAddress2 |
Represents the secondary street address of the Facility |
string |
None. |
| City |
Represents the city of the Facility |
string |
None. |
| sRegionId |
Represents the PK of the region (State, Province, County, etc) of the Facility |
globally unique identifier |
None. |
| RegionName |
Represents the name of the region (State, Province, County, etc) of the Facility |
string |
None. |
| sCountryId |
Represents the PK of the country of the Facility |
globally unique identifier |
None. |
| CountryName |
Represents the name of the country of the Facility |
string |
None. |
| PostalCode |
Represents the Postal Code/Zip Code of the Facility |
string |
None. |
| Website |
Represents the URL of the website associated with the Facility |
string |
None. |
Response Formats
application/json, text/json
[
{
"FacilityId": "2d68ab02-a168-4ac5-9654-fa7f1745db07",
"Name": "sample string 2",
"ACSystemId": "be7c3805-9d03-47fd-ba4c-705e57287ad3",
"ACSystemName": "sample string 3",
"Deleted": true,
"TimeZoneInfoId": "sample string 5",
"StreetAddress1": "sample string 6",
"StreetAddress2": "sample string 7",
"City": "sample string 8",
"sRegionId": "b5a34354-f3f6-49b9-854a-1cafb56308d2",
"RegionName": "sample string 10",
"sCountryId": "419e641c-7e3e-41d9-9e2b-98ae1cad7f1d",
"CountryName": "sample string 12",
"PostalCode": "sample string 13",
"Website": "sample string 14"
},
{
"FacilityId": "2d68ab02-a168-4ac5-9654-fa7f1745db07",
"Name": "sample string 2",
"ACSystemId": "be7c3805-9d03-47fd-ba4c-705e57287ad3",
"ACSystemName": "sample string 3",
"Deleted": true,
"TimeZoneInfoId": "sample string 5",
"StreetAddress1": "sample string 6",
"StreetAddress2": "sample string 7",
"City": "sample string 8",
"sRegionId": "b5a34354-f3f6-49b9-854a-1cafb56308d2",
"RegionName": "sample string 10",
"sCountryId": "419e641c-7e3e-41d9-9e2b-98ae1cad7f1d",
"CountryName": "sample string 12",
"PostalCode": "sample string 13",
"Website": "sample string 14"
}
]
application/xml, text/xml
<ArrayOfFacilityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers">
<FacilityViewModel>
<ACSystemId>be7c3805-9d03-47fd-ba4c-705e57287ad3</ACSystemId>
<ACSystemName>sample string 3</ACSystemName>
<City>sample string 8</City>
<CountryName>sample string 12</CountryName>
<Deleted>true</Deleted>
<FacilityId>2d68ab02-a168-4ac5-9654-fa7f1745db07</FacilityId>
<Name>sample string 2</Name>
<PostalCode>sample string 13</PostalCode>
<RegionName>sample string 10</RegionName>
<StreetAddress1>sample string 6</StreetAddress1>
<StreetAddress2>sample string 7</StreetAddress2>
<TimeZoneInfoId>sample string 5</TimeZoneInfoId>
<Website>sample string 14</Website>
<sCountryId>419e641c-7e3e-41d9-9e2b-98ae1cad7f1d</sCountryId>
<sRegionId>b5a34354-f3f6-49b9-854a-1cafb56308d2</sRegionId>
</FacilityViewModel>
<FacilityViewModel>
<ACSystemId>be7c3805-9d03-47fd-ba4c-705e57287ad3</ACSystemId>
<ACSystemName>sample string 3</ACSystemName>
<City>sample string 8</City>
<CountryName>sample string 12</CountryName>
<Deleted>true</Deleted>
<FacilityId>2d68ab02-a168-4ac5-9654-fa7f1745db07</FacilityId>
<Name>sample string 2</Name>
<PostalCode>sample string 13</PostalCode>
<RegionName>sample string 10</RegionName>
<StreetAddress1>sample string 6</StreetAddress1>
<StreetAddress2>sample string 7</StreetAddress2>
<TimeZoneInfoId>sample string 5</TimeZoneInfoId>
<Website>sample string 14</Website>
<sCountryId>419e641c-7e3e-41d9-9e2b-98ae1cad7f1d</sCountryId>
<sRegionId>b5a34354-f3f6-49b9-854a-1cafb56308d2</sRegionId>
</FacilityViewModel>
</ArrayOfFacilityViewModel>