GetAllFacilities
Overview
Returns a list of FacilityViewModels that the API token has rights to view.
Request Information
Method
GET - api/Facility/GetAllFacilities
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
JSON
\\\\[ { "FacilityId": "37369c4f-0a46-4746-8998-ff77a5e401c1", "Name": "sample string 2", "ACSystemId": "e78caaa0-3e2c-4ae4-afa3-afd20b2a4716", "ACSystemName": "sample string 4", "Deleted": true, "TimeZoneInfoId": "sample string 6", "StreetAddress1": "sample string 7", "StreetAddress2": "sample string 8", "City": "sample string 9", "sRegionId": "72784b99-34d5-43b6-8888-4f007b351b38", "RegionName": "sample string 11", "sCountryId": "80e5685b-25a1-47cc-aa7c-d22770142861", "CountryName": "sample string 13", "PostalCode": "sample string 14", "Website": "sample string 15" }, { "FacilityId": "37369c4f-0a46-4746-8998-ff77a5e401c1", "Name": "sample string 2", "ACSystemId": "e78caaa0-3e2c-4ae4-afa3-afd20b2a4716", "ACSystemName": "sample string 4", "Deleted": true, "TimeZoneInfoId": "sample string 6", "StreetAddress1": "sample string 7", "StreetAddress2": "sample string 8", "City": "sample string 9", "sRegionId": "72784b99-34d5-43b6-8888-4f007b351b38", "RegionName": "sample string 11", "sCountryId": "80e5685b-25a1-47cc-aa7c-d22770142861", "CountryName": "sample string 13", "PostalCode": "sample string 14", "Website": "sample string 15" } ]
XML
<ArrayOfFacilityViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
<FacilityViewModel>
<ACSystemId>e78caaa0-3e2c-4ae4-afa3-afd20b2a4716</ACSystemId>
<ACSystemName>sample string 4</ACSystemName>
<City>sample string 9</City>
<CountryName>sample string 13</CountryName>
<Deleted>true</Deleted>
<FacilityId>37369c4f-0a46-4746-8998-ff77a5e401c1</FacilityId>
`<Name>`sample string 2</Name>
<PostalCode>sample string 14</PostalCode>
<RegionName>sample string 11</RegionName>
<StreetAddress1>sample string 7</StreetAddress1>
<StreetAddress2>sample string 8</StreetAddress2>
<TimeZoneInfoId>sample string 6</TimeZoneInfoId>
<Website>sample string 15</Website>
<sCountryId>80e5685b-25a1-47cc-aa7c-d22770142861</sCountryId>
<sRegionId>72784b99-34d5-43b6-8888-4f007b351b38</sRegionId>
</FacilityViewModel>
<FacilityViewModel>
<ACSystemId>e78caaa0-3e2c-4ae4-afa3-afd20b2a4716</ACSystemId>
<ACSystemName>sample string 4</ACSystemName>
<City>sample string 9</City>
<CountryName>sample string 13</CountryName>
<Deleted>true</Deleted>
<FacilityId>37369c4f-0a46-4746-8998-ff77a5e401c1</FacilityId>
`<Name>`sample string 2</Name>
<PostalCode>sample string 14</PostalCode>
<RegionName>sample string 11</RegionName>
<StreetAddress1>sample string 7</StreetAddress1>
<StreetAddress2>sample string 8</StreetAddress2>
<TimeZoneInfoId>sample string 6</TimeZoneInfoId>
<Website>sample string 15</Website>
<sCountryId>80e5685b-25a1-47cc-aa7c-d22770142861</sCountryId>
<sRegionId>72784b99-34d5-43b6-8888-4f007b351b38</sRegionId>
</FacilityViewModel>
</ArrayOfFacilityViewModel>